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

Skip to content
Brief

brief updates

Record page update times and content hashes after editing documentation.

Manage page update checkpoints

Usage#

Subcommands#

Options#

-h, --helpDefault undefined
boolean

Display the concise help for this command

Global options are also accepted.


brief updates sync#

Record changed body hashes and update times; defaults to all pages

Usage#

Arguments#

[PATH]Default undefined
string

Page path relative to the documentation root

Options#

--locale <tag>Default undefined
string

Only synchronize this translation

--dry-runDefault undefined
boolean

Print changes without writing them

--time <timestamp>Default undefined
string

ISO 8601 timestamp with timezone

--date <date>Default undefined
string

Calendar date (YYYY-MM-DD), at midnight UTC

-h, --helpDefault undefined
boolean

Display the concise help for this command


brief updates help#

display help for command

Usage#


Record page update times#

Brief stores updatedAt and contentHash together in each translation's frontmatter. The compiler hashes the parsed page body and warns when the saved checkpoint is missing or stale. After editing content, preview and apply the update before publishing:

With no path, sync covers all pages, including drafts and every translation. Only changed or incomplete checkpoints receive the current time; already-current pages keep their dates. The command uses one UTC timestamp for the batch. There is no need to pass --all.

To synchronize one page, pass its path relative to the documentation root. Add --locale to select one translation:

Use --date for a calendar date at midnight UTC, or --time for an ISO timestamp with an explicit timezone. These options are mutually exclusive and apply only to checkpoints that need updating:

The compiler hashes the page AST, so frontmatter-only edits and source formatting that leaves the AST unchanged do not require synchronization. Body changes, including rewritten links, do. Sync maintains the timestamp and hash together; do not calculate or edit hashes manually.

Builds, watchers, and brief check never advance update times. Filesystem modification times are not publication dates. Existing updatedAt values remain visible until synchronization; pages without one omit the date. When migrating existing content, use --date or --time to establish a known historical checkpoint, or omit them to record the current time.