Facet
EnglishInstallieren

Jeder facet-Befehl, wie das Programm ihn beschreibt.

Dasselbe Programm führt Registry-Operationen in CI, im Terminal und in Agentensitzungen aus. Die Befehlsbeschreibungen und Optionen unten werden aus der englischen Originalhilfe des Programms generiert.

Das Programm bereitstellen

Starten Sie /facet:setup in Ihrer eingerichteten FACET-Agentensitzung. Die Einrichtung ermittelt das Programm der Distribution und verknüpft es für die Shell. Derselbe facet-Befehl steht anschließend Terminal, Editor und Git-Hooks zur Verfügung.

Mit dem Claude-Plugin steht facet in -Sitzungen bereit. /facet:setup verknüpft es mit einem Verzeichnis im PATH Ihrer Shell, damit auch Terminal, Editor und Git-Hook es finden:

Dein Schritt

facet setup link --candidates

Sie sehen

Beschreibbare Verzeichnisse in Ihrem Benutzerverzeichnis, die bereits im PATH Ihrer Login-Shell stehen. Übergeben Sie eines an facet setup link --dir. Der Link verwendet einen versionsunabhängigen Zeiger und bleibt bei Updates gültig. Shell-Startdateien werden nicht geändert.

Alle Befehle

Jeder Befehl akzeptiert --root <path> für den Repository-Stammordner. Ohne Angabe wird das oberste Git-Verzeichnis verwendet, sonst das aktuelle Verzeichnis.

facet adr

Inspect architecture decision proposals without writing files

Aufruf

facet adr [command]

Unterbefehle

Aus facet adr --help (englische Originalhilfe)

facet adr propose-status

Print a read-only status diff for an existing docs/adr Markdown file

Aufruf

facet adr propose-status <path> [flags]
Optionen für facet adr propose-status
OptionFunktion (englische Originalhilfe)
--jsonemit the read-only proposal and diff as JSON
--reason stringreason for this proposal (required for a changed status)
--status stringone of the four existing ADR statuses
--superseded-by stringexisting different docs/adr file for an abgelöst proposal; metadata only

Aus facet adr propose-status --help (englische Originalhilfe)

facet backing

List the declared behaviour that is deliberately not backed by data yet

Aufruf

facet backing [flags]
Optionen für facet backing
OptionFunktion (englische Originalhilfe)
--jsonemit the list as JSON
--registry stringonly this registry (default: all declared in .facetrc.yaml)

Aus facet backing --help (englische Originalhilfe)

facet calibrate

Report the shape of the registry: how finely the product has been documented

Aufruf

facet calibrate [flags]
Optionen für facet calibrate
OptionFunktion (englische Originalhilfe)
--jsonemit the calibration as JSON
--registry stringmeasure only this registry (default: all declared in .facetrc.yaml)

Aus facet calibrate --help (englische Originalhilfe)

facet conventions

Show which project conventions document applies to each registry

Aufruf

facet conventions [flags]
Optionen für facet conventions
OptionFunktion (englische Originalhilfe)
--jsonemit the resolution as JSON

Aus facet conventions --help (englische Originalhilfe)

facet defects

Rank features and files by how often they have been fixed

Aufruf

facet defects [flags]
facet defects [command]
Optionen für facet defects
OptionFunktion (englische Originalhilfe)
--by-filerank files instead of features
--jsonemit the ranking as JSON
--registry stringonly this registry (default: all declared in .facetrc.yaml)
--top intshow only the first N entries (default: all)

Unterbefehle

Aus facet defects --help (englische Originalhilfe)

facet defects backfill

Fill the defect ledger from git history

Aufruf

facet defects backfill [flags]
Optionen für facet defects backfill
OptionFunktion (englische Originalhilfe)
--dry-runreport what would be written without writing it
--jsonemit the report as JSON
--limit intwalk at most this many commits back from the starting revision
--match stringregular expression a commit subject must match (default: (?i)^(fix|bugfix|hotfix)(\([^)]*\))?!?:)
--registry stringonly this registry (default: all declared in .facetrc.yaml)
--rev stringrevision to walk back from (default: HEAD)
--since stringonly commits authored after this date (git syntax, e.g. '90.days' or '2026-01-01')
--until stringonly commits authored before this date

