65 lines
1.5 KiB
Markdown
65 lines
1.5 KiB
Markdown
# Distributor CLI
|
|
|
|
## Shortest useful command
|
|
|
|
```sh
|
|
go run ./cmd/distributor validate examples/source-bundle
|
|
```
|
|
|
|
This validates a local source bundle fixture.
|
|
|
|
## 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.
|
|
|
|
`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.
|
|
|
|
`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.
|
|
|
|
## Flag reference
|
|
|
|
The root command supports:
|
|
|
|
- `--help`, `-h`: print root help.
|
|
|
|
Each subcommand supports:
|
|
|
|
- `--help`, `-h`: print command-specific help.
|
|
|
|
`run` supports:
|
|
|
|
- `--config <path>`: config file to load.
|
|
- `--dry-run`: validate config and print the resolved summary without publishing.
|
|
|
|
## Common workflows
|
|
|
|
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
|
|
```
|
|
|
|
Validate a config file without publishing:
|
|
|
|
```sh
|
|
go run ./cmd/distributor run --config examples/local-to-local.yml --dry-run
|
|
```
|