@exayard/cli

Official command-line interface for the Exayard API — AI-powered construction takeoffs, estimates, and bids. Built for humans and agents alike: every command supports --json for machine-readable output and returns stable exit codes.

Install

npm install -g @exayard/cli
# or run without installing:
npx @exayard/cli --help

Authenticate

Generate an API key with the minimum scopes you need at exayard.com/settings/developer, then:

exayard login --api-key sk_live_...

Credentials are saved to ~/.exayard/config.json. You can also pass --api-key / --org per call, or set EXAYARD_API_KEY.

Commands

Projects:
  exayard projects list --org org_...
  exayard projects create --name "<name>"
  exayard projects archive <project_id>

Webhooks:
  exayard webhooks list
  exayard webhooks create --url <https://...> --events "project.created,bid.generated"
  exayard webhooks delete <endpoint_id>
  exayard webhooks verify --signature ... --secret ... < body.json
  exayard listen --forward-to http://localhost:...   (experimental)

Help / misc:
  exayard help-search "how do I run a takeoff"
  exayard init                                       Drop agents.md into the cwd

Global flags

| Flag | Description | |------|-------------| | --json | Emit machine-readable JSON and suppress prose | | --api-key <key> | Override saved credentials for this call | | --org <id> | Override the saved organization ID |

Exit codes

| Code | Meaning | |------|---------| | 0 | Success | | 1 | Operation failed (expected, actionable) | | 2 | Usage error (bad flags) | | 3 | Network / unexpected error |

Agents should branch on the exit code and parse --json output.

Links

• API reference: https://developers.exayard.com/api-reference
• OpenAPI spec: https://api.exayard.com/v1/openapi.json
• MCP discovery: https://api.exayard.com/.well-known/mcp.json

License

MIT