AA.Docs CLI

Official command-line interface for AA.Docs. It discovers the OpenAPI contract, verifies agent-facing endpoints, prints MCP configuration and runs the public synthetic sandbox.

Install

brew install aadocs-comp/tap/aadocs

The same tagged release can be installed through npm without registry credentials.

npm install --global github:aadocs-comp/aadocs-cli#v0.1.1

The package metadata uses @aadocs/cli. npm registry publication requires registry ownership and is not claimed by this release.

Node.js 20 or newer can run the repository checkout directly.

node bin/aadocs.mjs doctor

First run

aadocs doctor
aadocs sandbox info
aadocs sandbox sample
aadocs sandbox preview --document-type contract --amount 125000 --currency RUB

The public sandbox requires no account or API key. It accepts synthetic metadata only, stores nothing, accepts no files and cannot create a production process.

Commands

Command	Result
aadocs doctor	Checks OpenAPI, agent instructions, lifecycle policy, sandbox, OAuth metadata and the MCP authentication challenge
aadocs openapi	Prints the current AA.Docs OpenAPI document
aadocs sandbox info	Prints live sandbox capabilities and safety constraints
aadocs sandbox sample	Prints a fixed synthetic contract
aadocs sandbox preview	Builds a stateless synthetic process preview
aadocs mcp-config	Prints an MCP client configuration with the minimum aadocs:read scope

Production access

The CLI intentionally does not accept session cookies, files or production credentials. Use the OAuth-enabled MCP endpoint or the documented REST authentication for real AA.Docs data. Consequential actions remain subject to human confirmation.

Developer portal and machine-readable resources are available at the following locations.

• https://aadocs.ru/developers
• https://aadocs.ru/developers/cli
• https://aadocs.ru/cli.json
• https://aadocs.ru/openapi.json
• https://aadocs.ru/agent-instructions.md
• https://aadocs.ru/api-lifecycle.json
• https://app.aadocs.ru/.well-known/oauth-protected-resource/mcp

The Homebrew formula is published at https://github.com/aadocs-comp/homebrew-tap/blob/main/Formula/aadocs.rb.

Development

npm test
npm run check

The CLI has no runtime dependencies.