Security News
The Unpaid Backbone of Open Source: Solo Maintainers Face Increasing Security Demands
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
The Bump CLI is used to interact with your API documentation hosted on Bump by using the API of developers.bump.sh
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.
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.
Unfortunately, at the moment we only publish a npm package. However we plan to distribute universal binaries in the most common package managers soon.
$ 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
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.
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
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
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.
From a Bump documentation, the diff
command will retrieve a comparaison 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
* Let's compare the given definition version... done
Updated: POST /validations
Body attribute modified: documentation
Note: you can use the --open
flag to open the visual diff URL in your browser directly.
Please check bump diff --help
for full usage details.
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
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 node package is available as open source under the terms of 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 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!
FAQs
The Bump CLI is used to interact with your API documentation hosted on Bump by using the API of developers.bump.sh
The npm package bump-cli receives a total of 2,617 weekly downloads. As such, bump-cli popularity was classified as popular.
We found that bump-cli demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
Security News
License exceptions modify the terms of open source licenses, impacting how software can be used, modified, and distributed. Developers should be aware of the legal implications of these exceptions.
Security News
A developer is accusing Tencent of violating the GPL by modifying a Python utility and changing its license to BSD, highlighting the importance of copyleft compliance.