Skip to content

Latest commit

 

History

History
45 lines (31 loc) · 1.02 KB

getting-started.md

File metadata and controls

45 lines (31 loc) · 1.02 KB

Getting started

Install the CLI

Use Ruby 3.3 or newer and install the gem from RubyGems:

gem install circleci-cli
circleci-cli version

Find your project

Have your CircleCI API token ready and list the projects available to your account:

circleci-cli projects

The CLI uses CIRCLE_CI_TOKEN if set. Otherwise, it prompts for the token without echoing it. Combine the User name and Repository name columns as user/project for the next steps.

Find and inspect a build

Replace user/project with the GitHub project you selected. With --all, the CLI lists builds across branches even when you run it from a Git checkout:

circleci-cli builds -p user/project --all

To narrow the list to one branch, use -b in place of --all:

circleci-cli builds -p user/project -b main

Choose a value from the Number column and pass it to build. The output shows the build steps and includes logs for failed actions when available:

circleci-cli build -p user/project -n 42