Use the CLI for a terminal TUI, a local Canvas, or local Docs. Each server command starts only its own surface. The public landing website is not a CLI mode.

Usage

Textbook Dark: Default deep charcoal aesthetic with neon accents.
Tokyo Night: Atmospheric indigo, violet, and cyan palette.
Catppuccin: Soothing pastel Mocha color scheme.
Dracula: High-contrast vampire purple and vibrant pinks.
Matrix: Classic phosphor green monochrome on pure black.
Clean Light: Crisp black ink on high-contrast paper white.

bunx textbook                 # terminal TUI
bunx textbook web --open      # local Canvas, port 8008
bunx textbook docs --open     # local Docs, port 8001
bunx textbook --help          # command reference
bunx textbook --man           # bundled manual
bunx textbook --version

web and --web are equivalent, as are docs and --docs. Keep server processes running while using their pages.

Options

Option	Description	Default
`-w, --web`	Start the local Canvas server	Port `8008`
`--docs`	Independent documentation server	`8001`
`-P, --port <number>`	Override selected server port	Canvas 8008; Docs 8001
`--surface <name>`	Select `docs` or `canvas`	Explicit server selection
`--landing-url / --docs-url / --canvas-url <url>`	Set navigation destinations; does not start another service	Separate local origins
`--help / --man`	Complete command reference / manual	No server
`--host <string>`	Host binding for Web server	`localhost`
`--open`	Open browser automatically	`false`
`-p, --pattern <glob>`	Glob pattern for story files	`*/.stories.ts`
`-c, --cwd <dir>`	Directory to search for stories	`cwd`
`-s, --screen-mode <mode>`	Screen buffer mode	`alternate-screen`
`-h, --help`	Display command help reference	N/A

For example, keep Canvas local while linking it to the public pages:

bunx textbook web --open \
  --landing-url https://textbook.sh/ \
  --docs-url https://docs.textbook.sh/

The default host is local. Binding Canvas to 0.0.0.0 exposes a process that runs your project code to reachable network clients; use it only on a trusted network.

Introduction