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

Command form

ai-draft · 3 tasks · 6 fields

Browse and validate orbs. Config, contexts, policies, runners and local execution are left out.

Opens the form; the finished command lands at your prompt, unrun

Run in Otty

otty gui circleci

`circleci orb list`

List orbs

List orbs in a namespace.

List orbsExample values, fixed in this page — nothing here reaches a terminal

Basic

Namespace

string

Sort by

buildsstring

TasksEach one presets the form for one job

Most used orbs

namespacesort

ParametersOnly these flags are editable in the form

Namespace

Namespace of the orbs, e.g. circleci.
string · positional 0

Sort by

Specify the sorting.
string

--sortbuildsprojectsorgs

Include uncertified

Include uncertified orbs.
boolean

--uncertified-u

Private only

Orbs for private use within your org, unlisted from the public registry.
boolean

--private

`circleci orb info`

Orb info

Show metadata of an orb.

Orb infoExample values, fixed in this page — nothing here reaches a terminal

Basic

Orb*

string

TasksEach one presets the form for one job

Show metadata

orb

ParametersOnly these flags are editable in the form

Orb

namespace/orb, e.g. circleci/node.
string · positional 0

`circleci orb validate`

Validate an orb

Validate an orb.yml.

Validate an orbExample values, fixed in this page — nothing here reaches a terminal

Basic

Orb file*

file

TasksEach one presets the form for one job

Validate

path

ParametersOnly these flags are editable in the form

Orb file

Path to the orb.yml.
path · positional 0

SourcesEvery flag above is checked against these

fig

completion

github.com

fig

completion

github.com

fig

completion

github.com

fig

completion

github.com

Before it fills your prompt, Otty checks the installed circleci against its version. A form that does not match your version is not offered.