Bump CLI
<p align="center" <img width="20%" src="https://bump.sh/icon-default-maskable-large.png" / </p
<p align="center" <a href="https://docs.bump.sh/help"Help</a | <a href="https://bump.sh/users/signup"Sign up</a </p
The Bump.sh CLI is used to interact with API documentation, hubs and workflows hosted on Bump.sh from your choice of popular API description formats: OpenAPI, Swagger, or AsyncAPI for API documentation. Flower or Arazzo for API workflows.
Using OpenAPI (v3.x and v2.0) or AsyncAPI (2.x), you can do any of the following:
- Validate an API document before publishing 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 definition.
Under the hood, it uses the workspace API of developers.bump.sh. And is built with the oclif framework in Typescript.
Using Flower or Arazzo, you can:
- Deploy a workflow document to your Bump.sh MCP server
Have fun designing APIs ✨.
Table of contents
- Installation
- Usage
- Commands
- Development
- Contributing
- Versioning
Installation
The Bump.sh CLI is a node package currently distributed via NPM. This means you must have the Node v20+ 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.
[!NOTE] You can download a standalone package directly from the latest Github release assets if you don’t use Node.
Global installation
To install it globally, run the following command with NPM: