What is it?
Users and teams who wish to work more quickly than the UI allows can use the Woodpecker CLI (Command-Line Interface) as their primary interface. It provides a quick, scriptable, and dependable method for managing campaigns, prospects, inbox processes, and account-level operations via the command line for marketers, operators, developers, and AI agents.
It is simultaneously designed for two realities:
People who must complete tasks fast,
AI agents and automated systems that need a predictable interface that they can use repeatedly and safely.
The Woodpecker CLI transforms Woodpecker from a point-and-click tool into an automation-ready platform.
For what can it be used?
Woodpecker CLI gives users direct access to the workflows that matter most. Teams can list campaigns, create prospects, inspect inbox activity, reply to messages, and manage operational data from the terminal in seconds. Woodpecker CLI also makes it easier for AI tools, such as Claude Code, to use Woodpecker.
In a modern approach to cold email, teams often run multiple campaigns, test messaging more frequently, and coordinate outreach across sales, growth, and operations. Instead of setting up every campaign by hand in the app, the CLI lets you create and manage campaigns faster and more consistently. This is especially helpful for teams that run similar campaigns often, manage multiple client accounts, or want to reduce repetitive manual work.
How do I use it?
Before setting up this integration, ensure you have a Woodpecker account with the API & Integrations add-on enabled. You’ll specifically need the Woodpecker API Key, which you can find in the add-ons section. Make sure you have the Node.js runtime installed on your machine (via a one-line npm command) and that the terminal environment is set up (scripts, CI, or AI agents like Claude Code or OpenAI Codex).
To install CLI, use the following command:
npm install -g @woodpecker.co/cli
The details for installing and using the Woodpecker CLI are also available in the npm registry at this link.
Examples
Below are a few examples of how to use the Woodpecker CLI.
For more detailed examples and explanations, check the Readme page and our API documentation.
#1 Use case: a sales manager wants to spin up a basic email-only campaign directly from the terminal instead of building it manually in the Woodpecker UI.
To create a simple one-step cold email campaign for a new outbound offer, you could use a prompt like this:
woodpecker campaigns create --name "Q2 Outbound Offer"
You should then be asked for the details of this campaign in the terminal, which you can enter directly there.
#2 Use case: getting a list of prospects who replied in a specific campaign.
To get a list of prospects who replied in one campaign:
Connect the CLI to your Woodpecker account using your API key (if you haven't yet).
Find the campaign ID you want to check (or, if you already have it, skip this step).
Run a prospects query for that campaign and filter the results by the REPLIED status.
In practice, the flow looks like this:
woodpecker login
then:
woodpecker campaigns list
to find the campaign ID, and finally, a command such as:
woodpecker prospects list --campaign-id 123456 --status REPLIED
This returns the prospects in that specific campaign whose campaign status is marked as replied, making it easy to review who has responded without manually checking each record.
#3 Use case: getting a list of prospects who haven't received any email in the campaign yet with the ACTIVE status.
If you have already connected the CLI to your Woodpecker account and have the campaign's ID, all you need is to run a query using two filters: contacted=false and status=ACTIVE
woodpecker prospects list --campaign-id 123456 --contacted false --status ACTIVE
This can be useful when you want to review who is queued in a campaign before sending begins, or if you want to export this list of prospects for another campaign.