Reference
crab config
Read and write Crab configuration settings.
Synopsis
crab config get <KEY>
crab config set <KEY> <VALUE>
crab config listDescription
crab config manages Crab's configuration stored in .crab/config.toml.
Settings control behavior like download concurrency, cache size limits,
and default hydration patterns.
For conceptual background, see Configuration.
Common Keys
| Key | Type | Default | Description |
|---|---|---|---|
checkout.lazy | boolean | false | Leave files as pointers on checkout. |
hydrate.include | array | [] | Default include patterns for crab hydrate. |
hydrate.exclude | array | [] | Default exclude patterns for crab hydrate. |
hydrate.auto | boolean | false | Automatically hydrate matching files. |
workflow.enabled | boolean | false | Enable workflow, stage, experiment, metric, plot, and queue commands. |
workflow.discover | enum | root | Use root discovery, or recursive for nested crab.yaml and *.workflow.yaml files. |
workflow.lockfile | enum | single | Use one crab.lock, or split for per-workflow lockfiles. |
workflow.parallelism | integer | 4 | Maximum concurrent stage executions unless overridden by --parallelism. |
workflow.graceful_shutdown_timeout_secs | integer | 10 | Seconds between terminating and killing an over-time stage process. |
workflow.max_outs_per_stage | integer | 10000 | Maximum declared outputs per stage. |
workflow.max_out_bytes | integer | 1099511627776 | Maximum bytes per declared output. |
workflow.lock_timeout_secs | integer | 600 | How long a second workflow run waits for the scheduler lock. |
workflow.remote_cache_readonly | boolean | false | Reject workflow cache pushes while allowing cache reads. |
hydra.enabled | boolean | false | Compose Hydra config groups for experiment parameter overrides. |
hydra.config_dir | string | conf | Hydra config root used by experiment runs. |
hydra.config_name | string | config.yaml | Hydra root config file name. |
Subcommands
get
crab config get download_concurrencyset
crab config set download_concurrency 32
crab config set workflow.enabled true
crab config set workflow.discover recursivelist
crab config listOptions
| Option | Default | Description |
|---|---|---|
--global | false | Read/write global config (~/.crab/config.toml) |
--json | false | Emit structured JSON output |
Related Commands
crab env— display resolved environment.crab auth status— authentication state.