|
| 1 | +--- |
| 2 | +title: run collection |
| 3 | +--- |
| 4 | + |
| 5 | +## Command Description |
| 6 | + |
| 7 | +Run Insomnia request collection, identifier can be a workspace id |
| 8 | + |
| 9 | +## Syntax |
| 10 | + |
| 11 | +`run collection [options] [identifier]` |
| 12 | + |
| 13 | +## Local Flags |
| 14 | + |
| 15 | +- `-t, --requestNamePattern <regex>`: run requests that match the regex |
| 16 | +- `-i, --item <requestid>`: request or folder id to run |
| 17 | +- `-e, --env <identifier>`: environment to use |
| 18 | +- `-g, --globals <identifier>`: global environment to use (filepath or id) |
| 19 | +- `--delay-request <duration>`: milliseconds to delay between requests |
| 20 | +- `--requestTimeout <duration>`: milliseconds before request times out |
| 21 | +- `--env-var <key=value>`: override environment variables |
| 22 | +- `-n, --iteration-count <count>`: number of times to repeat |
| 23 | +- `-d, --iteration-data <path/url>`: file path or url (JSON or CSV) |
| 24 | +- `-r, --reporter <reporter>`: reporter to use, options are [dot, list, min, progress, spec, tap] |
| 25 | +- `-b, --bail`: abort ("bail") after first non-200 response |
| 26 | +- `--disableCertValidation`: disable certificate validation for requests with SSL |
| 27 | +- `--httpsProxy <proxy>`: URL for the proxy server for https requests. |
| 28 | +- `--httpProxy <proxy>`: URL for the proxy server for http requests. |
| 29 | +- `--noProxy <comma_separated_list_of_hostnames>`: Comma separated list of hostnames that do not require a proxy to get reached, even if one is specified. |
| 30 | +- `-f, --dataFolders [dataFolders...]`: This allows you to control what folders Insomnia (and scripts within Insomnia) can read/write to. |
| 31 | +- `--output <file>`: Output the results to a file in JSON format. |
| 32 | +- `--includeFullData <type>`: Include full data in the output file, including request, response, environment and etc. |
| 33 | +- `--acceptRisk`: Accept the security warning when outputting to a file, please make sure you understand the risks. |
| 34 | + |
| 35 | +## Global Flags |
| 36 | + |
| 37 | +- `-v, --version`: output the version number |
| 38 | +- `-w, --workingDir <dir>`: set working directory/file: .insomnia folder, *.db.json, export.yaml |
| 39 | +- `--verbose`: show additional logs while running the command |
| 40 | +- `--ci`: run in CI, disables all prompts, defaults to false |
| 41 | +- `--config <path>`: path to configuration file containing above options (.insorc) |
| 42 | +- `--printOptions`: print the loaded options |
| 43 | + |
0 commit comments