Skip to content

Document cookie forwarding in collection runs #46

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mintlify wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document cookie forwarding in collection runs #46

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion bru-cli/commandOptions.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

## Options

To use options, add them to the bru run command after you specify the collection file or folder:

Check warning on line 6 in bru-cli/commandOptions.mdx

View check run for this annotation

Mintlify / Mintlify Validation (bruno-a6972042) - vale-spellcheck

bru-cli/commandOptions.mdx#L6 

Did you really mean 'bru'?

```bash
bru run [options]
Expand Down Expand Up @@ -53,10 +53,10 @@
| Option | Details |
| ---------------------------- | ----------------------------------------------------------------------------- |
| `--cacert [string]` | CA certificate to verify peer against |
| `--ignore-truststore` | Use custom CA certificate exclusively and ignore default truststore [boolean] [default: false] |

Check warning on line 56 in bru-cli/commandOptions.mdx

View check run for this annotation

Mintlify / Mintlify Validation (bruno-a6972042) - vale-spellcheck

bru-cli/commandOptions.mdx#L56 

Did you really mean 'truststore'?
| `--client-cert-config` | Path to the Client certificate config file used for securing the connection |
| `--insecure` | Allow insecure server connections |
| `--disable-cookies` | Automatically save and send cookies with requests [boolean] [default: false] |
| `--disable-cookies` | Disable automatic saving and sending of cookies between requests [boolean] [default: false] |
| `--noproxy` | Disable all proxy settings (both collection-defined and system proxies) [boolean] [default: false] |

### Output & Reporting options
Expand All @@ -66,7 +66,7 @@
| `-o`, `--output [string]` | **[DEPRECATED]** Path to write file results to. Use reporter options instead |
| `-f`, `--format [string]` | **[DEPRECATED]** Format of the file results. Use reporter options instead |
| `--reporter-json [string]` | Path to generate a JSON report |
| `--reporter-junit [string]` | Path to generate a JUnit report |

Check warning on line 69 in bru-cli/commandOptions.mdx

View check run for this annotation

Mintlify / Mintlify Validation (bruno-a6972042) - vale-spellcheck

bru-cli/commandOptions.mdx#L69 

Did you really mean 'JUnit'?
| `--reporter-html [string]` | Path to generate an HTML report |
| `--reporter-skip-all-headers` | Skip all headers in the report [boolean] [default: false] |
| `--reporter-skip-headers` | Skip specific headers in the report [array] [default: []] |
Expand Down
12 changes: 12 additions & 0 deletions send-requests/res-data-cookies/cookies.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,4 +51,16 @@ You can update and delete cookie(s) by clicking the icons next to it.

![cookie-delete](/images/screenshots/send-request/res-data-and-cookie/cookies/6-delete-cookie.webp)

## Cookies in collection runs

When you run a collection (via the Collection Runner or the [Bruno CLI](/bru-cli/overview)), Bruno automatically saves and forwards cookies between requests. This includes cookies set by responses with **any** status code — 2XX, 4XX, and 5XX responses all have their `Set-Cookie` headers processed.

To disable automatic cookie handling in the CLI, use the `--disable-cookies` flag:

```bash
bru run --disable-cookies
```

In the desktop app, you can toggle cookie storage off in **Settings > General**.

To manage cookies programmatically, see the [Cookie Management](/testing/script/javascript-reference#cookie-management) section in the JavaScript API Reference.
Loading