CLI
Every gtme verb in one table, each linking its own page, with the exit codes they all share, generated from gtme help --agent
What you'll learn
You know what you want gtme to do and need the verb, or a script needs the exit code to branch on.
- every verb and what it does
- the exit codes every verb shares
- where each verb's own page is
gtme has 13 verbs, in the order gtme help --agent prints them. Each verb's own page has its forms, its flags, an example from the docs, and where the docs use it. Everything a verb prints for a person goes to stderr; stdout carries data, so a script or an agent can read it.
| Verb | Does |
|---|---|
gtme init | Create ~/.gtme and the ledger |
gtme secret | Store a credential in ~/.gtme/secrets (VALUE omitted = prompt, no echo) |
gtme plan | Resolve adapters, validate every step's needs/uses and credentials, print the plan |
gtme run | Execute a pipeline |
gtme query | read-only SQL against the ledger |
gtme show | Print the current-value projection for one identity |
gtme answer | Record a participant's answer for one pending human/* or agent/* step |
gtme runs | List runs, or print one run's receipt (records/cost per step) |
gtme freeze | Print the pipeline.yaml that produced a run, reconstructed from its stored config |
gtme groups | List groups with their entity type and derived character (members, added/removed/touched tallies), inspect one |
gtme vacuum | Evict expired payloads from the ADR-030 cache tier |
gtme adapters | List installed adapters with their source and pin (.source.json) |
gtme help | Print this document |
Exit codes
Every verb exits with one of these, so a script can branch on the number.
| Code | Means |
|---|---|
| 0 | ok |
| 1 | other error |
| 2 | validation or contract error: the plan, the file, or a value was refused |
| 3 | auth or credential error |
| 4 | rate-limited by a vendor |
| 5 | network error |