bump-cli

Bump cli

Help | Sign up

The Bump CLI is used to interact with your API documentation hosted on Bump by using the API of developers.bump.sh. It is built with oclif in Typescript.

Table of contents

• Installation
• Usage
• Commands
• Development
• Contributing
• Versioning

Installation

Bump is installed via npm. Run this command to install it for local use:

npm install -g bump-cli

If you are looking to use Bump in a continuous integration environment you might be interested by our Github Action.

How should I do if I'm not using npm ?

Unfortunately, at the moment we only publish a npm package. However we plan to distribute universal binaries in the most common package managers soon.

Usage

$ npm install -g bump-cli

$ bump --help
The Bump CLI is used to interact with your API documentation hosted on Bump by using the API of developers.bump.sh

VERSION
  bump-cli/2.5.0 linux-x64 node-v16.14.0

USAGE
  $ bump [COMMAND]

COMMANDS
  deploy   Create a new version of your documentation from the given file or URL.
  diff     Get a comparison diff with your documentation from the given file or URL.
  help     Display help for bump.
  preview  Create a documentation preview from the given file or URL.

Please check the Bump CLI help page for more CLI usage details.

Commands

• bump preview [FILE]
• bump deploy [FILE]
• bump diff [FILE]

bump preview [FILE]

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. Here is an example usage:

$ bump preview https://bit.ly/asyncapi
* Let's render a preview on Bump... done
* Your preview is visible at: https://bump.sh/preview/c192dad0-79d7-44b3-b5e1-244b69f618e4 (Expires at 2021-06-28T18:06:56+02:00)

Note: you can use the --open flag to open the preview URL in your browser directly.

Note2: you can use the --live flag to watch changes of the input FILE. This is very helpful when writing your api definition as you will see a live preview being refreshed at each file save.

Please check bump preview --help for more usage details

bump deploy [FILE]

Deploy the definition file as the current version of the documentation with the following command:

$ bump deploy path/to/your/file.yml --doc DOC_ID_OR_SLUG --token DOC_TOKEN

Deploy the definition file to the staging branch of the documentation:

$ bump deploy path/to/your/file.yml --doc DOC_ID_OR_SLUG --token DOC_TOKEN --branch staging

If you already have a hub in your Bump.sh account, you can automatically create a documentation inside it and deploy to it with:

$ bump deploy path/to/your/file.yml --auto-create --doc DOC_SLUG --hub HUB_ID_OR_SLUG --token HUB_TOKEN

Within a Hub, you can also deploy a whole directory containing multiple API definitions in a single command:

$ bump deploy path/to/your/apis/ --auto-create --hub HUB_ID_OR_SLUG --token HUB_TOKEN

Simulate a deployment of your definition file to make sure it is valid with the --dry-run flag, it is particularly useful in a Continuous Integration environment running a test deployment outside your main branch:

$ bump deploy path/to/your/file.yml --dry-run --doc DOC_ID_OR_SLUG --token DOC_TOKEN

Please check bump deploy --help for more usage details

bump diff [FILE]

If you want to receive automatic bump diff results on your Github Pull Requests you might be interested by our Github Action diff command.

Public API diffs

From any two definition files or URLs, you can retrieve a comprehensive changelog of what has changed between them.

$ bump diff path/to/your/file.yml path/to/your/second_file.yml
* Comparing the two given definition files... done
Modified: GET /consommations
  Response modified: 200
    [Breaking] Body attribute modified: energie

Or from two URLs:

$ bump diff https://demo.bump.sh/doc/trips-books/changes/bfec0a43-b870-44da-9e07-60c8955e15d5.json https://demo.bump.sh/doc/trips-books.json
* Comparing the two given definition files... done
Modified: POST /books
  Response modified: 200
    [Breaking] Body attribute removed: cent

Note: You can also test this feature in our dedicated web application at https://api-diff.io/.

Authenticated diffs attached to your Bump documentation

From a Bump documentation, the diff command will retrieve a comparison changelog between your existing documentation and the given file or URL:

$ bump diff path/to/your/file.yml --doc DOC_ID_OR_SLUG --token DOC_TOKEN
* Comparing the given definition file with the currently deployed one... done

Updated: POST /validations
  Body attribute modified: documentation

If you want to compare two unpublished versions of your definition file, the diff command can retrieve a comparison changelog between two given file or URL, “as simple as git diff”:

$ bump diff path/to/your/file.yml path/to/your/next-file.yml --doc <doc_slug> --token <your_doc_token>
* Comparing the two given definition files... done

Updated: POST /versions
  Body attribute added: previous_version_id

Please check bump diff --help for full usage details.

Development

Make sure to have Node.js (At least v14) installed on your machine.

• Install node dependencies with

  $ npm install
  

• Compile the Typescript code

  $ npm run build
  $ npm run clean # to remove build artifacts
  

• Format the codebase to comply with the linter rules

  $ npm run fmt
  

• Run the test suites

  $ npm run test
  $ npm run test-coverage # Run tests with coverage
  

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/bump-sh/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.

License

The node package is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Bump-CLI project codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

Versioning

This npm package starts at v2.0.0 for two main reasons:

• Our first version of the Bump CLI was written in Ruby, starting at v2.0.0 makes it clear we are working on our second version of the Bump CLI

• The bump-cli package used to be owned by Rico which already published v1.x packages. If you are looking for the old npm package please head to @rstacruz/bump-cli package. A big thanks to Rico for transfering the ownership of the bump-cli package name!