Skip to content

docs for custom http methods #424

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.

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
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
Binary file not shown.
2 changes: 2 additions & 0 deletions src/pages/bru-cli/commandOptions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,8 @@ bru run -h
| `--bail` | Stop execution after a failure of a request, test, or assertion |
| `--tags [string]` | Only run requests that have ALL of the specified tags (comma-separated) |
| `--exclude-tags [string]` | Skip requests that have ANY of the specified tags (comma-separated) |
| `--parallel` | Run requests in parallel order |
| `--show-progress` | Display progress during collection execution |

### SSL & Security options

Expand Down
28 changes: 28 additions & 0 deletions src/pages/bru-cli/runCollection.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -144,3 +144,31 @@ You can combine include and exclude filters:
```bash copy
bru run --tags=smoke,sanity --exclude-tags=skip,draft
```

## Parallel Execution and Progress Tracking

Bruno CLI supports running requests in parallel and displaying real-time progress during collection execution.

### Parallel Execution

By default, Bruno CLI runs requests sequentially. You can enable parallel execution using the `--parallel` flag:

```bash copy
bru run --iteration-count 2 --parallel
```


### Progress Display

To see real-time progress during collection execution, use the `--show-progress` flag:

```bash copy
bru run --show-progress
```

This displays a formatted table showing:
- Request status (running, completed, failed)
- Response times
- Test results
- Overall progress

13 changes: 13 additions & 0 deletions src/pages/send-requests/REST/rest-api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,16 @@ Once you create the new request, you can execute it by clicking the arrow button
In Bruno, the **GET** method is set as the default HTTP method for new requests. However, you can select other HTTP methods (such as **POST**, **PUT**, **DELETE**, etc.) based on your API requirements to send data.

![various-http-method](/screenshots/send-request/rest/various-http-method.webp)

## Custom HTTP Methods

Bruno supports custom HTTP methods beyond the standard ones (GET, POST, PUT, DELETE, etc.). This is useful for APIs that use non-standard methods like Vault's LIST method or other custom protocols.

### Adding a Custom HTTP Method

1. **Expand the HTTP method dropdown** in the request pane
2. Click **"Add Custom"** from the dropdown options
3. **Type your custom method name** in the input field (e.g., `LIST`, `PATCH`, `SEARCH`)

![custom-http-method](/screenshots/send-request/rest/custom-http-methods.webp)