Skip to content
Draft
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
21 changes: 21 additions & 0 deletions docs/GETTING_STARTED.md
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,9 @@ Sidecars let you run validations in a clean cloud environment. The typical loop:
chunk sidecar create
chunk sidecar create --name my-sidecar

# Create several at once (see "Parallel sidecars" below)
chunk sidecar create --count 3

# Set it as active
chunk sidecar use <id>

Expand Down Expand Up @@ -238,6 +241,24 @@ To fall back to the git checkout/patch approach (requires the branch to be pushe
chunk sidecar sync --checkout
```

### Parallel sidecars

A single sidecar is just a group of one — the same commands work for any number. Pass `--count` to `create` to spin several up in parallel and set them as the active group:

```bash
chunk sidecar create --count 3 # 3 fresh sidecars, set as the active group
chunk sidecar create --count 3 --name pr-1234 # named pr-1234-1, pr-1234-2, pr-1234-3
```

Once a group is active, `sync` fans out to all of its sidecars automatically (or target an explicit set with `--sidecar-ids`):

```bash
chunk sidecar current # lists every sidecar in the active group
chunk sidecar sync # one bundle, delivered to all in parallel
```

`chunk validate` uses a group on its own: when two or more commands are marked `remote` in `.chunk/config.json` (and you're not forcing everything remote with `--remote`), it creates one sidecar per remote command and runs them in parallel, then runs any local commands. An existing active group with a matching sidecar count is reused instead of creating new ones.

### Environment setup

Auto-detect your tech stack and save it to config:
Expand Down
Loading