brief group

Organize documentation groups and inspect, update, or reorder their contents.

Manage documentation groups

Usage#

brief group [options] [command]

Subcommands#

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

Options#

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

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

Arguments#

<LOCATION>Required: string; Group folder 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 group move#

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

Aliases: mv

Usage#

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

Arguments#

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

<TO>Required: string; New group path relative to --root; preserves titles 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 group add#

Add a group

Usage#

brief group add <location> [options]

Arguments#

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

Options#

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

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

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

brief group inspect#

Inspect authored and effective settings

Usage#

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

Update validated settings

Usage#

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

Place an entry among its siblings; defaults to last

Usage#

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

display help for command

Usage#

brief group help [command]