docs: give every hierarchical command a subcommand table in the CLI reference - #11766
Open
AvilaJulio wants to merge 1 commit into
Open
AvilaJulio wants to merge 1 commit into
AvilaJulio wants to merge 1 commit into
Conversation
AvilaJulio
force-pushed
the
docs/cli-command-table
branch
from
September 4, 2026 14:46
1947dfd to
eccb0a1
Compare
AvilaJulio
changed the title
AvilaJulio
force-pushed
the
docs/cli-command-table
branch
from
September 4, 2026 14:54
eccb0a1 to
f00d0e7
Compare
AvilaJulio
changed the title
vasilev-alex
approved these changes
Sep 4, 2026
paveltiunov
approved these changes
Sep 4, 2026
…eference The command table lists one row per top-level command, with each command's subcommands packed into its Description cell — where they were listed at all. A reader scanning the Command column for a command they had not seen before cannot find `enable-branch` there, even though it was added to the `data-model` cell in cube-js#11433. Keep that table as a flat index of top-level commands, and add subcommand tables below it grouped by domain: authentication, deployment, GitHub, data model, dbt, workspace content, users and access control, administration, embedding, and agents/app. Each hierarchical row in the index links to its group, and the narrative sections link into the same tables rather than repeating them. Every subcommand is taken from `cube <command> --help` (CLI 1.7.39), so the tables match what the binary reports, including third-level ones (`notifications recipients`, `integrations tokens`, `embed tenant`, `attributes values`, `scim users`/`groups`) that the page did not mention at all. This also restores `exit-dev-mode` and `file-hashes`, both used by the Git workflow section but missing or unexplained before. The dbt table covers `dbt generate` and the `--manifest` sync option from cube-js#11845 and cube-js#11864, and links to the section that describes them. The `enable-branch` prose gets its own heading so the tables have an anchor to link to. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
AvilaJulio
force-pushed
the
docs/cli-command-table
branch
from
September 15, 2026 14:44
f00d0e7 to
1a5d2c0
Compare
github-actions
Bot
added
the
docs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The command table lists one row per top-level command, with each command's
subcommands packed into its Description cell — where they were listed at all.
A reader scanning the Command column for a command they had not seen
before cannot find
enable-branchin it. That is exactly what happened to aCube SE helping a customer set up branch-per-PR CI: the command has been in
the
data-modelcell since #11433 and the page has been live since #11333,but neither was reachable by scanning.
Expanding the rows in place would flatten each command into several apparent
top-level commands and lose the hierarchy the table exists to show. So this
keeps the table as a flat index and adds subcommand tables below it, grouped
by domain — authentication, deployment, GitHub, data model, dbt, workspace
content, users and access control, administration, embedding, agents/app.
Each hierarchical row links to its group, and the narrative sections
(Data model Git workflow, dbt sync) link into the same tables rather than
repeating them.
Every subcommand comes from
cube <command> --helpon CLI 1.7.39, checkedprogrammatically against all 23 hierarchical commands, so the tables match
what the binary reports. Rebased on master after #11845 and #11864 landed:
the dbt table now lists
dbt generateand the--manifestsync option, andlinks to the section those PRs added. That surfaced a fair amount the page did not mention
at all — the third-level trees (
notifications recipients,integrations tokens,embed tenant,attributes values,scim users/groups), plusexit-dev-modeandfile-hashes, both used bythe Git workflow section but missing or unexplained.
The
enable-branchparagraph gets its own###heading so the tables have ananchor to link to, and so it earns a TOC entry.
Verified against a local
mintlify devrender on the original branch: everycross-reference resolved to a real heading id, no link reference rendered
literally, and the top-level table is unchanged in shape. After the rebase,
all 19 in-page links were re-checked programmatically against the heading
slugs, and
scripts/check_links.pyreports nothing for the page.🤖 Generated with Claude Code