Skip to content

bonsai guide

bonsai guide [topic]

bonsai guide renders a bundled cheatsheet directly in your terminal using Glamour markdown rendering. The cheatsheets are embedded in the Bonsai binary alongside the catalog and are designed as quick terminal companions to the full Starlight documentation.

Run bonsai guide with no arguments to open an interactive picker. Pass a topic directly (bonsai guide <topic>) to skip the picker and render it immediately. Passing an unknown topic prints an error and exits non-zero. Passing more than one argument is rejected by Cobra with an “accepts at most 1 arg” error.

Each cheatsheet ends with a deep-link back to the full web guide at laststep.github.io/Bonsai for longer-form reading.

TopicWhat it covers
quickstartPost-install 5-step walkthrough — what to do after bonsai init
conceptsThe mental model — station, instruction stack, agents, sensors, routines, scaffolding
cliOne section per command (init, add, remove, list, catalog, update, guide)
custom-filesBONSAI frontmatter format, file naming, directory placement, examples

This command has no flags.

Open the interactive picker:

Terminal window
bonsai guide
# ? Pick a guide
# > Quickstart — 5-step post-install walkthrough
# Concepts — the mental model
# CLI — command-by-command reference
# Custom Files — add your own abilities

Use the arrow keys and press Enter to render the selected topic.

Render a topic directly:

Terminal window
bonsai guide quickstart
bonsai guide concepts
bonsai guide cli
bonsai guide custom-files

Unknown topic:

Terminal window
bonsai guide foobar
# Error: unknown topic "foobar". Available: quickstart, concepts, cli, custom-files

Exits non-zero.

Pipe to a pager for long output:

Terminal window
bonsai guide custom-files | less -R

The -R flag preserves ANSI color codes when piping through less.