Skip to content

Emit bash language token for CLI usage fences#4759

Closed
allister-beamable wants to merge 1 commit into
mainfrom
cli-docgen-bash-fence
Closed

Emit bash language token for CLI usage fences#4759
allister-beamable wants to merge 1 commit into
mainfrom
cli-docgen-bash-fence

Conversation

@allister-beamable

Copy link
Copy Markdown
Contributor

What

DocService.GetUsage (cli/cli/Services/Docs/DocService.cs) wraps each command's usage template in a ```shell fence. This changes it to ```bash.

Why

The docs site standardizes on bash as the single language token for typed shell commands (the hand-written CLI guides were just normalized shell/shbash in beamable/docs). The generated CLI command reference is regenerated from this code, so its ~200-per-branch usage fences can only be standardized here — editing the generated Markdown in the docs repo would be overwritten on the next regen.

shell, sh, and bash all resolve to the same Pygments Bash lexer, so rendering is unchanged; this is a source-consistency fix that lets the whole docs site use one token per language.

Scope

One-line string change; the usage block is a typed command template (beam <command> [options]), so bash is the correct token. No behavior change beyond the emitted token.

🤖 Generated with Claude Code

DocService.GetUsage wraps the command usage template in a ```shell fence.
Pygments (used by the docs site's pymdownx.highlight) treats shell, sh, and
bash as the same Bash lexer, but the docs standardize on bash as the single
token for typed shell commands. Emitting bash keeps the generated CLI command
reference consistent with the hand-written guides.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@allister-beamable

Copy link
Copy Markdown
Contributor Author

Closing — the docs will standardize on shell to match this generator's existing token, rather than changing the generator to bash. No SDK change needed.

@allister-beamable allister-beamable deleted the cli-docgen-bash-fence branch July 14, 2026 18:54
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