cli

@easydocs/cli

Zero-install proxy and spec export for EasyDocs.

Proxy mode — zero code changes

Route your requests through the EasyDocs proxy and it captures traffic automatically. No middleware to install, no code to change.

npx @easydocs/cli proxy --project=my-api --port=3999

Then send requests through the proxy:

http://localhost:3999?target=https://api.example.com/users

Every request is captured and an OpenAPI spec is generated in the background.

Dashboard

npx @easydocs/cli dashboard
# requires @easydocs/dashboard to be installed
npm install -D @easydocs/dashboard

Export spec

# JSON (default)
npx @easydocs/cli export

# YAML
npx @easydocs/cli export --yaml

# Scoped to a project
npx @easydocs/cli export --project=my-api

# Pipe to a file
npx @easydocs/cli export > openapi.json

Check drift — is your committed spec still true?

drift compares a committed spec against reality — the spec EasyDocs derives from observed traffic. It answers "is my spec still true?", not "did my spec change?". Only EasyDocs can do this, because it holds both the committed spec and the live traffic at once.

# Compare a committed spec against traffic captured locally
npx @easydocs/cli drift openapi.json

# Scope to a project
npx @easydocs/cli drift openapi.json --project=my-api

# Markdown output (for PR comments)
npx @easydocs/cli drift openapi.json --markdown

# Compare two spec files directly (no DB needed)
npx @easydocs/cli drift committed.json observed.json

It reports three kinds of divergence — endpoints/fields observed in traffic but undocumented, documented but never observed, and values where the docs contradict what traffic shows. Like diff, it's informational and always exits 0.

Audit sensitive fields

audit lists every field EasyDocs flagged as sensitive across the stored specs — the scriptable/CI counterpart to the dashboard's "Sensitive fields" panel. Useful to prove, in a pipeline, exactly what is being protected.

npx @easydocs/cli audit                 # all projects
npx @easydocs/cli audit --project=my-api
npx @easydocs/cli audit --markdown      # for a PR comment

Flags

Flag	Command	Default	Description
--port=<n>	proxy	3999	Port for the proxy server
--port=<n>	dashboard	4999	Port for the dashboard
--project=<slug>	proxy, export, drift, audit	default	Scope to a project
--yaml	export	—	Output YAML instead of JSON
--markdown	diff, drift, audit	—	Emit Markdown (for PR comments)
--prod	dashboard	—	Run next start instead of next dev

Environment variables

Variable	Description
EASYDOCS_DB_URL	Database URL (default: ~/.easydocs/db.sqlite)
OPENAI_API_KEY	OpenAI API key
ANTHROPIC_API_KEY	Anthropic API key
EASYDOCS_DASHBOARD_PATH	Path to a custom dashboard directory