Files
distributor/README.md

16 lines
1009 B
Markdown
Raw Normal View History

# distributor
2026-05-30 21:59:32 +00:00
2026-05-31 04:02:09 +00:00
`distributor` validates manifested report bundles and publishes selected source or generated artifacts to configured destinations.
2026-06-01 21:33:12 +00:00
It is a local-first CLI with SSH/SFTP and S3-compatible storage support: source bundles can be read from local or remote storage, destinations can be local directories or remote paths, and Markdown files can be rendered to HTML sidecars or `index.html`.
2026-06-01 20:56:58 +00:00
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`.
2026-06-01 20:52:23 +00:00
2026-05-31 02:21:36 +00:00
Run the local example pipeline:
2026-05-31 01:47:39 +00:00
```sh
2026-05-31 02:21:36 +00:00
go run ./cmd/distributor run --config examples/local-publish.yml
2026-05-31 01:47:39 +00:00
```
2026-06-01 21:45:24 +00:00
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/`.