mirror of
https://github.com/usebruno/bruno.git
synced 2025-02-20 11:41:10 +01:00
811a6e6034
* fix: add specific error status codes #2122 This change adds specific exit status codes to identify different problems programatically * feat(#2122): Document the cli exit status codes * Update packages/bruno-cli/src/constants.js Co-authored-by: Andreas Siegel <mail@andreassiegel.de> * Update packages/bruno-cli/src/constants.js Co-authored-by: Andreas Siegel <mail@andreassiegel.de> * Update packages/bruno-cli/src/commands/run.js Co-authored-by: Andreas Siegel <mail@andreassiegel.de> * Update packages/bruno-cli/src/commands/run.js Co-authored-by: Andreas Siegel <mail@andreassiegel.de> * Update packages/bruno-cli/src/commands/run.js Co-authored-by: Andreas Siegel <mail@andreassiegel.de> * Update packages/bruno-cli/src/commands/run.js Co-authored-by: Andreas Siegel <mail@andreassiegel.de> * Update packages/bruno-cli/src/commands/run.js Co-authored-by: Andreas Siegel <mail@andreassiegel.de> * Update packages/bruno-cli/src/commands/run.js Co-authored-by: Andreas Siegel <mail@andreassiegel.de> * Update packages/bruno-cli/src/commands/run.js Co-authored-by: Andreas Siegel <mail@andreassiegel.de> * Update packages/bruno-cli/src/commands/run.js Co-authored-by: Andreas Siegel <mail@andreassiegel.de> * Update packages/bruno-cli/src/commands/run.js Co-authored-by: Andreas Siegel <mail@andreassiegel.de> * Update packages/bruno-cli/src/commands/run.js Co-authored-by: Andreas Siegel <mail@andreassiegel.de> --------- Co-authored-by: Andreas Siegel <mail@andreassiegel.de>
82 lines
2.1 KiB
Markdown
82 lines
2.1 KiB
Markdown
# bruno-cli
|
|
|
|
With Bruno CLI, you can now run your API collections with ease using simple command line commands.
|
|
|
|
This makes it easier to test your APIs in different environments, automate your testing process, and integrate your API tests with your continuous integration and deployment workflows.
|
|
|
|
## Installation
|
|
|
|
To install the Bruno CLI, use the node package manager of your choice, such as NPM:
|
|
|
|
```bash
|
|
npm install -g @usebruno/cli
|
|
```
|
|
|
|
## Getting started
|
|
|
|
Navigate to the directory where your API collection resides, and then run:
|
|
|
|
```bash
|
|
bru run
|
|
```
|
|
|
|
This command will run all the requests in your collection. You can also run a single request by specifying its filename:
|
|
|
|
```bash
|
|
bru run request.bru
|
|
```
|
|
|
|
Or run all requests in a collection's subfolder:
|
|
|
|
```bash
|
|
bru run folder
|
|
```
|
|
|
|
If you need to use an environment, you can specify it with the --env option:
|
|
|
|
```bash
|
|
bru run folder --env Local
|
|
```
|
|
|
|
If you need to collect the results of your API tests, you can specify the --output option:
|
|
|
|
```bash
|
|
bru run folder --output results.json
|
|
```
|
|
|
|
## Scripting
|
|
|
|
Bruno cli returns the following exit status codes:
|
|
|
|
- `0` -- execution successful
|
|
- `1` -- an assertion, test, or request in the executed collection failed
|
|
- `2` -- the specified output directory does not exist
|
|
- `3` -- the request chain seems to loop endlessly
|
|
- `4` -- bru was called outside of a colection root directory
|
|
- `5` -- the specified input file does not exist
|
|
- `6` -- the specified environment does not exist
|
|
- `7` -- the environment override was not a string or object
|
|
- `8` -- an environment override is malformed
|
|
- `9` -- an invalid output format was requested
|
|
- `255` -- another error occured
|
|
|
|
## Demo
|
|
|
|
|
|
|
|
## Support
|
|
|
|
If you encounter any issues or have any feedback or suggestions, please raise them on our [GitHub repository](https://github.com/usebruno/bruno)
|
|
|
|
Thank you for using Bruno CLI!
|
|
|
|
## Changelog
|
|
|
|
<!-- An absolute link is used here because npm treats links differently -->
|
|
|
|
See [https://github.com/usebruno/bruno/releases](https://github.com/usebruno/bruno/releases)
|
|
|
|
## License
|
|
|
|
[MIT](license.md)
|