Aus facet defects backfill --help (englische Originalhilfe)

facet deviations

List the documented behaviour that is a defect rather than a promise

Aufruf

facet deviations [flags]
Optionen für facet deviations
OptionFunktion (englische Originalhilfe)
--jsonemit the list as JSON
--registry stringonly this registry (default: all declared in .facetrc.yaml)

Aus facet deviations --help (englische Originalhilfe)

facet docs

Track whether generated documentation still matches its inputs

Aufruf

facet docs [command]

Unterbefehle

Aus facet docs --help (englische Originalhilfe)

facet docs check

Report generated artifacts whose inputs have changed

Aufruf

facet docs check [flags]
Optionen für facet docs check
OptionFunktion (englische Originalhilfe)
--jsonemit statuses as JSON
--strictexit non-zero when any artifact is not current

Aus facet docs check --help (englische Originalhilfe)

facet docs record

Record what produced a generated artifact

Aufruf

facet docs record [flags]
Optionen für facet docs record
OptionFunktion (englische Originalhilfe)
--artifact stringpath to the generated file, relative to the repo root
--feature stringfeature id the artifact was generated from
--generated-at stringISO date of generation
--model stringmodel that generated the artifact
--pipeline stringgenerator pipeline name (default facet-knowledge)
--prompt-version stringversion of the generation prompt
--slots stringsKnowledge slots the artifact consumed

Aus facet docs record --help (englische Originalhilfe)

facet drift

Report anchored source that changed without its record following

Aufruf

facet drift [flags]
facet drift [command]
Optionen für facet drift
OptionFunktion (englische Originalhilfe)
--baseline stringcompare against this revision (default: the accepted baseline, else HEAD)
--jsonemit drift as JSON
--registry stringcheck only this registry (default: all declared in .facetrc.yaml)
--repository stringcompare only this declared source repository (workspace-relative)

Unterbefehle

Aus facet drift --help (englische Originalhilfe)

facet drift accept

Record that the changes since the baseline have been reviewed

Aufruf

facet drift accept [path...] [flags]
Optionen für facet drift accept
OptionFunktion (englische Originalhilfe)
--baseline stringstart this acceptance at the confirmed reviewed revision, keeping other incoming paths unreviewed
--outcome stringwhat the review concluded (default behavior-unchanged)
--repository stringaccept only this declared source repository; paths stay workspace-relative

Aus facet drift accept --help (englische Originalhilfe)

facet drift reset

Forget this worktree's accepted baseline and compare against HEAD again

Aufruf

facet drift reset [flags]
Optionen für facet drift reset
OptionFunktion (englische Originalhilfe)
--repository stringreset only this declared source repository

Aus facet drift reset --help (englische Originalhilfe)

facet errors

List identifiers found in scenario text, grouped and gap-checked by band

Aufruf

facet errors [flags]
Optionen für facet errors
OptionFunktion (englische Originalhilfe)
--jsonemit the register as JSON
--registry stringonly this registry (default: all declared in .facetrc.yaml)

Aus facet errors --help (englische Originalhilfe)

facet filter install

Configure this clone so anchors you add stay out of every commit

Aufruf

