The Bump.sh CLI is used to interact with your API documentation or hubs hosted on Bump.sh. With any API definition of your choice (from Swagger, OpenAPI or AsyncAPI), it can help you to:
- Validate an API document before publishing it to your documentation
- Publish an API document to your Bump.sh documentation or hubs
- Compare two API documents to generate a human-readable diff from your API definitions
Under the hood, it uses the API of developers.bump.sh. And is built with the oclif framework in Typescript.
The Bump.sh CLI is a node package currently distributed via NPM. This means you must have the Node v14+ interpreter installed on your computer or CI servers.
If you are looking to use Bump.sh in a continuous integration environment you might be interested by our Github Action.
You can download a standalone package directly from the latest GitHub release assets if you don’t use Node. {: .info}
To install it globally, run the following command with NPM
npm install -g bump-cliOr, with Yarn via
yarn global add bump-cliAs our CLI is a node package, you can easily embed it into your project by adding the package to your package.json file, either with NPM
npm install --save-dev bump-cliOr with Yarn via
yarn add --dev bump-cliYou can then use any Bump.sh commands with npx (same as npm exec)
npx bump --helpUnfortunately, at the moment we only support the Node environment. However, you can download a standalone package directly from the latest Github release assets which you can run as a standalone binary. Or you can push your documentation using our API (advanced usage only).
To list all the available commands, just type bump in your command line environment.
$ bump --help
The Bump.sh CLI is used to interact with your API documentation hosted on Bump.sh by using the API of developers.bump.sh
VERSION
bump-cli/2.8.0 linux-x64 node-v16.19.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.
overlay Apply an OpenAPI specified overlay to your API definition.
preview Create a documentation preview from the given file or URL.You can also get some help anytime by adding --help to any command. Example: bump deploy --help.
While some commands don't need any API token (preview or diff) you will need an access key if you want to interact with your Bump.sh documentation.
Head over to your Documentation settings in the “CI deployment” section or your Account or Organization settings in the “API keys” section to fetch a personal token for later usage.
bump deploy [FILE]bump diff [FILE]bump preview [FILE]bump overlay [DEFINITION_FILE] [OVERLAY_FILE]
When you update your API, you also want its documentation to be up to date for your API users. This is what the deploy command is for.
bump deploy path/to/api-document.yml --doc my-documentation --token $DOC_TOKENYou can find your own
my-documentationslug and$DOC_TOKENapi key from your documentation settings. {: .info}
You can also deploy a given API document to a different branch of your documentation with the --branch <branch-name> parameter. Please note the branch will be created if it doesn’t exist. More details about the branching feature are available on this dedicated help page. E.g. deploy the API document to the staging branch of the documentation:
bump deploy path/to/api-document.yml --doc my-documentation --token $DOC_TOKEN --branch stagingIf you already have a hub in your Bump.sh account, you can automatically create documentation and deploy it into that hub by publishing a whole directory containing multiple API documents in a single command:
bump deploy dir/path/to/apis/ --auto-create --hub my-hub --token $HUB_TOKENYou can find your own
my-hubslug and$HUB_TOKENapi key from your hub settings. {: .info}
Please note, by default, only files named {slug}-api.[format] are published. Where {slug} is a name for your API and [format] is either yaml or json. Adjust to your file naming convention using the --filename-pattern <pattern> option.
Note that it can include * wildcard special character, but must include the {slug} filter to extract your documentation’s slug from the filename. The pattern can also have any other optional fixed characters.
Here’s a practical example. Let's assume that you have the following files in your path/to/apis/ directory:
path/to/apis
└─ private-api-users-service.json
└─ partner-api-payments-service.yml
└─ public-api-contracts-service.yml
└─ data.json
└─ README.md
In order to deploy the 3 services API definition files from this folder (private-api-users-service.json, partner-api-payments-service.yml and public-api-contracts-service.yml), you can execute the following command:
bump deploy path/to/apis/ --hub my-hub --filename-pattern '*-api-{slug}-service'
Simulate your API document's deployment to ensure it is valid by adding the --dry-run flag to the deploy command. It is handy in a Continuous Integration environment running a test deployment outside your main branch:
bump deploy path/to/api-document.yml --dry-run --doc my-documentation --token $DOC_TOKENPlease check bump deploy --help for more usage details.
If you want to receive automatic bump diff results on your Github Pull Requests you might be interested by our Github Action diff command.
Please note that by default the command will always exit with a
successful return code. If you want to use this command in a CI
environment and want the command to fail in case of a breaking
change, you will need to add the --fail-on-breaking flag to your
diff command.
From any two API documents 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: energieYou can create as many diffs as you like without being authenticated. This is a free and unlimited service provided as long as you use the service fairly. {: .info}
Note: You can also test this feature in our dedicated web application at https://api-diff.io/.
From an existing Bump.sh documentation, the diff command will retrieve a comparison changelog between your latest published documentation and the given file or URL:
bump diff path/to/your/file.yml --doc my-documentation --token $DOC_TOKENIf you want to compare two unpublished versions of your API document, 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 my-documentation --token $DOC_TOKENPlease check bump diff --help for full usage details.
When writing documentation, you might want to preview how it renders on Bump.sh. This is precisely the goal of the preview command: it will create temporary documentation with a unique URL, which will be available for a short period (30 minutes).
Usage from a local OpenAPI or AsyncAPI file
bump preview path/to/file.jsonYou can also preview a file available from a URL
bump preview https://developers.bump.sh/source.yamlBy using the --live flag you can stay focused on API design (OpenAPI or AsyncAPI file) while seeing a continuously updated preview each time you save your API document.
- Launch the live preview command in your terminal
bump preview --live --open openapi-definition.json- Edit your
openapi-definition.jsonfile in your favorite text editor - Watch the live preview being updated each time you save your file.
You can create as many previews as you like without being authenticated. This is a free and unlimited service. {: .info}
Note: the additional --open flag helps to automatically open the preview URL in your browser.
Please check bump preview --help for more usage details
This feature implements the OpenAPI Overlay specification. It is possible to apply an Overlay to any kind of document, be it an OpenAPI or AsyncAPI definition file.
The Overlay specification of OpenAPI makes it possible to modify the content of an API definition file by adding a layer on top of it. That layer helps add, remove, or change some or all of the content of the original definition.
Technically, the bump overlay command will output a modified version of the [DEFINITION_FILE] (an OpenAPI or AsyncAPI document) by applying the operations described in the [OVERLAY_FILE] Overlay file to the original API document.
To redirect the output of the command to a new file you can run the following:
bump overlay api-document.yaml overlay-file.yaml > api-overlayed-document.yamlNote: you can also apply the overlay during the bump deploy command with the new --overlay flag:
bump deploy api-document.yaml --doc my-doc --token my-token --overlay overlay-file.yaml 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
We currently support OpenAPI from 2.0 (called Swagger) to 3.1 and AsyncAPI 2.x specification file types. Both YAML and JSON file formats are accepted file inputs to the CLI.
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.
The Bump CLI project is released under the MIT License.
Everyone interacting in the Bump-CLI project codebases, issue trackers, chat rooms, and mailing lists is expected to follow the code of conduct.
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, which makes it clear we are working on our second version of the Bump CLI
-
The
bump-clipackage 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-clipackage. A big thanks to Rico for transferring the ownership of thebump-clipackage name!