From 2466e233083f730154989a97bcd9d4eed9e5d551 Mon Sep 17 00:00:00 2001 From: jackylee Date: Wed, 26 Aug 2026 08:45:16 +0800 Subject: [PATCH] docs(vx): state which inspection commands support --json 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 --- docs/getting-started/query.md | 3 ++- vortex-tui/README.md | 2 ++ 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/getting-started/query.md b/docs/getting-started/query.md index 5ff33e49d20..234a270d221 100644 --- a/docs/getting-started/query.md +++ b/docs/getting-started/query.md @@ -51,7 +51,8 @@ vx segments yellow_tripdata_2024-01.vortex vx inspect yellow_tripdata_2024-01.vortex ``` -All inspection commands support `--json` for machine-readable output. +`vx inspect` and `vx tree layout` take `--json` for machine-readable output; `vx segments` always +emits JSON. ## Standalone SQL diff --git a/vortex-tui/README.md b/vortex-tui/README.md index 4a220c63fe8..19f819e3b70 100644 --- a/vortex-tui/README.md +++ b/vortex-tui/README.md @@ -6,6 +6,8 @@ A small, helpful CLI tool for exploring and analyzing Vortex files. * `tree`: Print the encoding tree of a Vortex file * `inspect`: Inspect Vortex file footer and metadata * `convert`: Convert a Parquet file to a Vortex file +* `query`: Run a SQL query against a Vortex file and print JSON +* `segments`: Print the segment layout of a Vortex file as JSON ## Examples