Registry stack documentation: machine-readable Markdown.
Index of all pages: https://docs.registrystack.org/dev/llms.txt
Full corpus: https://docs.registrystack.org/dev/llms-full.txt

# caseworkctl source add command reference

> Generated syntax and options for caseworkctl source add.

{/* Generated from Clap command definitions by scripts/generate-cli-reference.mjs. Run npm run generate. */}

Preview or apply one local Base Registry Engine (BReg) connection.

## Contract status

This page is generated from the public Clap command tree for Registry Stack source version `0.30.0` and catalog SHA-256 `2221f17eae216048d4cfaf7f66e3dcd68a250f6f6de4e24b177441819192b475`. Hidden implementation commands are omitted.

## Usage

```text
caseworkctl source add [OPTIONS] --project <CASEWORK_PROJECT> --source-id <SOURCE_ID> <BREG_PROJECT>
```

## Arguments

| Argument | Always required | Default | Values | Environment | Description |
| --- | --- | --- | --- | --- | --- |
| `<BREG_PROJECT>` | Yes | n/a | n/a | n/a | Authored Base Registry Engine project |

## Options

| Option | Always required | Default | Values | Environment | Description |
| --- | --- | --- | --- | --- | --- |
| `--project <CASEWORK_PROJECT>` | Yes | n/a | n/a | n/a | Authored Casework project |
| `--source-id <SOURCE_ID>` | Yes | n/a | n/a | n/a | Stable Casework source identifier |
| `--apply` | No | n/a | n/a | n/a | Apply the exact reported local authoring changes |
| `--bregctl-bin <BREGCTL_BIN>` | No | `bregctl` | n/a | `BREGCTL_BIN` | Public bregctl binary of the same Registry Stack version |
| `--format <FORMAT>` | No | `human` | `human`, `json` | n/a | Emit the selected command's report in this format |
| `-h, --help` | No | n/a | n/a | n/a | Print help |

## Generation contract

Run `npm run generate` from `docs/site` after changing a public command, argument, option, default, environment binding, or help description.