https://github.com/circleci-tools/circleci-cli

:cyclone: CLI client / command line tool for CircleCI
https://github.com/circleci-tools/circleci-cli

circle-ci circleci circler cli command-line command-line-tools gem pusher ruby websocket

Last synced: 13 days ago
JSON representation

:cyclone: CLI client / command line tool for CircleCI

• Host: GitHub
• URL: https://github.com/circleci-tools/circleci-cli
• Owner: circleci-tools
• License: mit
• Created: 2016-01-10T04:31:58.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2024-05-22T09:08:27.000Z (6 months ago)
• Last Synced: 2024-05-22T10:33:57.158Z (6 months ago)
• Topics: circle-ci, circleci, circler, cli, command-line, command-line-tools, gem, pusher, ruby, websocket
• Language: Ruby
• Homepage:
• Size: 9.01 MB
• Stars: 86
• Watchers: 5
• Forks: 7
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# circleci-cli

[![All Contributors](https://img.shields.io/badge/all_contributors-3-orange.svg?style=flat-square)](#contributors-)

[![Gem Version](https://badge.fury.io/rb/circleci-cli.svg)](https://badge.fury.io/rb/circleci-cli)

[![Code Climate](https://codeclimate.com/github/circleci-tools/circleci-cli/badges/gpa.svg)](https://codeclimate.com/github/circleci-tools/circleci-cli)

[![codecov](https://codecov.io/gh/circleci-tools/circleci-cli/branch/master/graph/badge.svg)](https://codecov.io/gh/circleci-tools/circleci-cli)

[![Libraries.io dependency status for GitHub repo](https://img.shields.io/librariesio/github/circleci-tools/circleci-cli.svg)](https://libraries.io/github/circleci-tools/circleci-cli)

![](http://ruby-gem-downloads-badge.herokuapp.com/circleci-cli?type=total)

![GitHub](https://img.shields.io/github/license/circleci-tools/circleci-cli.svg)

circleci-cli is a CLI tool for [Circle CI](https://circleci.com).

![sample.gif](https://github.com/circleci-tools/circleci-cli/raw/master/movie/rec.gif)

## Installation

```sh

$ gem install circleci-cli

```

set the `CIRCLE_CI_TOKEN` environment variable. (optional)

```sh

export CIRCLE_CI_TOKEN=your-circle-ci-token

```

## Usage

```

Commands:

  circleci-cli browse               # Open CircleCI website

  circleci-cli build                # Show the build result

  circleci-cli builds               # List builds

  circleci-cli cancel               # Cancel a build

  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 builds in real time

Options:

  -p user_name/project              # Specify repository

                                    # Default to the Git remote of current directory

  -b branch                         # Specify branch name

                                    # Default to the current Git branch

  -a, --all, --no-all               # Ignore the branch option and stop being filtered by the branch

                                    # Default to false

  -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.

  --pretty=true/false, --no-pretty  # Make outputs pretty or not

                                    # Default to true

```

### 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/circleci-tools/circleci-cli.

## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

  

    
Yuji Ueki
💻

    
Matt Brictson
💻 ⚠️

    
Fletcher Fowler
🐛 🤔 💻

    
Marco Costa
🤔 💻

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!