All apps/CircleCI CLI

CircleCI CLI

circleci

CircleCI's official command line tool, bringing CI runs, jobs, configuration and other CircleCI features to the terminal.

Runs as circleci|macOS, Linux, Windows|cli.circleci.com

Open form in Otty otty.toml

Autocomplete

Fig spec, with what the manifest adds · 53 subcommands · 2 options

Published once and never changed; check the digest before caching

sha256

ae1cc025f63e7232be1ddbd0e33798b3f6b0f25715b996f7be076e15f222b2f1

Size

22139 bytes

Subcommands53 subcommands

circleci completion

Generate shell completion scripts

circleci completion bash

Generate bash completion scripts

circleci completion zsh

Generate zsh completion scripts

circleci config

Operate on build config files

circleci config pack

Pack CircleCI config files into a single file

circleci config process

Validate and display extended config

circleci config validate

Checks that config is valid

circleci context

Secure and share environment variables across projects

circleci context create

Create a new context

circleci context delete

Delete the named context

circleci context list

List all contexts

circleci context remove-secret

Remove environment variable from a context

circleci context show

Show a context

circleci context store-secret

Store environment variables

circleci diagnostic

Check the status of your CircleCI CLI

circleci follow

Attempt to follow the project for the current git repo

circleci help

Help about any command

circleci local

Debug jobs on the local machine

circleci local execute

Run a job in a container on the local machine

circleci namespace

Operate on namespaces

circleci namespace create

Create a namespace

circleci open

Open the current project in the browser

circleci orb

Operate on orbs

circleci orb add-to-category

Add an orb to a category

circleci orb create

Create an orb in a namespace

circleci orb info

Show metadata of an orb

circleci orb init

Initialize a new orb

circleci orb list

List orbs

circleci orb list-categories

List orb categories

circleci orb pack

Pack an orb with local scripts

circleci orb process

Validate an orb and print its form after all pre-registration processing is complete

circleci orb publish

Publish an orb to the registry

circleci orb remove-from-category

Remove an orb from a category

circleci orb source

Show source code of an orb

circleci orb unlist

Disable/enable an orb's listing in the registry

circleci orb validate

Validate an orb.yml

circleci policy

Manage security policies

circleci policy decide

Make a decision

circleci policy diff

Get diff between local and remote policy bundles

circleci policy eval

Perform raw opa evaluation locally

circleci policy fetch

Fetch policy bundle (or a single policy)

circleci policy logs

Get policy decision logs / decision log (or policy bundle) by decision ID

circleci policy push

Push policy bundle (or a single policy)

circleci policy settings

Get/set policy decision settings (To read settings: run command without any settings flags)

circleci runner

Operate on runners

circleci runner instance

Operate on runner instances

circleci runner resource-class

Operate on runner resource-classes

circleci runner token

Operate on runner tokens

circleci setup

Setup CLI with your credentials

circleci update

Update and switch to new CLI version

circleci update check

Check for new CLI version

circleci update install

Install new CLI version

circleci version

Display CircleCI CLI version

OptionsOn circleci itself

--help-h

Show help for CircleCI

--skip-update-check

Skip update check before every command