The Bump CLI is a command-line interface tool designed to interact with the Bump.sh platform, enabling developers to manage their API documentation, hubs, and workflows directly from their development environments. It supports popular API description formats such as OpenAPI (v2.0, v3.x, and partially v3.2), Swagger, and AsyncAPI for documentation, as well as Flower and Arazzo for API workflows. The current stable version is 2.10.0, with releases occurring frequently, often on a monthly or bi-monthly basis, incorporating new features and bug fixes. Key functionalities include validating API documents, publishing them to Bump.sh documentation or hubs, generating human-readable diffs between API definitions, applying overlays, and deploying workflow documents to Managed Control Plane (MCP) servers. The CLI is built with the `oclif` framework in TypeScript and primarily interfaces with the `developers.bump.sh` API.
npm install bump-cliVerified import paths — ran on the pinned version, not inferred.
This quickstart demonstrates how to programmatically deploy an OpenAPI definition to Bump.sh using the `bump-cli` via `npx` and environment variables for authentication. It creates a temporary OpenAPI file, deploys it, and then cleans up.
Upgrade your Node.js environment to version 20.0.0 or later. Use a Node Version Manager (NVM) for easy switching and management of Node.js versions.
Execute `bump-cli` commands from your shell using `npx bump [command]` (for local installation) or `bump [command]` (for global installation). For programmatic execution, use `node:child_process` to spawn the command.
Consult the Bump.sh documentation for specific limitations on OpenAPI 3.2 features. Test your OpenAPI 3.2 documents thoroughly after deployment and report any issues encountered to ensure full compatibility in future releases.
Review any existing overlay files that use JSON paths with the `overlay` command to ensure they conform to RFC 9535 standards. Test overlays thoroughly after updating to version 2.9.11 or newer to avoid unexpected behavior.
Refer to the latest Bump.sh documentation regarding MCP server deployments for up-to-date information on supported features and any known limitations. Provide feedback to Bump.sh to help mature the feature.
Upgrade your Node.js environment to version 20.0.0 or later. Tools like `nvm install 20 && nvm use 20` or `npm install -g n && n 20` can help manage Node.js versions easily.
Ensure you pass a valid Bump.sh API token using `--token $BUMP_TOKEN` or by setting the `BUMP_TOKEN` environment variable. Generate a new token if necessary from your Bump.sh account settings.
Validate your API definition file locally using a linter (e.g., `spectral lint` for OpenAPI/AsyncAPI) or a schema validator before attempting to deploy. Check for common issues like incorrect YAML/JSON syntax, missing required fields, or invalid schema references (`$refs`).
Review the JSON Path expression in your overlay file. Ensure it adheres to RFC 9535 standards for JSON Path. Test the overlay locally using the `bump overlay` command before deployment to verify its correctness.
No dependency data recorded yet.