Skip to main content

Woodpecker CLI

The Woodpecker CLI brings your Woodpecker workspace to the terminal. It is useful when you want to check something quickly, automate a repeated task, or give an AI coding agent a clean way to work with Woodpecker from the shell.

Command-line tools are a natural fit for API work: they are fast, scriptable and easy for tools like Codex or Claude Code to run. Use this section to get started, then use the npm package page when you need the full command reference.

What you can do​

Use the CLI to inspect and manage Woodpecker from your terminal, without clicking through the app for every check or operation.

Common areas include:

  • managing account data such as campaigns, prospects, inbox messages, mailboxes, reports, webhooks, blacklists and agency resources
  • human-readable terminal output for manual checks
  • JSON output for scripts, CI jobs and AI agents
  • interactive selectors and prompts when running in a terminal
  • raw API requests when you need to call a Woodpecker endpoint directly

Prerequisites​

Before using the CLI, make sure you have:

  • a Woodpecker account with API access enabled and an API key from the add-ons section
  • Node.js 22 LTS, which is the recommended version

For the exact supported Node.js range, installation details, command list, flags and behavior notes, see the npm package README.

Next steps​

Start with installation and setup, then try examples & tips for manual checks, recurring scripts and AI-agent workflows.

For complete command syntax, flags, output modes, security notes, retry behavior and shell completion, use the npm package README.