README.md

# 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/`.
Final cleanup before beginning the MVP implementation 2026-05-30 20:33:53 -05:00			`# distributor`
Initial commit 2026-05-30 21:59:32 +00:00
Tighten local MVP user documentation 2026-05-31 04:02:09 +00:00			`distributor` validates manifested report bundles and publishes selected source or generated artifacts to configured destinations.

Close out HTTP upload documentation 2026-06-03 15:30:02 +00:00			`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`.
Final cleanup before beginning the MVP implementation 2026-05-30 20:33:53 -05:00
Add public local bundle writer 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`.
Add public bundle manifest package 2026-06-01 20:52:23 +00:00
Add local source publication 2026-05-31 02:21:36 +00:00			`Run the local example pipeline:`
Add initial distributor CLI skeleton 2026-05-31 01:47:39 +00:00
			```sh
Add local source publication 2026-05-31 02:21:36 +00:00			`go run ./cmd/distributor run --config examples/local-publish.yml`
Add initial distributor CLI skeleton 2026-05-31 01:47:39 +00:00			```

Clean up completed roadmap entries 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/`.