> ## Documentation Index > Fetch the complete documentation index at: https://mintlify.com/usebruno/bruno/llms.txt > Use this file to discover all available pages before exploring further. # CLI Options Reference > Complete reference of all Bruno CLI command-line options and flags # CLI Options Reference Complete reference for all Bruno CLI commands, options, and flags. ## Global Options These options are available for all commands: Show help information. **Aliases:** `-h` ```bash theme={null} bru --help bru run --help ``` Show version number. ```bash theme={null} bru --version ``` ## Run Command Execute API requests and tests from your collection. ```bash theme={null} bru run [paths...] [options] ``` ### Paths One or more request files or folders to run. If omitted, runs all requests in the current directory recursively. ```bash theme={null} bru run # Run all requests bru run request.bru # Run single request bru run folder # Run folder bru run auth users -r # Run multiple paths recursively ``` ### Execution Options Run requests recursively in subdirectories. ```bash theme={null} bru run tests -r ``` Only run requests that have tests or active assertions. ```bash theme={null} bru run --tests-only ``` Stop execution immediately after a failure of a request, test, or assertion. ```bash theme={null} bru run --bail ``` Add delay between each request in milliseconds. ```bash theme={null} bru run --delay 1000 # 1 second delay bru run --delay 500 # 500ms delay ``` Enable verbose output for debugging purposes. ```bash theme={null} bru run --verbose ``` ### Environment Options Specify environment to run with. Loads from `environments/.bru` or `environments/.yml`. ```bash theme={null} bru run --env production bru run --env local ``` Path to environment file (.bru, .json, or .yml) - absolute or relative. ```bash theme={null} bru run --env-file custom-env.bru bru run --env-file /path/to/env.json ``` Override a single environment variable. Can be used multiple times. ```bash theme={null} bru run --env-var apiKey=secret123 bru run --env-var baseUrl=https://api.test.com --env-var token=xyz ``` Global environment name (requires collection to be in a workspace). ```bash theme={null} bru run --global-env production bru run --global-env staging --workspace-path /path/to/workspace ``` Path to workspace directory (auto-detected if not provided). ```bash theme={null} bru run --global-env production --workspace-path ~/my-workspace ``` ### Output and Reporting Path to write file results to. Use with `--format` to specify format. **Aliases:** `-o` ```bash theme={null} bru run --output results.json bru run --output results.xml --format junit bru run -o report.html --format html ``` Format of the file results. **Aliases:** `-f` **Options:** `json`, `junit`, `html` ```bash theme={null} bru run --output results.xml --format junit ``` Path to generate a JSON report. ```bash theme={null} bru run --reporter-json results.json ``` Path to generate a JUnit XML report. ```bash theme={null} bru run --reporter-junit results.xml ``` Path to generate an HTML report. ```bash theme={null} bru run --reporter-html report.html ``` ### Reporter Customization Omit all headers from the reporter output. ```bash theme={null} bru run --reporter-skip-all-headers ``` Skip specific headers from the reporter output. ```bash theme={null} bru run --reporter-skip-headers Authorization Cookie bru run --reporter-skip-headers "X-Api-Key" ``` Omit request body from the reporter output. ```bash theme={null} bru run --reporter-skip-request-body ``` Omit response body from the reporter output. ```bash theme={null} bru run --reporter-skip-response-body ``` Omit both request and response bodies from the reporter output. ```bash theme={null} bru run --reporter-skip-body ``` ### Security and Certificates CA certificate to verify peer against. By default, uses system truststore + custom cert. ```bash theme={null} bru run --cacert myCustomCA.pem bru run --cacert corporate-ca.crt ``` Use only the specified custom CA certificate (--cacert) and ignore the default truststore. ```bash theme={null} bru run --cacert myCustomCA.pem --ignore-truststore ``` Allow insecure server connections (skip SSL certificate verification). Only use in development/testing environments. ```bash theme={null} bru run --insecure ``` Path to client certificate configuration JSON file. ```bash theme={null} bru run --client-cert-config client-certs.json ``` **Config format:** ```json theme={null} { "enabled": true, "certs": [ { "domain": "https://api.example.com", "certFilePath": "/path/to/cert.pem", "keyFilePath": "/path/to/key.pem", "passphrase": "optional" } ] } ``` ### Network Options Disable all proxy settings (both collection-defined and system proxies). ```bash theme={null} bru run --noproxy ``` Disable automatic cookie saving and sending with requests. ```bash theme={null} bru run --disable-cookies ``` ### Advanced Options JavaScript sandbox runtime to use. **Options:** * `safe` - Uses QuickJS (secure, limited features) * `developer` - Uses Node.js VM (more features, less secure) ```bash theme={null} bru run --sandbox developer ``` Comma-separated list of tags to include in the run. ```bash theme={null} bru run --tags=smoke,critical bru run --tags=api ``` Comma-separated list of tags to exclude from the run. ```bash theme={null} bru run --exclude-tags=skip,wip bru run --tags=api --exclude-tags=slow ``` ## Import Command Import collections from other formats. ```bash theme={null} bru import [options] ``` ### Import Types Type of collection to import. **Options:** `openapi`, `wsdl` ```bash theme={null} bru import openapi --source api.yml --output ./collection bru import wsdl --source service.wsdl --output ./soap ``` ### Import Options Path to the source file or URL. **Aliases:** `-s` ```bash theme={null} bru import openapi --source api.yml bru import openapi -s https://api.example.com/openapi.json ``` Path to the output directory. Conflicts with `--output-file`. **Aliases:** `-o` ```bash theme={null} bru import openapi -s api.yml -o ~/Desktop/my-collection ``` Path to the output JSON file. Conflicts with `--output`. **Aliases:** `-f` ```bash theme={null} bru import openapi -s api.yml -f ~/Desktop/collection.json ``` Name for the imported collection. **Aliases:** `-n` ```bash theme={null} bru import openapi -s api.yml -o ./collection -n "My API" ``` Format of the imported collection. **Options:** `bru`, `opencollection` ```bash theme={null} bru import openapi -s api.yml -o ./collection --collection-format bru ``` Skip SSL certificate verification when fetching from URLs. ```bash theme={null} bru import openapi -s https://self-signed.com/api.json --insecure ``` How to group imported requests (OpenAPI only). **Aliases:** `-g` **Options:** `tags`, `path` ```bash theme={null} bru import openapi -s api.yml -o ./collection --group-by path bru import openapi -s api.yml -o ./collection -g tags ``` ## Exit Codes Bruno CLI returns specific exit codes for scripting and automation: | Exit Code | Constant | Description | | --------- | ------------------------------------- | ------------------------------------------------------ | | `0` | - | Execution successful | | `1` | `ERROR_FAILED_COLLECTION` | An assertion, test, or request failed | | `2` | `ERROR_MISSING_OUTPUT_DIR` | The specified output directory does not exist | | `3` | `ERROR_INFINITE_LOOP` | The request chain loops endlessly | | `4` | `ERROR_NOT_IN_COLLECTION` | Bru was called outside of a collection root | | `5` | `ERROR_FILE_NOT_FOUND` | The specified input file does not exist | | `6` | `ERROR_ENV_NOT_FOUND` | The specified environment does not exist | | `7` | `ERROR_MALFORMED_ENV_OVERRIDE` | Environment override not presented as string or object | | `8` | `ERROR_INCORRECT_ENV_OVERRIDE` | Environment override format incorrect | | `9` | `ERROR_INCORRECT_OUTPUT_FORMAT` | Invalid output format requested | | `10` | `ERROR_INVALID_FILE` | Invalid file format | | `11` | `ERROR_WORKSPACE_NOT_FOUND` | The specified workspace was not found | | `12` | `ERROR_GLOBAL_ENV_REQUIRES_WORKSPACE` | Global environment requires a workspace | | `13` | `ERROR_GLOBAL_ENV_NOT_FOUND` | The specified global environment was not found | | `255` | `ERROR_GENERIC` | Another error occurred | ### Using Exit Codes in Scripts ```bash theme={null} #!/bin/bash bru run --env production EXIT_CODE=$? if [ $EXIT_CODE -eq 0 ]; then echo "All tests passed!" elif [ $EXIT_CODE -eq 1 ]; then echo "Some tests failed" exit 1 elif [ $EXIT_CODE -eq 6 ]; then echo "Environment not found" exit 1 else echo "Error occurred: $EXIT_CODE" exit 1 fi ``` ## Environment Variables Bruno CLI respects the following environment variables: HTTP proxy server URL. ```bash theme={null} export HTTP_PROXY=http://proxy.example.com:8080 bru run ``` HTTPS proxy server URL. ```bash theme={null} export HTTPS_PROXY=https://proxy.example.com:8443 bru run ``` Comma-separated list of hosts to exclude from proxying. ```bash theme={null} export NO_PROXY=localhost,127.0.0.1,.example.com bru run ``` ## Complete Examples ### Production Test Suite ```bash theme={null} bru run \ --env production \ --env-var apiKey=$PROD_API_KEY \ --reporter-junit results.xml \ --reporter-html report.html \ --reporter-skip-headers Authorization \ --bail \ --cacert corporate-ca.pem ``` ### Development Testing ```bash theme={null} bru run \ --env local \ --env-var baseUrl=http://localhost:3000 \ --tests-only \ --verbose \ --insecure ``` ### CI/CD Integration ```bash theme={null} bru run \ --env staging \ --reporter-junit test-results.xml \ --reporter-json test-results.json \ --bail \ --tags=smoke,regression \ --exclude-tags=manual ``` ### Import and Test ```bash theme={null} # Import collection bru import openapi \ --source https://api.example.com/openapi.json \ --output ./my-api \ --collection-name "Example API" \ --group-by path # Run tests cd my-api bru run --env production --reporter-html results.html ``` ## Next Steps Learn about Bruno CLI fundamentals Practical guide to running API tests Import from OpenAPI and other formats Install Bruno CLI in your environment