Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: prep v0.7.0 release #94

Merged
merged 1 commit into from
Jun 9, 2024
Merged

chore: prep v0.7.0 release #94

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 12 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,23 +38,28 @@ Clone this repository, build from source with `cd jqp && go build`, then move th

```
➜ jqp --help
jqp is a TUI to explore the jq command line utility
jqp is a terminal user interface (TUI) for exploring the jq command line utility.

You can use it to run jq queries interactively. If no query is provided, the interface will prompt you for one.

The command accepts an optional query argument which will be executed against the input JSON or newline-delimited JSON (NDJSON).
You can provide the input JSON or NDJSON either through a file or via standard input (stdin).

Usage:
jqp [flags]
jqp [query] [flags]

Flags:
--config string config file (default is $HOME/.jqp.yaml)
--config string path to config file (default is $HOME/.jqp.yaml)
-f, --file string path to the input JSON file
-h, --help help for jqp
-t, --theme string jqp theme
-v, --version version for jqp
```

`jqp` also supports input from STDIN. STDIN takes precedence over the command-line flag.
`jqp` also supports input from STDIN. STDIN takes precedence over the command-line flag. Additionally, you can pass an optional query argument to jqp that it will execute upon loading.

```
➜ curl "https://api.github.com/repos/stedolan/jq/issues?per_page=2" | jqp
➜ curl "https://api.github.com/repos/jqlang/jq/issues" | jqp '.[] | {"title": .title, "url": .url}'
```

> [!NOTE]
Expand Down Expand Up @@ -170,7 +175,7 @@ Themes are broken up into [light](#light-themes) and [dark](#dark-themes) themes
- `monokai-light`
- `murphy`
- `onesenterprise`
- `paradaiso-light`
- `paraiso-light`
- `pastie`
- `perldoc`
- `pygments`
Expand All @@ -196,7 +201,7 @@ Themes are broken up into [light](#light-themes) and [dark](#dark-themes) themes
- `gruvbox`
- `monokai`
- `native`
- `paradaiso-dark`
- `paraiso-dark`
- `rrt`
- `solarized-dark`
- `solarized-dark256`
Expand Down
6 changes: 3 additions & 3 deletions cmd/root.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,15 @@ import (
)

var rootCmd = &cobra.Command{
Version: "0.6.0",
Version: "0.7.0",
Use: "jqp [query]",
Short: "jqp is a TUI to explore jq",
Long: `jqp is a terminal user interface (TUI) for exploring the jq command line utility.

You can use it to run jq queries interactively. If no query is provided, the interface will prompt you for one.

The command accepts an optional query argument which will be executed against the input JSON.
You can provide the input JSON either through a file or via standard input (stdin).`,
The command accepts an optional query argument which will be executed against the input JSON or newline-delimited JSON (NDJSON).
You can provide the input JSON or NDJSON either through a file or via standard input (stdin).`,
Args: cobra.MaximumNArgs(1),
SilenceUsage: true,
RunE: func(cmd *cobra.Command, args []string) error {
Expand Down
Loading