https://github.com/oliverswitzer/circle_ci_workflows
A CLI gem that allows you to view workflows and be notified of their completion from the terminal
https://github.com/oliverswitzer/circle_ci_workflows
Last synced: about 2 months ago
JSON representation
A CLI gem that allows you to view workflows and be notified of their completion from the terminal
- Host: GitHub
- URL: https://github.com/oliverswitzer/circle_ci_workflows
- Owner: oliverswitzer
- License: mit
- Created: 2018-11-30T16:55:28.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-11-30T23:21:40.000Z (over 6 years ago)
- Last Synced: 2025-02-15T20:24:13.660Z (3 months ago)
- Language: Ruby
- Homepage:
- Size: 16.6 KB
- Stars: 2
- Watchers: 7
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# CircleCli
## Installation
This gem is not yet published to RubyGems. To add it as a dependency, add this line to your application's Gemfile:
```ruby
gem 'circle-cli', git: 'https://github.com/kickstarter/circle-cli'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install circle-cli
## Usage
Setup:
1. Generate a CircleCI token: https://circleci.com/account/api
2. Store it as an environment variable `export CIRCLE_CI_TOKEN=`, or pass it in as an option `--token`
Usage:
$ bundle exec circlecli --token
## Development
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb` and push to github.
For now, this gem will remain in this github repository. Once it has been battle tested, we may consider publishing it to RubyGems. To do this, we would run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Acknowledgements
Huge thanks to Philippe Creux (@pcreux) for doing all the initial groundwork getting this CLI working!
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/kickstarter/circle-cli. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the CircleCli project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/circle-cli/blob/master/CODE_OF_CONDUCT.md).