The bump-cli gem provides a simple command line access to the Bump (https://bump.sh) API.
Add this line to your application's Gemfile:
gem 'bump-cli'And then execute:
$ bundle
Or install it yourself as:
$ gem install bump-cli
By default, bump-cli considers files as yaml ones. If you work with JSON definitions, you need to specify the format for all the commands using --format json.
The doc id and token used below can be found in your documentation settings page on https://bump.sh. Note that you can replace the options by environments variables: --id can be replaced by BUMP_ID, and --token can by replaced by BUMP_TOKEN. This is useful to keep your private token secret.
You can preview your documentation by calling the preview command. A temporary preview will be created, with a unique URL. This preview will be available for 30 minutes. You don't need any credentials to use this command.
$ bundle exec bump preview path/to/your/openapi.yml
Validate your file against the OpenApi specification.
$ bundle exec bump validate path/to/your/openapi.yml --id DOC_ID --token DOC_TOKEN
Deploy the file as the current version of the documentation.
$ bundle exec bump deploy path/to/your/openapi.yml --id DOC_ID --token DOC_TOKEN
After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.
Bug reports and pull requests are welcome on GitHub at https://github.com/bump-sh/bump-cli. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
The gem is available as open source under the terms of the MIT License.
Everyone interacting in the Bump::CLI project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.