brief page

Add, move, remove, inspect, and update documentation pages with Brief's CLI.

Manage documentation pages

Usage#

brief page [options] [command]

Subcommands#

brief page move — Move a page and update links (alias: mv)
brief page remove — Remove a page (alias: rm)
brief page add — Add a page
brief page inspect — Inspect authored and effective settings
brief page update — Update validated settings
brief page order — Place an entry among its siblings; defaults to last
brief page help — display help for command

Options#

-h, --helpDefault undefined: boolean; 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#

brief page move <from> <to> [options]

Arguments#

<FROM>Required: string; Current page path relative to --root, such as docs/v1/install

<TO>Required: string; New page path relative to --root; preserves the title and content

Options#

--dry-runDefault undefined: boolean; Print changes without writing them

--no-update-linksDefault true: boolean; Do not rewrite links when URLs change

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

brief page remove#

Remove a page (alias: rm)

Aliases: rm

Usage#

brief page remove <location> (--redirect-to <page> | --allow-404) [options]

Arguments#

<LOCATION>Required: string; Page folder to remove

Options#

--dry-runDefault undefined: boolean; Print changes without writing them

--redirect-to <page>Default undefined: string; Redirect its old URL to this page

--allow-404Default undefined: boolean; Explicitly allow the old URL to become a 404

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

brief page add#

Add a page

Usage#

brief page add <location> [options]

Arguments#

<LOCATION>Required: string; Folder relative to the Brief workspace, such as docs/v1/getting-started

Options#

--dry-runDefault undefined: boolean; Print changes without writing them

--title <text>Default undefined: string; Page title; defaults to the folder name

--description <text>Default undefined: string; Page description; defaults to a TODO

--extension <extension>Default undefined: string; File extension to create, such as .md

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

brief page inspect#

Inspect authored and effective settings

Usage#

brief page inspect [options] <path>

Arguments#

<PATH>Required: string; Source path relative to the documentation root

Options#

--locale <tag>Default undefined: string; Translation to inspect or update

--jsonDefault undefined: boolean; Print a structured result

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

brief page update#

Update validated settings

Usage#

brief page update [options] <path>

Arguments#

<PATH>Required: string; Source path relative to the documentation root

Options#

--locale <tag>Default undefined: string; Translation to inspect or update

--jsonDefault undefined: boolean; Print a structured result

--input <file>Default undefined: string; JSON settings patch file; use - for stdin

--set <key=json>Default []: string[]; Set a field to a JSON value; repeat as needed

--unset <key>Default []: string[]; Remove a field or override; repeat as needed

--dry-runDefault undefined: boolean; Validate and preview without writing

--no-update-linksDefault true: boolean; Leave authored links unchanged when URLs change

--title <value>Default undefined: string; Set title

--description <value>Default undefined: string; Set description

--label <value>Default undefined: string; Set label

--slug <value>Default undefined: string; Set slug

--canonical <value>Default undefined: string; Set canonical

--draft <value>Default undefined: string; Set draft

--hidden <value>Default undefined: string; Set hidden

--noindex <value>Default undefined: string; Set noindex

--searchable <value>Default undefined: string; Set searchable

--agents <value>Default undefined: string; Set agents

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

brief page order#

Place an entry among its siblings; defaults to last

Usage#

brief page order [options] <path>

Arguments#

<PATH>Required: string; Source path relative to the documentation root

Options#

--before <path>Default undefined: string; Place before this sibling

--after <path>Default undefined: string; Place after this sibling

--firstDefault undefined: boolean; Place first

--lastDefault undefined: boolean; Place last

--locale <tag>Default undefined: string; Update this locale override

--dry-runDefault undefined: boolean; Validate and preview without writing

--jsonDefault undefined: boolean; Print a structured result

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

brief page help#

display help for command

Usage#

brief page help [command]