
Last updated:
Introducing the OutboundSync CLI
OutboundSync now has a command-line interface. Install it once, and you can check sync health, retry failed syncs, and manage webhooks from a terminal, a cron job, or a coding agent.
npm i -g outboundsyncexport OUTBOUNDSYNC_API_KEY=osapi_your_key_hereoutboundsync account statusWhy a CLI
The OutboundSync API already gives you syncs, sources, destinations, block lists, and webhooks. But every REST call means writing the auth header, following pagination cursors, and parsing errors yourself.
The CLI handles that part. Each command calls one API v1 route with your key and prints JSON, so the output goes straight into jq, a log file, or an agent’s context.
What you can do with it
Find what failed in the last day:
outboundsync syncs list --since 24h --status errorRetry one sync after you fix the cause, then retry the rest of that source’s errors from the last 30 days (once per source per day):
outboundsync syncs retry 1001 --yesoutboundsync sources retry-syncs 42 --yesPull every failed webhook delivery from the last week:
outboundsync destinations deliveries 3 --since 7d --status error --all --jsonLook up prior outreach for a whole list of contacts:
outboundsync contacts outreach --file contacts.csv --json > outreach.jsonlThere are commands for block lists (pause and resync) and Sync Monitoring webhooks (create, test, replay, and rotate secrets) too. The command reference lists all of them.
How it works
One key for everything. The CLI uses the same API keys as REST and MCP. Create one under Platform access → API keys and export it. outboundsync me shows the key’s scopes. There’s no login step, and the CLI never stores or prints your key.
Nothing changes without --yes. Every command that changes something exits without calling the API unless you pass --yes, and it tells you what it would have done. Check the target, then add the flag. Write commands also need a key with the write scope; dashboard keys are read-only.
Exit codes you can branch on. Results go to stdout and errors to stderr. A bad key exits 2, a missing scope or plan feature 3, a rate limit 4, and server trouble 5. The CLI retries a short rate limit or a failed read once, and never retries a write.
Built for agents
I think this is the part that matters most. Claude Code, Cursor, and Codex already run shell commands. Give one the CLI and an API key, and you can ask something like:
Check my OutboundSync syncs from the last 24 hours, group the failures by error, and tell me which ones are safe to retry.
The CLI is set up so that goes well:
outboundsync metells the agent up front which commands its key allows.- Running a write without
--yesis a dry run, so the agent can show you exactly what it’s about to change before it does. npx outboundsync@<version>pins an exact release for repeatable runs.- Every release ships
commands.json, a machine-readable list of every command, flag, and API route, including which ones write.
CLI, MCP, or API?
- CLI for terminals, shell scripts, cron and CI jobs, and agents that run shell commands.
- MCP for agents that call OutboundSync tools directly.
- API for your own code and low-code HTTP modules.
- Agent Skills for guided workflows like launch preflight and sync monitoring.
All four use the same keys and the same API v1 routes, so you can mix them.
Available now
The CLI is in beta. It’s open source on GitHub and published to npm as outboundsync. It needs Node.js 20 or newer and has no runtime dependencies.
Start with the CLI docs. The command reference there is generated from the CLI itself, so it always matches the version on npm.
Want a command we don’t have yet? Get in touch or open an issue on GitHub.

Founder & President, OutboundSync
15+ years in B2B sales and operations. Former HubSpot Solutions Partner and Smartlead expert. Built the agency that became OutboundSync.
Similar posts
Retry a month of failed HubSpot and Salesforce syncs
Retry recorded HubSpot and Salesforce errors from the last 30 days. Confirm one sync, then retry that source. Older events still go to support.
Harris Kenny
Skip free email domains in your CRM
OutboundSync can now skip Gmail, Yahoo, AOL, and 4,700+ other free email domains when it matches or creates companies in HubSpot, Salesforce, Close, and Attio.
Harris Kenny
Use Smartlead Manual Step events in your CRM
OutboundSync now supports Smartlead's Manual Step Reached event. When a prospect reaches a manual step in a campaign, OutboundSync writes it to your CRM.
Harris Kenny


