From 78d23936867765952297b7e2f4fe3f5547df953d Mon Sep 17 00:00:00 2001 From: Anoop M D Date: Sat, 1 Apr 2023 13:40:23 +0530 Subject: [PATCH] chore: prep for bruno-cli release --- packages/bruno-cli/license.md | 22 +++++++++++++++ packages/bruno-cli/package.json | 6 ++-- packages/bruno-cli/readme.md | 41 +++++++++++++++++++++++++--- packages/bruno-electron/package.json | 4 +-- packages/bruno-js/package.json | 2 +- packages/bruno-lang/package.json | 2 +- 6 files changed, 66 insertions(+), 11 deletions(-) create mode 100644 packages/bruno-cli/license.md diff --git a/packages/bruno-cli/license.md b/packages/bruno-cli/license.md new file mode 100644 index 00000000..f88e206b --- /dev/null +++ b/packages/bruno-cli/license.md @@ -0,0 +1,22 @@ + +MIT License + +Copyright (c) 2022 Anoop M D, Anusree P S and Contributors + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/packages/bruno-cli/package.json b/packages/bruno-cli/package.json index 1f6c128b..d68762d3 100644 --- a/packages/bruno-cli/package.json +++ b/packages/bruno-cli/package.json @@ -1,6 +1,6 @@ { "name": "@usebruno/cli", - "version": "0.3.0", + "version": "0.4.0", "main": "src/index.js", "bin": { "bru": "./bin/bru.js" @@ -11,8 +11,8 @@ "package.json" ], "dependencies": { - "@usebruno/js": "0.2.0", - "@usebruno/lang": "0.2.2", + "@usebruno/js": "0.3.0", + "@usebruno/lang": "0.3.0", "axios": "^1.3.2", "chai": "^4.3.7", "chalk": "^3.0.0", diff --git a/packages/bruno-cli/readme.md b/packages/bruno-cli/readme.md index f838a788..4b5be8d0 100644 --- a/packages/bruno-cli/readme.md +++ b/packages/bruno-cli/readme.md @@ -1,8 +1,41 @@ # bruno-cli -Bru CLI +With Bruno CLI, you can now run your API collections with ease using simple command line commands. -### Publish to Npm Registry +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 publish --access=public -``` \ No newline at end of file +npm install -g @usebruno/cli +``` + +## Getting started +Navigate to the directory where your API collection resides, and then run: +```bash +bruno run +``` +This command will run all the requests in your collection. You can also run a single request by specifying its filename: + +```bash +bruno run request.bru +``` + +Or run all requests in a folder: +```bash +bruno run folder +``` + +If you need to use an environment, you can specify it with the --env option: +```bash +bruno run folder --env Local +``` + +## 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! + + +## License +[MIT](license.md) \ No newline at end of file diff --git a/packages/bruno-electron/package.json b/packages/bruno-electron/package.json index cfa4bda5..cf26c25b 100644 --- a/packages/bruno-electron/package.json +++ b/packages/bruno-electron/package.json @@ -13,8 +13,8 @@ "pack": "electron-builder --dir" }, "dependencies": { - "@usebruno/js": "0.2.0", - "@usebruno/lang": "0.2.2", + "@usebruno/js": "0.3.0", + "@usebruno/lang": "0.3.0", "@usebruno/schema": "0.3.1", "axios": "^0.26.0", "chai": "^4.3.7", diff --git a/packages/bruno-js/package.json b/packages/bruno-js/package.json index f389732b..ae51884b 100644 --- a/packages/bruno-js/package.json +++ b/packages/bruno-js/package.json @@ -1,6 +1,6 @@ { "name": "@usebruno/js", - "version": "0.2.0", + "version": "0.3.0", "main": "src/index.js", "files": [ "src", diff --git a/packages/bruno-lang/package.json b/packages/bruno-lang/package.json index d123d0f0..9a8869f2 100644 --- a/packages/bruno-lang/package.json +++ b/packages/bruno-lang/package.json @@ -1,6 +1,6 @@ { "name": "@usebruno/lang", - "version": "0.2.2", + "version": "0.3.0", "main": "src/index.js", "files": [ "src",