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