19 lines
1.0 KiB
Markdown
19 lines
1.0 KiB
Markdown
# distributor
|
|
|
|
`distributor` validates manifested report bundles and publishes selected source or generated artifacts to configured destinations.
|
|
|
|
It is a local-first CLI with SSH/SFTP, S3-compatible storage, and HTTP upload
|
|
support: source bundles can be read from local or remote storage, pushed to the
|
|
upload API, published to local directories or remote paths, and rendered from
|
|
Markdown to HTML sidecars or `index.html`.
|
|
|
|
Go producers can use `gitea.maximumdirect.net/eric/distributor/pkg/bundle` to build, write, parse, and validate complete local source bundles with the same manifest contract used by `distributor`.
|
|
|
|
Run the local example pipeline:
|
|
|
|
```sh
|
|
go run ./cmd/distributor run --config examples/local-publish.yml
|
|
```
|
|
|
|
See [docs/cli.md](docs/cli.md), [docs/config.md](docs/config.md), [docs/operations.md](docs/operations.md), and [docs/troubleshooting.md](docs/troubleshooting.md) for the implemented CLI, configuration, operating notes, and common failure modes. Future and deferred work lives under `docs/roadmap/`.
|