Command line
RevDesk CLI
Use the official revdesk command bundled with @revdesk/sdk to inspect resources and script scoped RevDesk API operations from a terminal or agent runtime.
What it is
The RevDesk CLI is the command-line entry point bundled with the official TypeScript SDK. It gives developers and agents a discoverable way to inspect commands, supply an organization-scoped credential through the environment, and invoke supported RevDesk API operations without first writing an application. Because the CLI reaches the same v1 API, it follows the same scopes, rate limits, error envelopes, idempotency rules, and approval boundaries.
When to use RevDesk CLI
- Explore the RevDesk API interactively before building an integration.
- Run a repeatable RevDesk operation from a shell, CI job, or agent tool environment.
- Give an agent a constrained executable interface when MCP is not available.
Recommended workflow
- 1Run npx @revdesk/sdk --help to inspect the released command inventory.
- 2Put a least-privilege API key in the documented environment variable or secret store.
- 3Inspect before mutating, pass idempotency input where supported, and capture structured output for automation.
Safety and approval boundaries
- Shell history and process arguments are not safe places for API keys.
- A script must not place calls, send messages, buy numbers, or change configuration without explicit authorization.
- CI automation should use a dedicated revocable credential with only the scopes it needs.
