2026-05-31 01:47:39 +00:00
# Distributor CLI
## Shortest useful command
```sh
2026-05-31 02:07:30 +00:00
go run ./cmd/distributor validate examples/source-bundle
2026-05-31 01:47:39 +00:00
```
2026-05-31 02:07:30 +00:00
This validates a local source bundle fixture.
2026-05-31 01:47:39 +00:00
## Command overview
```sh
distributor --help
distributor version
distributor run
distributor validate
distributor inspect
```
`version` prints the application name and version. The default development version is `dev` ; release builds may replace it at build time.
2026-05-31 01:53:13 +00:00
`run --config <path> --dry-run` loads and validates configuration, then prints a concise summary of configured pipelines and destinations. It does not discover bundles or publish files yet.
2026-05-31 02:07:30 +00:00
`validate <path>` validates a local source bundle directory or a local tree containing source bundles.
`inspect <path>` validates discovered local source bundles and prints a concise normalized summary.
`run` without `--dry-run` intentionally fails with a clear `not implemented` error until execution behavior exists.
2026-05-31 01:47:39 +00:00
## Flag reference
The root command supports:
- `--help` , `-h` : print root help.
2026-05-31 01:53:13 +00:00
Each subcommand supports:
2026-05-31 01:47:39 +00:00
- `--help` , `-h` : print command-specific help.
2026-05-31 01:53:13 +00:00
`run` supports:
- `--config <path>` : config file to load.
- `--dry-run` : validate config and print the resolved summary without publishing.
## Common workflows
2026-05-31 02:07:30 +00:00
Validate a source bundle:
```sh
go run ./cmd/distributor validate examples/source-bundle
```
Inspect a source bundle:
```sh
go run ./cmd/distributor inspect examples/source-bundle
```
2026-05-31 01:53:13 +00:00
Validate a config file without publishing:
```sh
go run ./cmd/distributor run --config examples/local-to-local.yml --dry-run
```