Merge pull request #299 from ganesh-bruno/update/cli-docs

add update to bruno cli

Author: ganesh-bruno

src/pages/bru-cli/builtInReporters.mdx

@@ -45,3 +45,19 @@ bru run request.bru --reporter-json results.json --reporter-junit results.xml --
 
 This command will create three files: results.json, results.xml, and results.html, allowing you to analyze the results in different formats as needed.
 
+## Skipping Specific Headers in the Report
+
+If you want to exclude certain headers from the report, use the `--reporter-skip-headers` option. You can list multiple headers to skip, separated by spaces.
+
+```bash
+bru run --reporter-html results.html --reporter-skip-headers "Authorization" "Content-Type" "Date"
+```
+
+## Skip All Headers in the Report
+
+To exclude all headers from the report, use the `--reporter-skip-all-headers` option. This will remove all headers from the output report, ensuring a cleaner result.
+
+```bash copy
+bru run --reporter-html results.html --reporter-skip-all-headers
+```
+

src/pages/bru-cli/commandOptions.mdx

@@ -11,6 +11,85 @@ bru --version
 ```
 This will display the version number of the Bruno CLI you have installed. It's a helpful command for ensuring you're working with the latest version or for troubleshooting version-specific issues.
 
+## Getting Started
+
+Navigate to the directory where your API collection resides, and run the following command:
+
+```bash copy
+bru run
+```
+
+This will run all the requests in your collection. If you want to run a single request, specify its filename:
+
+```bash copy
+bru run request.bru
+```
+
+## Running Requests in a Folder
+To run all the requests within a folder, use:
+
+```bash copy
+bru run folder
+```
+
+## Using Environments
+If you need to use a specific environment, you can pass it with the `--env` option:
+
+```bash copy
+bru run folder --env Local
+```
+
+## Passing Environment Variables
+
+> Variables marked as secrets in Bruno app are not accessible via the CLI. Pass them directly as command-line arguments.
+
+```bash copy
+bru run folder --env Local --env-var JWT_TOKEN=1234
+```
+
+## Outputting Results
+To save the results of your API tests to a file, use the `--output` option:
+
+```bash copy
+bru run folder --output results.json
+```
+## Adding Delay
+If you need to add a delay between requests during the execution of your API collection, you can use the `--delay` option.
+
+Example:
+```bash copy
+bru run  --delay 1000
+```
+## Using Client Certificates for API Requests
+
+If your API requests require client certificates for authentication, you can specify using the `--client-cert-config` option. The configuration should be provided in a JSON file. Here's an example of how to use this option:
+
+```bash copy
+bru run folder --client-cert-config /path/to/client-cert-config.json
+```
+
+The client-cert-config.json file should contain the following fields:
+
+```json
+{
+  "enabled": true,
+  "certs": [
+    {
+      "domain": "usebruno.com",
+      "type": "cert",
+      "certFilePath": "certs/server_1.crt",
+      "keyFilePath": "private/server_1.key",
+      "passphrase": "Iu$eBrun0_#Secure!"
+    },
+    {
+      "domain": "the-example.com",
+      "type": "pfx",
+      "pfxFilePath": "pfx/server_3.pfx",
+      "passphrase": "L!ghT_Y@g@mi_2024!"
+    }
+  ]
+}
+```
 
 ## Options
 

src/pages/bru-cli/installation.mdx

@@ -1,50 +1,36 @@
 import { Callout } from 'nextra/components'
- 
+import { Tabs } from 'nextra/components'
 
 # Installation
 
 <Callout emoji="">
   Make sure you have Node.js installed on your local system. It is recommended to use the latest LTS version (Node 18 or higher). 
 </Callout>
 
-To install the Bruno CLI, use the node package manager of your choice, such as NPM:
-```bash copy
-npm install -g @usebruno/cli
-```
-
-## Getting Started
-
-Navigate to the directory where your API collection resides, and run the following command:
+To install the Bruno CLI, use the node package manager of your choice:
 
-```bash copy
-bru run
-```
-
-This will run all the requests in your collection. If you want to run a single request, specify its filename:
+<Tabs items={['pnpm', 'npm', 'yarn']}>
+  <Tabs.Tab>
+  ### Using pnpm
 
-```bash copy
-bru run request.bru
+    ```bash
+pnpm install -g @usebruno/cli
 ```
