packages/bruno-cli/docker/README.md
Official Docker images for Bruno CLI, enabling container-native API collection runs in CI/CD pipelines and local environments without requiring Node.js or npm on the host. See the Bruno CLI docs for CLI usage.
docker pull usebruno/cli:latest
docker pull ghcr.io/usebruno/cli:latest
| Variant | Base image | Details |
|---|---|---|
| Alpine (default) | node:22-alpine | → Alpine README |
| Debian | node:22-slim | → Debian README |
Every release publishes the following tags to both Docker Hub (usebruno/cli) and GHCR (ghcr.io/usebruno/cli).
| Tag pattern | Example | Notes |
|---|---|---|
latest | usebruno/cli:latest | Newest release marked as latest. Only moves when the publish workflow is run with "Tag this version as latest" checked. |
latest-alpine | usebruno/cli:latest-alpine | Alias of latest — also alpine. |
alpine | usebruno/cli:alpine | Newest alpine, moves on every alpine publish. |
<version> | usebruno/cli:3.3.0 | Exact version, immutable. |
<version>-alpine | usebruno/cli:3.3.0-alpine | Exact version, explicitly alpine. |
<major.minor> | usebruno/cli:3.3 | Floats with patch releases (3.3.x). |
<major.minor>-alpine | usebruno/cli:3.3-alpine | Same, explicitly alpine. |
<major> | usebruno/cli:3 | Floats with any 3.x.x release. |
<major>-alpine | usebruno/cli:3-alpine | Same, explicitly alpine. |
| Tag pattern | Example | Notes |
|---|---|---|
latest-debian | usebruno/cli:latest-debian | Newest debian release marked as latest (gated by the same checkbox). |
debian | usebruno/cli:debian | Newest debian, moves on every debian publish. |
<version>-debian | usebruno/cli:3.3.0-debian | Exact version, debian. |
<major.minor>-debian | usebruno/cli:3.3-debian | Floats with debian patch releases. |
<major>-debian | usebruno/cli:3-debian | Floats with any 3.x.x debian release. |
The unsuffixed tags (:latest, :3.3.0, :3.3, :3, :alpine) always resolve to the alpine variant by convention.
# latest (alpine by default — smallest, fastest to pull)
docker pull usebruno/cli:latest
# specific version (recommended for production CI)
docker pull usebruno/cli:3.3.0
# major.minor — gets patch updates automatically
docker pull usebruno/cli:3.3
# debian variant
docker pull usebruno/cli:debian
docker pull usebruno/cli:3.3.0-debian
docker run --rm usebruno/cli --version
These examples assume you are running
dockerfrom your Bruno collection directory. Mount that directory to/brunoand passbruarguments directly after the image name. If your collection lives elsewhere on disk, see the path-based examples further down.
Cross-platform note: the examples below use
$(pwd)which works in Bash / Zsh / Git Bash / WSL. On Windows native shells, substitute$(pwd)with${PWD}(PowerShell) or%cd%(CMD).
Adding
bruoptions: The examples below show docker-specific flags. For allbru runoptions — recurse (-r), environments, variables, reporters, bail, and more — see the Bruno CLI docs.
# run every request in the Bruno collection (current dir)
docker run -v $(pwd):/bruno usebruno/cli run
# run a specific subfolder (group of requests) within that collection
docker run -v $(pwd):/bruno usebruno/cli run ./api-tests
# run a single .bru request file from that collection
docker run -v $(pwd):/bruno usebruno/cli run ./api-tests/login.bru
# write a JUnit XML report (lands in the current directory because of the bind mount)
docker run -v $(pwd):/bruno usebruno/cli run --reporter-junit results.xml
For Windows CMD users, swap $(pwd) with %cd%:
docker run -v %cd%:/bruno usebruno/cli run
If your collection is not in your current directory, point docker at its path (relative or absolute) instead of $(pwd):
# run every request in a collection at an arbitrary path
docker run -v /path/to/your/collection:/bruno usebruno/cli run
# run a single .bru file from a collection at an arbitrary path
docker run -v /path/to/your/collection:/bruno usebruno/cli run ./auth/login.bru
Note on
--rm: Examples below include--rm. Docker keeps stopped containers around after they exit, which lets youdocker logsordocker inspectthem later for debugging. If you'd rather have Docker auto-delete the container as soon asbrufinishes — useful for CI runs or to avoiddocker ps -afilling up with stale entries — append--rmto anydocker run(ordocker compose run) command:
docker run --rm -v $(pwd):/bruno usebruno/cli run
It's purely a cleanup convenience; it doesn't affect the image, mounts, stdout output, or exit code.
jobs:
api-tests:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Run Bruno collection
run: |
docker run --rm \
-v ${{ github.workspace }}:/bruno \
usebruno/cli:latest run --output results.xml --format junit
- name: Publish Test Report
uses: dorny/test-reporter@v3
if: success() || failure()
with:
name: Bruno Test Results
path: ${{github.workspace}}/results.xml
reporter: java-junit
api-tests:
image: usebruno/cli:latest
script:
- bru run --output results.xml --format junit
artifacts:
reports:
junit: results.xml
A minimal docker-compose.yml for running a Bruno collection alongside your project:
services:
bruno-cli:
image: usebruno/cli:latest
container_name: bruno-cli-runner
volumes:
- /path/to/collection:/bruno
- /path/to/reports:/reports
command:
run .
-r
--env ci
--reporter-json /reports/results.json
--reporter-junit /reports/results.xml
--reporter-html /reports/results.html
Then run:
docker compose run bruno-cli
The /path/to/reports:/reports mount catches the JSON, JUnit XML, and HTML reports on the host — drop any --reporter-* flag to skip that format.
A ready-to-run docker-compose.yml lives in this repo at packages/bruno-tests/docker-compose.yml. It mounts the sibling collection/ directory into the container, runs the echo folder against the Prod environment, and writes JSON, JUnit XML, and HTML reports into packages/bruno-tests/reports/:
cd packages/bruno-tests
docker compose run bruno-cli
This fires a small set of requests against public endpoints that demonstrate the CLI executing requests and assertions inside a container.
For a clone-and-run demo with a curated collection, see bruno-collections/bruno-cli-docker.
All variants include:
bru/brunonode (UID 1000, non-root)linux/amd64, linux/arm64