brief tab

Manage documentation tabs, their settings, and their order in site navigation.

Manage documentation sets shown in the tab bar

Usage#

brief tab [options] [command]

Subcommands#

brief tab list — List tabs
brief tab add — Add a tab with an initial version
brief tab rename — Change a tab ID and move its versions and pages; preserve its title
brief tab remove — Remove a tab and its pages (alias: rm)
brief tab set-default — Set the default tab
brief tab inspect — Inspect authored and effective settings
brief tab update — Update validated settings
brief tab order — Place an entry among its siblings; defaults to last
brief tab help — display help for command

Options#

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

Global options are also accepted.

brief tab list#

List tabs

Usage#

brief tab list [options]

Options#

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

brief tab add#

Add a tab with an initial version

Usage#

brief tab add <tab> --title <text> [--version <name>] [options]

Arguments#

<TAB>Required: string; Tab name, e.g. python-sdk

Options#

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

--title <text>Required: string; Title shown in the tab bar

--version <name>Default undefined: string; Initial version name; defaults to v1

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

brief tab rename#

Change a tab ID and move its versions and pages; preserve its title

Usage#

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

Arguments#

<TAB>Required: string; Tab 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

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

brief tab remove#

Remove a tab and its pages (alias: rm)

Aliases: rm

Usage#

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

Arguments#

<TAB>Required: string; Tab to remove

Options#

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

--redirect-to <page>Default undefined: string; Redirect removed page URLs to this page

--allow-404Default undefined: boolean; Explicitly allow removed page URLs to become 404s

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

brief tab set-default#

Set the default tab

Usage#

brief tab set-default <tab> [options]

Arguments#

<TAB>Required: string; Tab 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

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

brief tab inspect#

Inspect authored and effective settings

Usage#

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

Update validated settings

Usage#

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

Place an entry among its siblings; defaults to last

Usage#

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

display help for command

Usage#

brief tab help [command]