circleci-cli

This is CircleCI's command-line application.

Documentation | Code of Conduct | Contribution Guidelines |

circleci is CircleCI's official command line tool. It is an agent-friedly CLI that brings CI runs, jobs, configuration, and other CircleCI features to the terminal right where you're already working.

The CLI is supported for users on circleci.com and CircleCI server; with support for macOS, Windows, and Linux.

Installation

The CircleCI CLI is available on the following package managers:

Homebrew (preview):

brew tap circleci-public/homebrew-circleci
brew install circleci@next

Homebrew (stable):

brew install circleci

Snap:

sudo snap install circleci

WinGet:

winget install CircleCI.CLI

Chocolatey:

choco install circleci-cli -y

Setup

Login

Run the following command to login to the CircleCI CLI:

circleci auth login

Model Context Protocol (MCP)

The CLI supports the MCP protocol. To enable it, run:

Claude:

circleci mcp claude enable # Enable in Claude desktop
claude mcp add-from-claude-desktop -s user # Add with current user scope

Cursor:

circleci mcp cursor enable

VS Code:

circleci mcp vscode enable

Development

Local

This repository makes use Task which can be installed (on MacOS) with:

$ brew install go-task/tap/go-task

Most other tools referenced in the Taskfile.yml are managed by the go.mod tool section.

See the full list of available tasks by running task -l, or, see the Taskfile.yml script.

# Run all static checks
task check
# Auto-fix static checks
task fix
# Run all the tests
task test

# Run the quick tests
task test -- -short ./...
# Run the quick tests for one package
task test -- -short ./internal/...

# Format all the code
task fmt
# Apply license headers
task license
# Tidy go.mod
task mod-tidy