CLI

Brief commands and options.

brief#

Next-gen documentation framework.

Usage#

Commands#

Global options#

--compiler <file>

Compiler module (default: "brief/config/compiler.ts", env: BRIEF_COMPILER)

-r, --root <dir>

Brief workspace folder (default: "brief/case", env: BRIEF_ROOT)

-h, --help

Display the concise help for this command

brief init#

Create a Brief project

Usage#

Arguments#

[DIR]

Directory to create it in (default: ".")

Options#

--no-skills

Skip project-local Brief agent skills

-w, --framework <next>

Web framework to use

-f, --format <comark>

Page format to include; repeat for more than one

-c, --case <dir>

Existing Brief workspace folder to build around; defaults to a starter workspace

--agentation

Include Agentation visual feedback tooling (development only)

--docker

Include a production Docker setup

--search <minisearch|none>

Search backend to scaffold; defaults to minisearch

-h, --help

Display the concise help for this command

Global options are also accepted.

brief check#

Check the Brief workspace for problems

Usage#

Options#

--default-locale <tag>

Override the default locale from brief.meta.toml

--locales <a,b>

Override the locales from brief.meta.toml

--drafts

Include pages marked draft

--json

Print diagnostics as JSON

--ignore <code>

Ignore a diagnostic code; repeat for more than one (default: [])

--fail-on <error|warning>

Lowest diagnostic severity that makes the command fail (default: "error")

--no-tips

Hide content-quality tips

-h, --help

Display the concise help for this command

Global options are also accepted.

brief redirects#

Manage historical URL redirects

Usage#

Commands#

Options#

-h, --help

Display the concise help for this command

Global options are also accepted.

brief redirects sync#

Synchronize redirects with current routes

Usage#

Options#

--dry-run

Print changes without writing them

--allow-404

Allow every unexplained removed page to become a 404

--redirect-removed <old=target>

Redirect a removed route key or old page id to a current page; repeat for more (default: [])

-h, --help

Display the concise help for this command

Global options are also accepted.

brief redirects help#

display help for command

Usage#

Global options are also accepted.

brief tree#

Display the documentation structure

Usage#

Arguments#

[PATH]

Source file or directory to start from

Options#

--tab <tab>

Show one tab

--version <version>

Show one version within the selected tab

--all-versions

Show every version instead of only the defaults

-h, --help

Display the concise help for this command

Global options are also accepted.

brief page#

Manage documentation pages

Usage#

Commands#

Options#

-h, --help

Display the concise help for this command

Global options are also accepted.

brief page add#

Add a page

Usage#

Arguments#

<LOCATION>

Folder relative to the Brief workspace, such as docs/v1/getting-started

Options#

--dry-run

Print changes without writing them

--title <text>

Page title; defaults to the folder name

--description <text>

Page description; defaults to a TODO

--extension <extension>

File extension to create, such as .md

-h, --help

Display the concise help for this command

Global options are also accepted.

brief page move#

Move a page and update links (alias: mv)

Aliases: mv

Usage#

Arguments#

<FROM>

Current page folder

<TO>

New page folder

Options#

--dry-run

Print changes without writing them

--no-update-links

Do not rewrite links when URLs change

-h, --help

Display the concise help for this command

Global options are also accepted.

brief page remove#

Remove a page (alias: rm)

Aliases: rm

Usage#

Arguments#

<LOCATION>

Page folder to remove

Options#

--dry-run

Print changes without writing them

--redirect-to <page>

Redirect its old URL to this page

--allow-404

Explicitly allow the old URL to become a 404

-h, --help

Display the concise help for this command

Global options are also accepted.

brief page help#

display help for command

Usage#

Global options are also accepted.

brief group#

Manage documentation groups

Usage#

Commands#

Options#

-h, --help

Display the concise help for this command

Global options are also accepted.

brief group add#

Add a group

Usage#

Arguments#

<LOCATION>

Folder relative to the Brief workspace, such as docs/v1/guides

Options#

--dry-run

Print changes without writing them

--title <text>

Group title; defaults to the folder name

-h, --help

Display the concise help for this command

Global options are also accepted.

brief group move#

Move a group tree and update links (alias: mv)

Aliases: mv

Usage#

Arguments#

<FROM>

Current group folder

<TO>

New group folder

Options#

--dry-run

Print changes without writing them

--no-update-links

Do not rewrite links when URLs change

-h, --help

Display the concise help for this command

Global options are also accepted.

brief group remove#

Remove a group and its pages (alias: rm)

Aliases: rm

Usage#

Arguments#

<LOCATION>

Group folder to remove

Options#

--dry-run

Print changes without writing them

--redirect-to <page>

Redirect removed page URLs to this page

--allow-404

Explicitly allow removed page URLs to become 404s

-h, --help

Display the concise help for this command

Global options are also accepted.

brief group help#

display help for command

Usage#

Global options are also accepted.

brief locale#

Manage the site's locales

Usage#

Commands#

Options#

-h, --help

Display the concise help for this command

Global options are also accepted.

brief locale list#

List locales

Usage#

Options#

-h, --help

