Running a Collection

Bruno CLI allows you to run your API collections with ease, either by directly executing requests or using external data sources.

You can run collections using data from CSV or JSON files, customize the output of your test results, skip specific headers, and even work with client certificates for secure API communication.

Running a Collection with a CSV File

If you need to run a collection using data from a CSV file, specify the path to the file with the --csv-file-path option:

bru run folder --csv-file-path /path/to/csv/file.csv

Running a Collection with a JSON File

To run a collection using data from a JSON file, provide the file path using the --json-file-path option:

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:

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.

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.

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:

bru run folder --client-cert-config /path/to/client-cert-config.json

The client-cert-config.json file should contain the following fields:

{
  "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:

bru run . --delay 1000