For agents and developers

Your CRM, from the command line.

ZergDesk supports sales, fundraising and custom pipelines. Work with accounts, people, deals, activities, tasks and decks through the first-party CLI and HTTP API. Installation, documentation and the agent skill are public. Access to workspace data requires a scoped token.

Install the CLI Read the agent skill

1. Install

Download a versioned release

Use Node.js 22.19 or later and npm. Both zergdesk and zdesk run the same client.

npm install -g https://zergdesk.com/downloads/cli/zergai-zergdesk-0.5.0.tgz
zdesk --version
zdesk --help
zdesk health --base-url https://zergdesk.com

The CLI is available directly from this site. The release manifest includes the current version, download URL and checksum. Pin the version for repeatable agent runs.

2. Authorize

Connect a workspace securely

Have the workspace member sign in with Zerg SSO, then open Account → API tokens.
Create a token for the intended workspace, optionally bind it to one project, and choose its scopes and expiry. Start with workspace:read and crm:read. Add write scopes only for the work the agent will perform.
Put the token in the agent’s secret manager or a private file with permissions 0600. Never paste tokens into chat, put them in a URL, or pass the literal secret as a command argument.

# Supply ZDESK_API_TOKEN through your secret manager.
export ZDESK_BASE_URL=https://zergdesk.com
zdesk auth configure --profile crm-agent
zdesk whoami --profile crm-agent
zdesk workspaces list --profile crm-agent

# Alternatively, import a private token file:
zdesk auth configure --profile crm-agent --token-file /private/path/desk-token.json

Tokens inherit the member’s access. A project-bound token stays within that project, and workspace administration requires its own scope. Revoke the token from Account when the agent no longer needs access.

3. Explore and automate

Discover context before making changes

Select the workspace slug and a project ID returned by projects list. Read capacity and export the CRM before an import. Commands return JSON for agent workflows.

export ZDESK_PROFILE=crm-agent
export ZDESK_WORKSPACE=your-workspace-slug
zdesk workspaces get
zdesk projects list
export ZDESK_PROJECT_ID=your-project-id
zdesk firms list --search acme --field name
zdesk opportunities list
zdesk activities list
zdesk tasks list
zdesk crm export --include-sales --output crm-backup.json
zdesk routes

The CLI guide covers imports, deck uploads, attachments, merge previews and low-level API access. The API guide describes the supported token surface and permissions. Review proposed changes before applying a bulk write or merge.