Add source bundle validation and inspection
This commit is contained in:
22
docs/cli.md
22
docs/cli.md
@@ -3,10 +3,10 @@
|
||||
## Shortest useful command
|
||||
|
||||
```sh
|
||||
go run ./cmd/distributor run --config examples/local-to-local.yml --dry-run
|
||||
go run ./cmd/distributor validate examples/source-bundle
|
||||
```
|
||||
|
||||
This loads and validates the example config, then prints the resolved pipeline summary without publishing files.
|
||||
This validates a local source bundle fixture.
|
||||
|
||||
## Command overview
|
||||
|
||||
@@ -22,7 +22,11 @@ distributor inspect
|
||||
|
||||
`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.
|
||||
|
||||
`run` without `--dry-run`, `validate`, and `inspect` intentionally fail with a clear `not implemented` error until the corresponding application behavior exists.
|
||||
`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
|
||||
|
||||
@@ -41,6 +45,18 @@ Each subcommand supports:
|
||||
|
||||
## 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
|
||||
|
||||
Reference in New Issue
Block a user