Display the concise help for this command

Global options are also accepted.

brief locale add#

Add a locale

Usage#

Arguments#

<LOCALE>

Locale tag, such as en

Options#

--dry-run

Print changes without writing them

--no-update-links

Do not rewrite links when URLs change

--name <text>

Display name for the locale

--set-default

Set the new locale as the default

-h, --help

Display the concise help for this command

Global options are also accepted.

brief locale remove#

Remove a locale

Usage#

Arguments#

<LOCALE>

Locale to remove

Options#

--dry-run

Print changes without writing them

--no-update-links

Do not rewrite links when URLs change

-h, --help

Display the concise help for this command

Global options are also accepted.

brief locale set-default#

Set the default locale

Usage#

Arguments#

<LOCALE>

Locale to set as default

Options#

--dry-run

Print changes without writing them

--no-update-links

Do not rewrite links when URLs change

-h, --help

Display the concise help for this command

Global options are also accepted.

brief locale help#

display help for command

Usage#

Global options are also accepted.

brief tab#

Manage documentation sets shown in the tab bar

Usage#

Commands#

Options#

-h, --help

Display the concise help for this command

Global options are also accepted.

brief tab list#

List tabs

Usage#

Options#

-h, --help

Display the concise help for this command

Global options are also accepted.

brief tab add#

Add a tab with an initial version

Usage#

Arguments#

<TAB>

Tab name, e.g. python-sdk

Options#

--dry-run

Print changes without writing them

--title <text>

Title shown in the tab bar

--version <name>

Initial version name; defaults to v1

-h, --help

Display the concise help for this command

Global options are also accepted.

brief tab rename#

Rename a tab

Usage#

Arguments#

<TAB>

Tab to rename

<NEW-NAME>

New name

Options#

--dry-run

Print changes without writing them

--no-update-links

Do not rewrite links when URLs change

-h, --help

Display the concise help for this command

Global options are also accepted.

brief tab remove#

Remove a tab and its pages (alias: rm)

Aliases: rm

Usage#

Arguments#

<TAB>

Tab to remove

Options#

--dry-run

Print changes without writing them

--redirect-to <page>

Redirect removed page URLs to this page

--allow-404

Explicitly allow removed page URLs to become 404s

-h, --help

Display the concise help for this command

Global options are also accepted.

brief tab set-default#

Set the default tab

Usage#

Arguments#

<TAB>

Tab to set as default

Options#

--dry-run

Print changes without writing them

--no-update-links

Do not rewrite links when URLs change

-h, --help

Display the concise help for this command

Global options are also accepted.

brief tab help#

display help for command

Usage#

Global options are also accepted.

brief version#

Manage versions within a tab

Usage#

Commands#

Options#

-h, --help

Display the concise help for this command

Global options are also accepted.

brief version list#

List versions

Usage#

Options#

--tab <tab>

Tab to use; required when the site has several

-h, --help

Display the concise help for this command

Global options are also accepted.

brief version add#

Add a version

Usage#

Arguments#

<VERSION>

Version name, such as v2

Options#

--dry-run

Print changes without writing them

--no-update-links

Do not rewrite links when URLs change

--tab <tab>

Tab to use; required when the site has several

--from <version>

Copy pages from this version

--empty

Start with no pages

--label <text>

Label shown in the version picker; defaults to the name

--set-default

Set the new version as the default

-h, --help

Display the concise help for this command

Global options are also accepted.

brief version rename#

Rename a version

Usage#

Arguments#

<VERSION>

Version to rename

<NEW-NAME>

New name

Options#

--dry-run

Print changes without writing them

--no-update-links

Do not rewrite links when URLs change

--tab <tab>

Tab to use; required when the site has several

-h, --help

Display the concise help for this command

Global options are also accepted.

brief version remove#

Remove a version and its pages

Usage#

Arguments#

<VERSION>

Version to remove

Options#

--dry-run

Print changes without writing them

--no-update-links

Do not rewrite links when URLs change

--tab <tab>

Tab to use; required when the site has several

--force

Confirm deletion of the version and its pages

-h, --help

Display the concise help for this command

Global options are also accepted.

brief version set-default#

Set the default version

Usage#

Arguments#

<VERSION>

Version to set as default

Options#

--dry-run

Print changes without writing them

--no-update-links

Do not rewrite links when URLs change

--tab <tab>

Tab to use; required when the site has several

-h, --help

Display the concise help for this command

Global options are also accepted.

brief version help#

display help for command

Usage#

Global options are also accepted.

brief skills#

Manage Brief authoring skills

Usage#

Commands#

Options#

-h, --help

Display the concise help for this command

Global options are also accepted.

brief skills install#

Install bundled skills without overwriting existing files

Usage#

Options#

--dir <dir>

Project directory for skill discovery (default: ".")

--agent <all|codex|claude>

Agent discovery directories (default: "all")

--dry-run

Preview missing skill files without writing

-h, --help

Display the concise help for this command

Global options are also accepted.

brief skills help#

display help for command

Usage#

Global options are also accepted.

brief help#

display help for command

Usage#

Global options are also accepted.