Skip to content

docs(vx): state which inspection commands support --json - #9638

Open
jackylee-ch wants to merge 1 commit into
vortex-data:developfrom
jackylee-ch:vx-json-docs
Open

docs(vx): state which inspection commands support --json#9638
jackylee-ch wants to merge 1 commit into
vortex-data:developfrom
jackylee-ch:vx-json-docs

Conversation

@jackylee-ch

@jackylee-ch jackylee-ch commented Aug 26, 2026

Copy link
Copy Markdown
Contributor

query.md said all inspection commands support --json. vx segments has no such flag (it always
prints JSON) and vx tree array accepts it then prints a human tree, so a script trusting it breaks
either way. Wiring vx tree array changes CLI output, so that is left for an issue.

Also adds query and segments to the vx README, which listed four of six subcommands.

Tests

make -C docs html succeeds under --fail-on-warning, same warning count as develop.

AI assistance

Written with agentic AI assistance; I read each command's argument struct first.

The sentence claimed all inspection commands take --json. SegmentsArgs has
no such field and exec_segments serializes unconditionally, so vx segments
rejects the flag while always printing JSON; vx tree array declares the flag
and then binds it to _json, printing a human tree and exiting 0. Only
vx inspect and vx tree layout honour it.

Wiring the flag into the other two changes CLI output, so this only corrects
the claim. Also lists query and segments in the vx README, which named four
of the six subcommands.

Signed-off-by: jackylee <qcsd2011@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant