Skip to content
🌀 CLI client / command line tool for CircleCI
Ruby Shell
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
.github/workflows
bin
exe
lib
movie
spec
.all-contributorsrc
.rubocop.yml
CHANGELOG.md
CODE_OF_CONDUCT.md
Gemfile
Gemfile.lock
Guardfile
LICENSE.txt
README.md
Rakefile
circleci-cli.gemspec

README.md

circleci-cli

All Contributors Gem Version Circle CI Code Climate codecov Libraries.io dependency status for GitHub repo GitHub

Notice: This gem is renamed from circler to circleci-cli on 2019/09/22 circleci-cli is a CLI tool for Circle CI.

sample.gif

Installation

$ gem install circleci-cli

set the CIRCLE_CI_TOKEN environment variable. (optional)

export CIRCLE_CI_TOKEN=your-circle-ci-token

Usage

Commands:
  circleci-cli browse          # open circle ci website
  circleci-cli build           # show build description
  circleci-cli builds          # list builds
  circleci-cli help [COMMAND]  # describe available commands or one specific command
  circleci-cli projects        # list projects
  circleci-cli retry           # retry a build
  circleci-cli version         # show gem version
  circleci-cli watch           # watch a build in real time

Options:
  -p user_name/project   # specify repository
  -b branch              # specify branch name
  -n build_number        # specify build number
  -l last                # get or retry last failed build
  -v verbose             # show all the logs if applied to watch command

Project argument

Project argument will be automatically selected in your directory initialized with git.

Examples

Watch your project

$ circleci-cli watch

Watch your project and show all of the build log

$ circleci-cli watch -v

Show last failed build

$ circleci-cli build --last

Retry last failed build

$ circleci-cli retry --last

Open CircleCI webpage for current project

$ circleci-cli browse

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/unhappychoice/circleci-cli.

License

The gem is available as open source under the terms of the MIT License.

Contributors

Thanks goes to these wonderful people (emoji key):

Yuji Ueki
Yuji Ueki

💻
Matt Brictson
Matt Brictson

💻 ⚠️
Fletcher Fowler
Fletcher Fowler

🐛 🤔 💻

This project follows the all-contributors specification. Contributions of any kind welcome!

You can’t perform that action at this time.