rightdesk-cli

rd

CLI for the RightDesk API. The command is rd. Crystal binary, distributed via Homebrew and GitHub Releases.

Install

brew install aluminumio/tap/rd

Or download a binary from Releases.

Grammar

rd <noun> <verb> [target] [flags]

Nouns are plural, verb second, target positional, flags named — e.g. rd deals get 42, rd deals list --status open. The colon form (rd deals:get 42) also works.

rd <noun> with no verb lists that noun's commands. At the terminal:

  • rd list — every registered command.
  • rd <noun> <verb> --help — exhaustive flags for one command.
  • rd skills — condensed guide for LLMs/agents.

Quick start

rd login                 # paste an API token (Organization Settings → API)
rd whoami                # confirm user + org
rd companies list
rd deals list --status open -j | jq -r '.deals[].id'

Commands

Full reference, one page per noun, under docs/:

Noun Commands Docs
auth & session login, logout, whoami, skills auth
contacts list, get, search, create, update, merge contacts
companies list, get, create, update companies
deals list, get (writes on the roadmap) deals
pipelines list, get, create, update, delete pipelines
stages list, create, update, reorder, delete stages
products list, get, create, update, activate, deactivate, delete products
customers list, get, create, update, timeline customers
partners list, get, create, update, timeline partners
leads list, get, create, update, delete, move, qualify, disqualify, convert leads

Destructive verbs (delete, contacts merge) and outward ones (leads convert) require --yes.

Output contract

  • Data on stdout, diagnostics on stderr. Errors never touch stdout.
  • -j/--json emits the raw JSON payload; under --json, errors are structured ({"error","code","hint"}) on stderr.
  • Exit codes: 0 success · 1 general · 2 usage · 3 auth · 4 not found · 5 insufficient scope.

Authentication

RightDesk uses static API tokens (no OAuth device flow). Create one in the web UI under Organization Settings → API, then run rd login and paste it. Tokens are organization-scoped — to switch orgs, mint a token in the other org and login again (this overwrites the local entry). logout clears only the local copy; revoke server-side in the web UI.

Configuration

Flag / Variable Default Purpose
--host <host> / RIGHTDESK_URL https://app.rightdesk.com API host (override for self-hosted or dev)
--token <t> / RIGHTDESK_TOKEN (from ~/.netrc) API token override (prefer the env var; never pass secrets in argv)

Tokens are persisted in ~/.netrc.

Build from source

shards install
shards build --release
./bin/rd --help
Repository

rightdesk-cli

Owner
Statistic
  • 0
  • 0
  • 0
  • 0
  • 2
  • about 1 hour ago
  • September 10, 2026
License

Links
Synced at

Thu, 10 Sep 2026 08:33:07 GMT

Languages
Crystal 100.0%