-
-## Running Requests in a Folder
-To run all the requests within a folder, use:
-
-```bash copy
-bru run folder
+  </Tabs.Tab>
+  <Tabs.Tab>
+    
+    ### Using npm
+```bash
+npm install -g @usebruno/cli
 ```
 
-## Using Environments
-If you need to use a specific environment, you can pass it with the --env option:
-
-```bash copy
-bru run folder --env Local
+  </Tabs.Tab>
+  <Tabs.Tab>
+    
+    ### Using yarn
+```bash
+yarn global add @usebruno/cli
 ```
-
-## Passing Environment Variables
-
-> Variables marked as secrets in Bruno app are not accessible via the CLI. Pass them directly as command-line arguments.
-
-```bash copy
-bru run folder --env Local --env-var JWT_TOKEN=1234
-```
-
+  </Tabs.Tab>
+</Tabs>
+For more details, visit the official [NPM Page for Bruno CLI](https://www.npmjs.com/package/@usebruno/cli)

src/pages/bru-cli/overview.mdx

@@ -11,6 +11,4 @@ This makes it easier to test your APIs in different environments, automate your
 
 **2. Generate Test Reports** : Easily create reports in multiple formats, including JSON, JUnit, and HTML, to analyze and share test results.
 
-**3. CI/CD Integration**: Effortlessly integrate with CI/CD pipelines for automated testing and validation.
-
-For more details, visit the official [NPM Page for Bruno CLI](https://www.npmjs.com/package/@usebruno/cli)
+**3. CI/CD Integration**: Effortlessly integrate with CI/CD pipelines for automated testing and validation.

src/pages/bru-cli/runCollection.mdx

@@ -17,65 +17,3 @@ To run a collection using data from a JSON file, provide the file path using the
 bru run folder --json-file-path /path/to/json/file.json
 ```
 > This feature requires Bruno CLI version 1.35.0 or higher.
-
-## Outputting Results
-To save the results of your API tests to a file, use the --output option:
-
-```bash copy
-bru run folder --output results.json
-```
-
-## Skipping Specific Headers in the Report
-
-If you want to exclude certain headers from the report, use the `--reporter-skip-headers` option. You can list multiple headers to skip, separated by spaces.
-
-```bash
-bru run --reporter-html results.html --reporter-skip-headers "Authorization" "Content-Type" "Date"
-```
-
-## Skip All Headers in the Report
-
-To exclude all headers from the report, use the `--reporter-skip-all-headers` option. This will remove all headers from the output report, ensuring a cleaner result.
-
-```bash copy
-bru run --reporter-html results.html --reporter-skip-all-headers
-```
-
-## Using Client Certificates for API Requests
-
-If your API requests require client certificates for authentication, you can specify using the `--client-cert-config` option. The configuration should be provided in a JSON file. Here's an example of how to use this option:
-
-```bash copy
-bru run folder --client-cert-config /path/to/client-cert-config.json
-```
-
-The client-cert-config.json file should contain the following fields:
-
-```json
-{
-  "enabled": true,
-  "certs": [
-    {
-      "domain": "usebruno.com",
-      "type": "cert",
-      "certFilePath": "certs/server_1.crt",
-      "keyFilePath": "private/server_1.key",
-      "passphrase": "Iu$eBrun0_#Secure!"
-    },
-    {
-      "domain": "the-example.com",
-      "type": "pfx",
-      "pfxFilePath": "pfx/server_3.pfx",
-      "passphrase": "L!ghT_Y@g@mi_2024!"
-    }
-  ]
-}
-```
-## Adding Delay
-If you need to add a delay between requests during the execution of your API collection, you can use the `--delay` option.
-
-Example:
-```bash copy
-bru run . --delay 1000
-```
-