# tundish

> tundish is a local inbox for agents that stores JSON items in named queues in one SQLite file and delivers subscription text through hooks.

Each link below opens a page's Markdown twin. Diátaxis sections are Tutorials, How-to guides, Reference, and Optional; Optional holds explanation pages and may be skipped. Installation packages are Homebrew `cjohnhanson/tap/tundish`, crate `tundish`, PyPI `tundish`, and npm `tundish`.


## Tutorials

- [Getting started with tundish](https://tundish.eng.rip/getting-started.md): Publish an item, pull and ack it, then receive another through a gaff handler

## How-to guides

- [How to deliver tundish items through a gaff handler](https://tundish.eng.rip/how-to-gaff.md): Inject due batches into an agent session with a gaff handler
- [How to publish into tundish from a program](https://tundish.eng.rip/how-to-publish.md): Publish JSON from Python and receive Slack message events through Socket Mode

## Reference

- [CLI reference](https://tundish.eng.rip/cli-reference.md): Commands, subscription rules, configuration, output, and exit codes

## Optional

- [What is tundish?](https://tundish.eng.rip/what-is-tundish.md): Queues, subscriptions, local storage, delivery, and retention