README
¶
circleci-cli
This is CircleCI's command-line application.
Documentation | Code of Conduct | Contribution Guidelines |
Installation
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
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 the MCP protocol
claude mcp add-from-claude-desktop -s user # Add for current user
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
Directories
¶
| Path | Synopsis |
|---|---|
|
clikit
module
|
|
|
cmd
|
|
|
circleci
command
|
|
|
internal
|
|
|
apiclient
Package apiclient provides a thin HTTP client for the CircleCI REST API.
|
Package apiclient provides a thin HTTP client for the CircleCI REST API. |
|
artifacts
Package artifacts implements the business logic for fetching and downloading CircleCI job artifacts.
|
Package artifacts implements the business logic for fetching and downloading CircleCI job artifacts. |
|
bulkhead
Package bulkhead runs a slice of work with bounded parallelism.
|
Package bulkhead runs a slice of work with bounded parallelism. |
|
cmd/api
Package api implements the "circleci api" escape-hatch command for making raw authenticated requests to the CircleCI REST API.
|
Package api implements the "circleci api" escape-hatch command for making raw authenticated requests to the CircleCI REST API. |
|
cmd/artifacts
Package artifacts implements the "circleci artifacts" command.
|
Package artifacts implements the "circleci artifacts" command. |
|
cmd/certificate
Package certificate implements the "circleci certificate" command group for managing iOS code signing certificates (.p12 files).
|
Package certificate implements the "circleci certificate" command group for managing iOS code signing certificates (.p12 files). |
|
cmd/completion
Package completion implements the "circleci completion" command group.
|
Package completion implements the "circleci completion" command group. |
|
cmd/config
Package cmdconfig implements the "circleci config" command group, which works with the pipeline configuration file (.circleci/config.yml).
|
Package cmdconfig implements the "circleci config" command group, which works with the pipeline configuration file (.circleci/config.yml). |
|
cmd/context
Package context implements the "circleci context" command group.
|
Package context implements the "circleci context" command group. |
|
cmd/dlc
Package dlc implements the "circleci dlc" command group.
|
Package dlc implements the "circleci dlc" command group. |
|
cmd/envvar
Package envvar implements the "circleci envvar" top-level command, which is the primary user-facing alias for "circleci project envvar".
|
Package envvar implements the "circleci envvar" top-level command, which is the primary user-facing alias for "circleci project envvar". |
|
cmd/namespace
Package namespace implements the "circleci namespace" command group.
|
Package namespace implements the "circleci namespace" command group. |
|
cmd/onboard
Package cmdonboard implements the "circleci onboard" command.
|
Package cmdonboard implements the "circleci onboard" command. |
|
cmd/orb
Package orb implements the "circleci orb" command group.
|
Package orb implements the "circleci orb" command group. |
|
cmd/pipeline
Package pipeline implements the "circleci pipeline" command group.
|
Package pipeline implements the "circleci pipeline" command group. |
|
cmd/policy
Package policy implements the "circleci policy" command group.
|
Package policy implements the "circleci policy" command group. |
|
cmd/project
Package project implements the "circleci project" command group.
|
Package project implements the "circleci project" command group. |
|
cmd/runner
Package runner implements the "circleci runner" command group.
|
Package runner implements the "circleci runner" command group. |
|
cmd/signingconfig
Package signingconfig implements the "circleci signing-config" command group for managing iOS signing configs (a certificate paired with provisioning profiles).
|
Package signingconfig implements the "circleci signing-config" command group for managing iOS signing configs (a certificate paired with provisioning profiles). |
|
cmd/step
Package step implements the "circleci step" command group.
|
Package step implements the "circleci step" command group. |
|
cmd/version
Package version implements the "circleci version" command.
|
Package version implements the "circleci version" command. |
|
cmd/workflow
Package workflow implements the "circleci workflow" command group.
|
Package workflow implements the "circleci workflow" command group. |
|
cmdutil
Package cmdutil provides shared helpers used by command packages.
|
Package cmdutil provides shared helpers used by command packages. |
|
config
Package config manages the CLI's user-level configuration file.
|
Package config manages the CLI's user-level configuration file. |
|
configcmd
Package configcmd contains the business logic for circleci config subcommands.
|
Package configcmd contains the business logic for circleci config subcommands. |
|
configgen
Package configgen renders a CircleCI pipeline YAML from a reposcan.Result and writes it to disk.
|
Package configgen renders a CircleCI pipeline YAML from a reposcan.Result and writes it to disk. |
|
deployinit
Package deployinit implements scanning and patching of .circleci/config.yml to add deploy marker steps for circleci deploy init.
|
Package deployinit implements scanning and patching of .circleci/config.yml to add deploy marker steps for circleci deploy init. |
|
event
Package event contains business logic for trigger-event-level operations.
|
Package event contains business logic for trigger-event-level operations. |
|
extension
Package extension implements the circleci plugin mechanism.
|
Package extension implements the circleci plugin mechanism. |
|
gitremote
Package gitremote resolves the CircleCI project slug for the current working directory.
|
Package gitremote resolves the CircleCI project slug for the current working directory. |
|
httpcl
Package httpcl provides a minimal HTTP client with JSON defaults and retries.
|
Package httpcl provides a minimal HTTP client with JSON defaults and retries. |
|
iossigning
Package iossigning provides helpers for the iOS code signing commands — reading certificate / provisioning-profile files from disk and base64 encoding them for transmission to the CircleCI API.
|
Package iossigning provides helpers for the iOS code signing commands — reading certificate / provisioning-profile files from disk and base64 encoding them for transmission to the CircleCI API. |
|
jq
Package jq facilitates processing of JSON strings using jq expressions.
|
Package jq facilitates processing of JSON strings using jq expressions. |
|
jsoncolor
Package jsoncolor writes ANSI-colorized, indented JSON to an io.Writer.
|
Package jsoncolor writes ANSI-colorized, indented JSON to an io.Writer. |
|
mdtable
Package mdtable builds GitHub-Flavored Markdown tables.
|
Package mdtable builds GitHub-Flavored Markdown tables. |
|
oauth
Package oauth implements the client side of the CircleCI OAuth 2.0 Authorization Code + PKCE flow (RFC 6749 + RFC 7636 + RFC 8252) with Pushed Authorization Requests (RFC 9126).
|
Package oauth implements the client side of the CircleCI OAuth 2.0 Authorization Code + PKCE flow (RFC 6749 + RFC 7636 + RFC 8252) with Pushed Authorization Requests (RFC 9126). |
|
onboarder
Package onboarder orchestrates the local onboarding flow.
|
Package onboarder orchestrates the local onboarding flow. |
|
pack
Package pack merges a directory tree of YAML files into a single YAML document.
|
Package pack merges a directory tree of YAML files into a single YAML document. |
|
projectref
Package projectref reads and writes .circleci/info.yml — the per-checkout file that records which CircleCI project this directory is bound to.
|
Package projectref reads and writes .circleci/info.yml — the per-checkout file that records which CircleCI project this directory is bound to. |
|
reposcan
Package reposcan detects the language stack, container image, and setup commands for a local repository.
|
Package reposcan detects the language stack, container image, and setup commands for a local repository. |
|
testing/binary
Package binary builds the circleci CLI binary once per test run and provides helpers for running it in tests.
|
Package binary builds the circleci CLI binary once per test run and provides helpers for running it in tests. |
|
testing/env
Package env provides a test environment builder for acceptance tests.
|
Package env provides a test environment builder for acceptance tests. |
|
testing/fakes
Package fakes provides fake HTTP servers for acceptance testing.
|
Package fakes provides fake HTTP servers for acceptance testing. |
|
testing/httprecorder
Package httprecorder provides a simple way of recording and later retrieving all requests that are sent to an HTTP handler.
|
Package httprecorder provides a simple way of recording and later retrieving all requests that are sent to an HTTP handler. |
|
testing/httprecorder/chirecorder
Package chirecorder provides a middleware to wire a httprecorder into Chi routers used in test fakes.
|
Package chirecorder provides a middleware to wire a httprecorder into Chi routers used in test fakes. |
|
testing/httprecorder/httpnetrecorder
Package httpnetrecorder provides a middleware to wire a httprecorder into test fakes.
|
Package httpnetrecorder provides a middleware to wire a httprecorder into test fakes. |
|
testrunner
Package testrunner runs the test command detected by reposcan/env-builder.
|
Package testrunner runs the test command detected by reposcan/env-builder. |
Click to show internal directories.
Click to hide internal directories.