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

Skip to content
Brief

brief check

Check documentation, review diagnostics, and apply supported fixes with Brief's CLI.

Check the Brief workspace for problems

Usage#

Options#

--default-locale <tag>Default undefined
string

Override the default locale from brief.meta.toml

--locales <a,b>Default undefined
string[]

Override the locales from brief.meta.toml

--draftsDefault undefined
boolean

Include pages marked draft

--jsonDefault undefined
boolean

Print diagnostics as JSON

--fixDefault undefined
boolean

Apply available diagnostic fixes

--dangerousDefault undefined
boolean

Also apply corrections that infer author intent

--dry-runDefault undefined
boolean

Preview diagnostic fixes without writing

--ignore <code>Default []
string[]

Ignore a diagnostic code; repeat for more than one

--fail-on <error|warning>Default "error"
"error" | "warning"

Lowest diagnostic severity that makes the command fail

--no-tipsDefault true
boolean

Hide content-quality tips

-h, --helpDefault undefined
boolean

Display the concise help for this command

Global options are also accepted.