browse
circleci/

CircleCI CLI

CircleCI

Command line interface for CircleCI continuous integration configuration and local execution.

CI/CD & Source ControlJSON
01Install
brew install circleci
Download binary →

02Agent Notes

circleci CLI is primarily for config validation and local execution. `circleci config validate` to check .circleci/config.yml. `circleci local execute` for local runs. `circleci orb` for orb management. Use `--json` where available for structured output. Not all commands support JSON output.


03Global Flags
FlagTypeDescription
--hoststringCircleCI host URL
--tokenstringAPI token for authentication

04Authentication
Methods
access-token
Env vars
CIRCLECI_CLI_TOKEN
Setupcircleci setup

05Capabilities
Reference
binarycircleci
checkcircleci version
authaccess-token
formatstext
json flag--json
version0.1.34770