CLI overview

CLI overview

Find Brief commands and the shared options for configuring their workspace.

Run Brief commands from your project directory. Choose a command below for its subcommands, arguments, and options.

Usage#

brief [options] [command]

Commands#

brief init — Create a Brief project
brief check — Check the Brief workspace for problems
brief redirects — Manage historical URL redirects
brief updates — Manage page update checkpoints
brief tree — Display the documentation structure
brief page — Manage documentation pages
brief group — Manage documentation groups
brief locale — Manage the site's locales
brief tab — Manage documentation sets shown in the tab bar
brief version — Manage versions within a tab
brief skills — Manage Brief authoring skills
brief site — Manage site settings
brief help — display help for command

Global options#

--compiler <file>Default "brief/config/compiler.ts": string; Compiler module, relative to the working directory (env: BRIEF_COMPILER)

-r, --root <dir>Default "brief/case": string; Content folder, relative to the working directory; does not change the compiler path (env: BRIEF_ROOT)

-h, --helpDefault undefined: boolean; Display the concise help for this command