Documentation index: /llms.txt. Each page is also available as Markdown by adding .md to its URL.

Skip to content
Brief

brief site

Inspect authored and effective site settings, then apply validated configuration changes.

Manage site settings

Usage#

Subcommands#

Options#

-h, --helpDefault undefined
boolean

display help for command

Global options are also accepted.

brief site inspect#

Inspect authored and effective settings

Usage#

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 site update#

Update validated settings

Usage#

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 site help#

display help for command

Usage#