{"_id":"@berlingoqc/openbruno-cli","name":"@berlingoqc/openbruno-cli","dist-tags":{"latest":"1.22.0"},"versions":{"1.22.0":{"name":"@berlingoqc/openbruno-cli","version":"1.22.0","license":"MIT","main":"src/index.js","bin":{"openbru":"bin/bru.js"},"repository":{"type":"git","url":"git+https://github.com/berlingoqc/openbruno.git"},"scripts":{"test":"node --experimental-vm-modules $(npx which jest)","version":"node -p \"require('./package.json').version\""},"dependencies":{"@aws-sdk/credential-providers":"3.658.1","@usebruno/common":"0.1.0","@usebruno/js":"0.12.0","@berlingoqc/openbruno-lang":"0.13.0","aws4-axios":"^3.3.0","axios":"1.7.5","chai":"^4.3.7","chalk":"^3.0.0","decomment":"^0.9.5","form-data":"^4.0.0","fs-extra":"^10.1.0","http-proxy-agent":"^7.0.0","https-proxy-agent":"^7.0.2","json-bigint":"^1.0.0","lodash":"^4.17.21","qs":"^6.11.0","socks-proxy-agent":"^8.0.2","@usebruno/vm2":"^3.9.13","xmlbuilder":"^15.1.1","yargs":"^17.6.2"},"_id":"@berlingoqc/openbruno-cli@1.22.0","gitHead":"586781af3678068cfa08bdaef98f44a4d66e0143","description":"With OpenBruno CLI, you can now run your API collections with ease using simple command line commands.","bugs":{"url":"https://github.com/berlingoqc/openbruno/issues"},"homepage":"https://github.com/berlingoqc/openbruno#readme","_nodeVersion":"18.20.5","_npmVersion":"10.9.0","dist":{"integrity":"sha512-ZAq6E0NnT2hFM0xb8Ff2igCSAET4hzTiAH57sLiz7KJkcISaaCfbh7dGXi+DcEGp2bjcEOgRy7LmTAugKlQRXw==","shasum":"855dd9f9373b7aad4c528475d76b72f3124313d0","tarball":"https://registry.npmjs.org/@berlingoqc/openbruno-cli/-/openbruno-cli-1.22.0.tgz","fileCount":21,"unpackedSize":96384,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIHcR+hySai//PgyKgCmmVuKG2qRJRiydTeOQl7SnDIk1AiA4yWuoCvVml85l7COP2bTaTjGI7syWpn3V5dW4Eyp+yw=="}]},"_npmUser":{"name":"berlingoqc","email":"william95quintalwilliam@outlook.com"},"directories":{},"maintainers":[{"name":"berlingoqc","email":"william95quintalwilliam@outlook.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/openbruno-cli_1.22.0_1731973704740_0.196676019334451"},"_hasShrinkwrap":false}},"time":{"created":"2024-11-18T23:48:24.667Z","1.22.0":"2024-11-18T23:48:24.906Z","modified":"2024-11-18T23:48:25.140Z"},"maintainers":[{"name":"berlingoqc","email":"william95quintalwilliam@outlook.com"}],"description":"With OpenBruno CLI, you can now run your API collections with ease using simple command line commands.","homepage":"https://github.com/berlingoqc/openbruno#readme","repository":{"type":"git","url":"git+https://github.com/berlingoqc/openbruno.git"},"bugs":{"url":"https://github.com/berlingoqc/openbruno/issues"},"license":"MIT","readme":"# openbruno-cli\n\nWith OpenBruno CLI, you can now run your API collections with ease using simple command line commands.\n\nThis 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.\n\n## Installation\n\nTo install the OpenBruno CLI, use the node package manager of your choice, such as NPM:\n\n```bash\n# clone the repo\ncd ./packages/bruno-cli && npm link\n```\n\n## Getting started\n\nNavigate to the directory where your API collection resides, and then run:\n\n```bash\nbru run\n```\n\nThis command will run all the requests in your collection. You can also run a single request by specifying its filename:\n\n```bash\nbru run request.bru\n```\n\nOr run all requests in a collection's subfolder:\n\n```bash\nbru run folder\n```\n\nIf you need to use an environment, you can specify it with the `--env` option:\n\n```bash\nbru run folder --env Local\n```\n\nIf you need to collect the results of your API tests, you can specify the `--output` option:\n\n```bash\nbru run folder --output results.json\n```\n\nIf you need to run a set of requests that connect to peers with both publicly and privately signed certificates respectively, you can add private CA certificates via the `--cacert` option. By default, these certificates will be used in addition to the default truststore:\n\n```bash\nbru run folder --cacert myCustomCA.pem\n```\n\nIf you need to limit the trusted CA to a specified set when validating the request peer, provide them via `--cacert` and in addition use `--ignore-truststore` to disable the default truststore:\n\n```bash\nbru run request.bru --cacert myCustomCA.pem --ignore-truststore\n```\n\n## Scripting\n\nBruno cli returns the following exit status codes:\n\n- `0` -- execution successful\n- `1` -- an assertion, test, or request in the executed collection failed\n- `2` -- the specified output directory does not exist\n- `3` -- the request chain seems to loop endlessly\n- `4` -- bru was called outside of a collection root directory\n- `5` -- the specified input file does not exist\n- `6` -- the specified environment does not exist\n- `7` -- the environment override was not a string or object\n- `8` -- an environment override is malformed\n- `9` -- an invalid output format was requested\n- `255` -- another error occurred\n\n## Demo\n\n![demo](assets/images/cli-demo.png)\n\n## Support\n\nIf you encounter any issues or have any feedback or suggestions, please raise them on our [GitHub repository](https://github.com/usebruno/bruno)\n\nThank you for using Bruno CLI!\n\n## Changelog\n\n<!-- An absolute link is used here because npm treats links differently -->\n\nSee [https://github.com/usebruno/bruno/releases](https://github.com/usebruno/bruno/releases)\n\n## License\n\n[MIT](license.md)\n","readmeFilename":"readme.md"}