CI/CD
CircleCI CLI
CircleCI CLI commands for pipeline management.
26 commands
Windows
MacOS
Linux
#automation
#pipeline
Setup
Configure CLI with API token
circleci setup
Update the CLI to latest version
circleci update
Show CLI version
circleci version
Create a context
circleci context create gh org ctx
List contexts for an organization
circleci context list gh org
Configuration
Validate .circleci/config.yml
circleci config validate
Process and expand config
circleci config process .circleci/config.yml
Validate a specific config file
circleci config validate .circleci/config.yml
Pack a config from directory
circleci config pack src/
Orbs
List orbs by namespace
circleci orb list circleci
Show orb details
circleci orb info circleci/node
View orb source code
circleci orb source circleci/node
Validate an orb definition
circleci orb validate orb.yml
Publish orb to dev tag
circleci orb publish orb.yml ns/orb@dev:test
Promote dev orb to production
circleci orb publish promote ns/orb@dev:test patch
Local Execution
Run a job locally in Docker
circleci local execute --job build
Run test job locally
circleci local execute --job test
Run with environment variable
circleci local execute --job build -e MY_VAR=value
Run with SSH key
circleci local execute --job build --checkout-key ~/.ssh/id_rsa
Diagnostics
Check CLI configuration and connectivity
circleci diagnostic
List namespaces for organization
circleci namespace list gh org
Follow a project for build notifications
circleci follow
Open project in browser
circleci open
Quick Commands
Validate the CircleCI configuration file
circleci config validate
Run a job locally in Docker
circleci local execute --job build
List available orbs by namespace
circleci orb list circleci