circleci-cli

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

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 💻

Matt Brictson 💻 ⚠️

Fletcher Fowler 🐛 🤔 💻

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