Commands Cheat Sheet

Evaluating engineering tools? Get the comparison in Google Sheets

(Perfect for making buy/build decisions or internal reviews.)

Most-used commands
Your email is safe thing.

Thankyou for your submission

We have sent the cheatsheet on your email!
Oops! Something went wrong while submitting the form.

Setup & Configuration

circleci setup
Initial setup and configuration of CircleCI CLI

circleci update
Update the CircleCI CLI

circleci version
Display the current version of CircleCI CLI

Project Management

circleci init
Initialize a CircleCI project

circleci config validate
Validate the CircleCI config file

circleci config process .circleci/config.yml
Process and validate the config file with parameter expansion

Local Execution

circleci local execute
Run a job locally

circleci local execute --job JOB_NAME
Run a specific job locally

Pipeline and Workflow Management

circleci pipeline list
List recent pipelines

circleci pipeline get PIPELINE_ID
Get details about a pipeline

circleci workflow list PIPELINE_ID
List workflows for a pipeline

circleci workflow get WORKFLOW_ID
Get details about a workflow

Jobs and Builds

circleci job list WORKFLOW_ID
List jobs in a workflow

circleci job get JOB_NUMBER
Get details about a specific job

circleci job artifacts JOB_NUMBER
List artifacts for a job

Context and Environment Variables

circleci context list
List contexts

circleci context create CONTEXT_NAME
Create a new context

circleci context delete CONTEXT_NAME
Delete a context

circleci context show CONTEXT_NAME
Show details of a context

circleci context store-secret CONTEXT_NAME KEY
Store a secret in a context

Orbs

circleci orb list
List available orbs

circleci orb info ORB_NAME
Get details about an orb

circleci orb validate ORB_PATH
Validate an orb

Debugging

circleci diagnostic
Check system diagnostic information

circleci help
Show help for CircleCI CLI commands