← Command reference · CLI overview
lean-pkg llms
print the agent-oriented usage contract.
Usage
lean-pkg llms [--short] [common flags]
[common flags]: --json, --commit, --push, --no-commit, also accepted before the command name; see the CLI overview.
Arguments and flags
| Argument or flag | Description |
|---|---|
--short |
a compact contract (~40 lines) cut from the full one: PURPOSE, STANDING RULES and the first line of each subcommand; no flag details, schemas or examples |
Details
| Form | What it does | Key flags |
|---|---|---|
llms |
print the agent contract (--json: {"ok": true, "text": ...}). --short: a compact contract of about 40 lines cut from the full text by its section headers, never kept by hand: the title, the PURPOSE header and its first three lines, STANDING RULES, and the SUBCOMMANDS header with the first line of each subcommand (no flag continuations, examples, receipt schemas, event schema or exit codes); every line is a line of the full text; --json adds "short": true |
[--short] |
Exit codes
0 success (dry runs and no-ops included), 1 refused or failed, 2 usage error; see Exit codes.
JSON output
Top-level keys of --json, as recorded in the golden contract (tests/golden/json-keys.json):
llms(exit 0):ok,text