Agent onboarding

Context and manifest

Get a readable command reference or the full machine-readable contract for the CLI version you have installed.

purvey context prints a compact, readable reference that suits people and language models. purvey manifest prints the same contract as stable JSON for scripts and tools. Both describe exactly the version you have installed and work without signing in.

View as Markdown

Which one to use

NeedUseNotes
A readable referencepurvey contextPlain text covering access rules, the ID map, workflows, and common errors.
A machine-readable contractpurvey manifestStable JSON on standard output. Add --pretty for indented output.
JSON from an existing context callerpurvey context --jsonPrints the same contract as purvey manifest.
The contract inside a Node.js tool@purveyors/cli/manifestImport getCliManifest() to read the same contract in-process.

purvey context

Print a dense human-readable CLI reference, or the manifest as JSON.

Usage: purvey context [options]

Access: None. Works without signing in.

  • Use purvey context for dense human-readable operator reference text.
  • Prefer purvey manifest for the stable machine-readable CLI contract.
  • Use purvey context --json only for compatibility with existing context-based callers.
  • Use @purveyors/cli/manifest for the same contract in-process.
Argument or flagDetails
--jsonPrint the machine-readable manifest as compact JSON instead of the text reference.
--prettyPrint the machine-readable manifest as indented JSON instead of the text reference.
Examples
purvey context
purvey context --json
purvey context --pretty

purvey manifest

Print the stable machine-readable CLI contract as JSON.

Usage: purvey manifest [options]

Access: None. Works without signing in.

  • purvey manifest is the preferred machine-readable entrypoint and emits compact JSON by default.
  • purvey context --json remains available for compatibility with existing context-based callers.
  • The same contract is available in-process via @purveyors/cli/manifest.
Argument or flagDetails
--jsonPrint the manifest as compact JSON, the default.
--prettyPrint the manifest as indented JSON.
Examples
purvey manifest
purvey manifest --pretty

Related links

Agent integration

Patterns for AI agents that use the CLI.

Auth, config, and output

Output modes, exit codes, and the ID reference.