circleci

Configure CLI with API token

$ circleci setup

$ circleci config validate

$ circleci local execute --job [build]

$ circleci config process [.circleci/config.yml]

$ circleci project create

$ circleci context list [github] [org-name]

$ circleci orb list

$ circleci namespace info [namespace]

circleci [options] command [arguments]

circleci is the official CLI for CircleCI, enabling local job execution, config validation, pipeline management, and interaction with CircleCI resources from the terminal.
The CLI is particularly useful for validating and processing configuration files before pushing changes, running jobs locally in Docker containers for faster development iteration, and managing orbs, contexts, and project settings. It integrates with the CircleCI API for pipeline and workflow management.
Local execution requires Docker and runs individual jobs in containers that mirror the cloud environment, though some features like caching and workflows are not available locally.

--token token

CircleCI API token

CircleCI host URL

Enable debug output

Skip update check

~/.circleci/cli.yml

CLI configuration including API token and host URL.

Project-level CircleCI pipeline configuration defining jobs, workflows, and orbs.

setup

Configure CLI with API token

Validate config.yml syntax

Process and expand config

Run jobs locally

Manage projects

Manage contexts and environment variables

Manage orbs

Manage namespaces

Manage pipelines

Show version

Local execution runs single jobs only, not workflows. Caching not supported locally. Some CircleCI features require cloud execution.

docker(1), git(1)