docs(readme): expand Commands into a full command-surface table - #270
Conversation
Replace the eight-row group summary with every command and subcommand and a one-line description each, generated from `hotdata --help`.
![claude[bot]](https://avatars.githubusercontent.com/in/1236702?s=60&v=4){kind=small}
| | `databases context push` | Upload `./<NAME>.md` as named context | | ||
| | `databases query` | Execute a SQL query against a database | | ||
| | `databases query status` | Check a running query and retrieve results | | ||
| | `databases queries list` | List query runs | |
There was a problem hiding this comment.
super nit: (not blocking) The table lists positional shortcuts for other groups (query "<sql>", jobs <id>, search "<text>" --index <name>), but a few databases positionals are missing, so "the full command surface" is slightly overstated:
databases queries <id>— show one query run (DatabasesCommands::Queries { id: Option<String>, .. }, src/commands/databases.rs:230); this is a distinct capability not covered byqueries list.databases results <result-id>(src/commands/databases.rs:247) anddatabases <name-or-id>(src/cli.rs:31), both shorthands for theshow/getrows already listed.
Adding the queries <id> row is the one that adds real information.
| ## Commands | ||
|
|
||
| Run `hotdata <command> --help` for full flags on any command. | ||
| The full command surface. The top level has eight groups — `auth`, `workspaces`, `databases`, `query`, `jobs`, `ingest`, `search`, and `manage`. Run `hotdata <command> --help` for full flags on any command. |
There was a problem hiding this comment.
super nit: (not blocking) Prose elsewhere in the README hard-wraps at ~80 columns (see lines 15-17, 110-112, 84-87); this paragraph is one ~200-char line. Wrapping it keeps the diff style consistent.
| The full command surface. The top level has eight groups — `auth`, `workspaces`, `databases`, `query`, `jobs`, `ingest`, `search`, and `manage`. Run `hotdata <command> --help` for full flags on any command. | |
| The full command surface. The top level has eight groups — `auth`, | |
| `workspaces`, `databases`, `query`, `jobs`, `ingest`, `search`, and `manage`. | |
| Run `hotdata <command> --help` for full flags on any command. |
There was a problem hiding this comment.
Verified every row against the clap command tree in src/cli.rs and src/commands/*: names, renames (databases use/remove, tables remove, results get, ingest pause/logs/remove, sources test/add/update-config/remove, embeddings show/add/remove), and the eight top-level groups all match. Two super nits inline, neither blocking.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
1 participant
Replaces the eight-row group summary in the README's
## Commandssection with a full surface-area table — every command and subcommand with a one-line description, generated fromhotdata --help(v0.26.0). Mirrors the full command reference now on the website's CLI reference page.