facet filter install [flags]
Optionen für facet filter install
OptionFunktion (englische Originalhilfe)
--command stringthe facet executable git should run (default: this binary's path)

Aus facet filter install --help (englische Originalhilfe)

facet filter refresh

Make 'git status' agree with 'git diff' after editing a private anchor

Aufruf

facet filter refresh [path...]

Keine eigenen Optionen neben --root.

Aus facet filter refresh --help (englische Originalhilfe)

facet filter status

List the private anchors this clone keeps, and any that lost their place

Aufruf

facet filter status

Keine eigenen Optionen neben --root.

Aus facet filter status --help (englische Originalhilfe)

facet filter uninstall

Remove the filter from this clone; private anchors stay in the working copy and become committable

Aufruf

facet filter uninstall

Keine eigenen Optionen neben --root.

Aus facet filter uninstall --help (englische Originalhilfe)

facet index

Print the record index agents are given

Aufruf

facet index [flags]
Optionen für facet index
OptionFunktion (englische Originalhilfe)
--bareids only, without the intent summaries
--max-bytes intbudget for the rendered index (default 24576)

Aus facet index --help (englische Originalhilfe)

facet lint

Check records against their schema and against the code they anchor

Aufruf

facet lint [flags]
Optionen für facet lint
OptionFunktion (englische Originalhilfe)
--jsonemit findings as JSON
--registry stringcheck only this registry (default: all declared in .facetrc.yaml)
--skip stringschecks to skip (schema, orphan-ids, orphan-records, variants, taxonomy, glossary, duplicate-glossary-term, glossary-near-miss, duplicate-glossary-category, undeclared-glossary-category, empty-glossary-category, sizing, registry-refs, flags, knowledge, backing, deviation, examples, broken-links, dependencies, superseded-by, proves, verification-targets, unclaimed-tests, sibling-suffix, created-at-history, no-scenarios, anchor-proves, anchor-roles, test-only-anchors, enum-divergence, unanchored-hotspots, undocumented-directories, error-codes, lost-anchors, plugin-lint)
--stagedcheck only the index: report the errors it introduces compared with HEAD (what the commit gate runs)
--today stringISO date used for flag retirement checks (default: today, UTC)

Aus facet lint --help (englische Originalhilfe)

facet lsp

Serve FACET code intelligence over LSP on stdio

Aufruf

facet lsp

Keine eigenen Optionen neben --root.

Aus facet lsp --help (englische Originalhilfe)

facet mcp

Serve the registry over MCP on stdio

Aufruf

facet mcp

Keine eigenen Optionen neben --root.

Aus facet mcp --help (englische Originalhilfe)

facet plugin add

Install a plugin package from a file, folder, https URL, or github:owner/repo@tag

Aufruf

facet plugin add <source> [flags]
Optionen für facet plugin add
OptionFunktion (englische Originalhilfe)
--devlink a working folder instead of copying it (ADR-0004 §8)
--grant stringArraygrant a right without asking: tools=a,b / env=X,Y / ai=a,b / ai-env=X,Y
--replacereplace an already-installed plugin of the same id
--sha256 stringexpected SHA256 of the package (required for an https:// source)

Aus facet plugin add --help (englische Originalhilfe)

facet plugin list

List installed plugins

Aufruf

facet plugin list [flags]
Optionen für facet plugin list
OptionFunktion (englische Originalhilfe)
--jsonprint as JSON

Aus facet plugin list --help (englische Originalhilfe)

facet plugin pack

Pack a plugin folder into a .facetplugin, writing SHA256SUMS from the actual files

Aufruf

facet plugin pack <dir> [flags]
Optionen für facet plugin pack
OptionFunktion (englische Originalhilfe)
-o, --out stringoutput path (default <id>-<version>.facetplugin)

Aus facet plugin pack --help (englische Originalhilfe)

facet plugin remove

Remove an installed plugin

Aufruf

facet plugin remove <id>

Keine eigenen Optionen neben --root.

Aus facet plugin remove --help (englische Originalhilfe)

facet plugin update

Re-install a plugin from the source it was installed from

Aufruf

facet plugin update <id> [flags]
Optionen für facet plugin update
OptionFunktion (englische Originalhilfe)
--grant stringArraygrant a right without asking: tools=a,b / env=X,Y / ai=a,b / ai-env=X,Y

Aus facet plugin update --help (englische Originalhilfe)

facet rag

Index the registry for retrieval, and search it

Aufruf

facet rag [command]

Unterbefehle

Aus facet rag --help (englische Originalhilfe)

facet rag index

Embed the records and generated documents into a vector index

Aufruf

facet rag index [flags]
Optionen für facet rag index
OptionFunktion (englische Originalhilfe)
--embed-batch intchunks per request (default 64)
--embed-dimensions intshorten vectors, where the provider supports it
--embed-key-env stringenvironment variable holding the API key (never the key itself)
--embed-model stringembedding model name
--embed-provider string"openai" for any OpenAI-compatible endpoint, or "local" (default: from .facetrc.yaml)
--embed-url stringembeddings API root, without /embeddings
--index-path stringwhere the index lives (default: docs/facets/generated.rag.bin)
--jsonreport the build as JSON

Aus facet rag index --help (englische Originalhilfe)

facet rag query

Search the index and print the nearest chunks

Aufruf

facet rag query <question> [flags]
Optionen für facet rag query
--embed-batch intchunks per request (default 64)
--embed-dimensions intshorten vectors, where the provider supports it
--embed-key-env stringenvironment variable holding the API key (never the key itself)
--embed-model stringembedding model name
--embed-provider string"openai" for any OpenAI-compatible endpoint, or "local" (default: from .facetrc.yaml)
--embed-url stringembeddings API root, without /embeddings
--index-path stringwhere the index lives (default: docs/facets/generated.rag.bin)
--jsonemit hits as JSON
--kind stringonly "record" chunks or only "doc" chunks
-n, --limit inthow many chunks to return (default 5)
--min-score floatdrop hits below this cosine similarity

Aus facet rag query --help (englische Originalhilfe)

facet registries

Show which features each registry documents

Aufruf

facet registries [flags]
Optionen für facet registries
OptionFunktion (englische Originalhilfe)
--gapsshow only ids that some registry is missing
--jsonemit the matrix as JSON

Aus facet registries --help (englische Originalhilfe)

Make facet reachable from your shell with a link to the current binary

facet setup link [flags]
Optionen für facet setup link
OptionFunktion (englische Originalhilfe)
--candidateslist user-writable directories on your login shell's PATH
--dir stringdirectory to put the facet link in
--forcelink even when the directory is not on your login shell's PATH

Aus facet setup link --help (englische Originalhilfe)

facet setup precommit

Install a git pre-commit hook that runs 'facet lint --staged'

Aufruf

facet setup precommit [flags]
Optionen für facet setup precommit
OptionFunktion (englische Originalhilfe)
--removeremove the hook, only if FACET wrote it
--writeinstall the hook (default: dry run)

Aus facet setup precommit --help (englische Originalhilfe)

facet setup status

Report, check by check, how far this project's FACET setup goes

Aufruf

facet setup status [flags]
Optionen für facet setup status
OptionFunktion (englische Originalhilfe)
--evidenceprint each row's evidence under it
--jsonemit the rows as a JSON array of {id, state, finding, evidence}
--strictexit 1 when any row is red

Aus facet setup status --help (englische Originalhilfe)

facet snapshot

Freeze this repository's Atlas corpus into one JSON file

Aufruf

facet snapshot [flags]
Optionen für facet snapshot
OptionFunktion (englische Originalhilfe)
--no-excerptsdrop the source line quoted under every anchor
-o, --out stringfile to write ('-' or empty for stdout)
--registry stringregistry to freeze, in a repository that declares several

Aus facet snapshot --help (englische Originalhilfe)

facet split

Report what a re-cut dropped: facets the parent carried and no child does

Aufruf

facet split --check <parent-id> <child-id> [<child-id> ...] [flags]
Optionen für facet split
OptionFunktion (englische Originalhilfe)
--checkreport what the split dropped
--from stringgit revision, or a path, to read the parent record from (default HEAD)
--jsonmachine-readable output
--registry stringwhich registry, in a monorepo that declares several

Aus facet split --help (englische Originalhilfe)

facet test

Run declared test commands and report per-file verification results

Aufruf

facet test [flags]
Optionen für facet test
OptionFunktion (englische Originalhilfe)
--checkcheck discovery and baseline drift without executing tests
--fail-unmeasuredexit 1 on incomplete feature or file evidence; preserve nonzero runner exits
--jsonemit reports as JSON; during execution runner output goes to stderr
--listlist discovered files and check drift without executing tests
--only stringshow only facet or runner output (execution only)
--registry stringselect one declared registry
--runner stringselect one declared runner; absence across other runners is unmeasured
--update-baselineremove stale baseline entries; never add paths

Aus facet test --help (englische Originalhilfe)

facet ui

Read this repository's FACET registry in a browser

Aufruf

facet ui [flags]
Optionen für facet ui
OptionFunktion (englische Originalhilfe)
--companion-bin stringClaude Code executable for the companion (default: claude on PATH)
--companion-model stringmodel the companion answers with (default: whatever Claude Code is set to)
--no-opendo not open a browser, only print the address
--port intport to listen on; a taken port falls back to one the system picks (default 7317)
--record stringopen straight at this record id, e.g. tasks/create/quick-add
--registry stringregistry to read (default: the first declared in .facetrc.yaml)

Aus facet ui --help (englische Originalhilfe)

facet wiki check

Check the wiki, as CI would

Aufruf

facet wiki check [flags]
Optionen für facet wiki check
OptionFunktion (englische Originalhilfe)
--jsonemit findings as JSON
--registry stringwhich registry's wiki (default: the first declared)
--stricttreat every warning as an error

Aus facet wiki check --help (englische Originalhilfe)

facet wiki import

Bring pages in from another system, on a branch, and report what was lost

Aufruf

facet wiki import <source> <ref> [flags]
Optionen für facet wiki import
OptionFunktion (englische Originalhilfe)
--branch stringthe branch to import onto (default: one named after the reference)
--jsonemit the report as JSON
--no-commitwrite the files on the branch but do not commit them
--registry stringwhich registry's wiki (default: the first declared)

Aus facet wiki import --help (englische Originalhilfe)

facet wiki list

List the wiki's pages

Aufruf

facet wiki list [flags]
Optionen für facet wiki list
OptionFunktion (englische Originalhilfe)
--bereich stringonly pages in this area
--jsonemit the listing as JSON
--kategorie stringonly pages of this category
--registry stringwhich registry's wiki (default: the first declared)
--tag stringonly pages carrying this tag

Aus facet wiki list --help (englische Originalhilfe)

facet wiki mirror

Push the wiki's pages out again, refusing what changed on the far side

Aufruf

facet wiki mirror --to=confluence --space=KEY [flags]
Optionen für facet wiki mirror
OptionFunktion (englische Originalhilfe)
--jsonemit the report as JSON
--registry stringwhich registry's wiki (default: the first declared)
--space stringthe Confluence space key to push into (required)
--to stringwhich system to push to (default confluence)

Aus facet wiki mirror --help (englische Originalhilfe)

facet wiki new

Write a new page's header and scaffold

Aufruf

facet wiki new "Title" [flags]
Optionen für facet wiki new
OptionFunktion (englische Originalhilfe)
--bereich stringthe area — the folder directly under wiki/ (required)
--gruppe stringan optional group folder under the area
--kategorie stringthe page's category, from those wiki.yaml declares
--records stringcomma-separated record ids this page is about
--registry stringwhich registry's wiki (default: the first declared)
--summary stringthe one line shown under the title in listings
--tags stringcomma-separated tags

Aus facet wiki new --help (englische Originalhilfe)

facet wiki tag

Add or remove a page's tags, leaving everything else alone

Aufruf

facet wiki tag <path> [flags]
Optionen für facet wiki tag
OptionFunktion (englische Originalhilfe)
--add stringcomma-separated tags to add
--registry stringwhich registry's wiki (default: the first declared)
--remove stringcomma-separated tags to remove

Aus facet wiki tag --help (englische Originalhilfe)