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.0.0 linux-x64 node-v15.12.0

USAGE
  $ bump [COMMAND]

COMMANDS
  deploy   create a new version of your documentation from the given file or URL
  help     display help for bump
  preview  create a documentation preview from the given file or URL

Commands

• bump preview [FILE]
• bump deploy [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.

USAGE
  $ bump preview FILE

ARGUMENTS
  FILE  Path or URL to your API documentation file. OpenAPI (2.0 to 3.1.0) and AsyncAPI (2.0)
        specifications are currently supported.

EXAMPLE
  $ bump preview my-api-file.json
  * Your preview is visible at: https://bump.sh/preview/45807371-9a32-48a7-b6e4-1cb7088b5b9b

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

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

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

Development

Make sure to have Node.js (At least v10) 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/bump-node-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!