Command line tools for CircleCI
Switch branches/tags
Clone or download

README.md

Circle CLI

Command line tools for Circle CI

Gem Version CircleCI Status Dependency Status Code Climate Test Coverage

circle-cli demo

Installation

$ gem install circle-cli

Setup

  1. Install Circle-CLI
$ gem install circle-cli
  1. Add your CircleCI token
$ circle token <your token>

Usage

  • Get the CI status for the HEAD of your current branch

    $ circle
    
  • Start a new CI build for the HEAD of your current branch

    $ circle build
    
  • Watch the most recent CI build for your current branch

    $ circle --watch
    
  • Cancel the most recent CI build for your current branch

    $ circle cancel
    
  • Open the results page for the latest CI run

    $ circle open
    
  • For additional help

    $ circle help
    

Contributing

  1. Fork it ( http://github.com/circle-cli/circle-cli/fork )
  2. Create your feature branch with your initials (git checkout -b dsk/my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request