brief version

Manage documentation versions, defaults, settings, and navigation order within a tab.

Manage versions within a tab

Usage#

brief version [options] [command]

Subcommands#

brief version list — List versions
brief version add — Create an empty version or copy an existing version
brief version rename — Rename a version
brief version remove — Remove a version and its pages
brief version set-default — Set the default version
brief version inspect — Inspect authored and effective settings
brief version update — Update validated settings
brief version order — Place an entry among its siblings; defaults to last
brief version help — display help for command

Options#

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

Global options are also accepted.

brief version list#

List versions

Usage#

brief version list [options]

Options#

--tab <tab>Default undefined: string; Tab to use; required when the site has several

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

brief version add#

Create an empty version or copy an existing version

Usage#

brief version add <version> (--from <version> | --empty) [options]

Arguments#

<VERSION>Required: string; Version name, such as v2

Options#

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

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

--tab <tab>Default undefined: string; Tab to use; required when the site has several

--from <version>Default undefined: string; Copy pages from this version

--emptyDefault undefined: boolean; Start with no pages

--label <text>Default undefined: string; Label shown in the version picker; defaults to the name

--set-defaultDefault undefined: boolean; Set the new version as the default

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

brief version rename#

Rename a version

Usage#

brief version rename <version> <new-name> [options]

Arguments#

<VERSION>Required: string; Version to rename

<NEW-NAME>Required: string; New name

Options#

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

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

--tab <tab>Default undefined: string; Tab to use; required when the site has several

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

brief version remove#

Remove a version and its pages

Usage#

brief version remove <version> --force [options]

Arguments#

<VERSION>Required: string; Version to remove

Options#

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

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

--tab <tab>Default undefined: string; Tab to use; required when the site has several

--forceDefault undefined: boolean; Confirm deletion of the version and its pages

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

brief version set-default#

Set the default version

Usage#

brief version set-default <version> [options]

Arguments#

<VERSION>Required: string; Version to set as default

Options#

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

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

--tab <tab>Default undefined: string; Tab to use; required when the site has several

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

brief version inspect#

Inspect authored and effective settings

Usage#

brief version 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 version update#

Update validated settings

Usage#

brief version 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 version order#

Place an entry among its siblings; defaults to last

Usage#

brief version 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 version help#

display help for command

Usage#

brief version help [command]