Skip to main content

Usage

facet instructions prints agent-oriented usage guidance for the CLI. It is for AI agents: workflow guidance that tells an autonomous agent how to author and use facets, rather than per-flag help (for that, use facet <command> --help). The default topic is overview. It routes the agent to the right domain — authoring a facet, or using facets in a project — and indexes the other topics.
Requires the facet CLI v0.24.0 or newer. If facet instructions reports “Unknown command”, update with facet self-update.

Topics

default
What facets are, the three artifact files, and the two workflows: authoring vs. using.
topic
The facet.json structure, plus the JSON Schema generated live from the schema definition.
topic
Writing facets: scaffold → modify → verify, including per-asset adapter configuration.
topic
Project management: add/update/remove facets (registry-first), and install adapter tooling.

Exit codes

The manifest schema is generated

The manifest topic appends the facet.json JSON Schema generated at runtime from the schema definition — it is never a hand-maintained copy, so it always matches the CLI you are running. The narrow business rules the schema cannot express (at least one asset, kebab-case asset names, valid facet name) are described in prose alongside it; run facet build --verify to check them against a real facet. The instructions point agents at the non-interactive, machine-readable surfaces: