Skip to content

Commit bac8e17

Browse files
committed
docs(CHANGES): Mention jq compatibility for JSON output commands
Add explicit mentions of `jq` piping and automation use cases for all JSON output features (search, ls, debug-info) to improve discoverability.
1 parent e58a553 commit bac8e17

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

CHANGES

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ New `tmuxp search` command for finding workspace files:
5252
- Field-scoped search with prefixes: `name:`, `session:`, `path:`, `window:`, `pane:`
5353
- Matching options: `-i` (ignore-case), `-S` (smart-case), `-F` (fixed-strings), `-w` (word)
5454
- Logic operators: `--any` for OR, `-v` for invert match
55-
- Output formats: human (with match highlighting), `--json`, `--ndjson`
55+
- Output formats: human (with match highlighting), `--json`, `--ndjson` for automation and piping to `jq`
5656
- Searches local (cwd and parents) and global (~/.tmuxp/) workspaces
5757

5858
#### Enhanced ls Command (#1006)
@@ -61,13 +61,13 @@ New output options for `tmuxp ls`:
6161

6262
- `--tree`: Display workspaces grouped by directory
6363
- `--full`: Include complete parsed config content
64-
- `--json` / `--ndjson`: Machine-readable output formats
64+
- `--json` / `--ndjson`: Machine-readable output for automation and piping to `jq`
6565
- Local workspace discovery from current directory and parents
6666
- Source field distinguishes "local" vs "global" workspaces
6767

6868
#### JSON Output for debug-info (#1006)
6969

70-
- `tmuxp debug-info --json`: Structured JSON output for machine parsing
70+
- `tmuxp debug-info --json`: Structured JSON output for automation, issue reporting, and piping to `jq`
7171

7272
### Development
7373

0 commit comments

Comments
 (0)