<p align="center">
<img src="assets/header.svg" width="100%" alt="ALT TEXT FOR THE BANNER"/>
</p>
<p align="center">
<img src="assets/logo.svg" width="200" alt="ALT TEXT FOR THE LOGO"/>
</p>
<h1 align="center">TOOLNAME</h1>
<p align="center">
<em>EMOJI OUTCOME-FIRST TAGLINE, PLAIN ENGLISH, 90 CHARACTERS OR FEWER</em>
</p>
<p align="center">
<a href="LICENSE"><img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License: MIT"/></a>
<a href="https://github.com/scbrown/TOOLNAME/actions/workflows/ci.yml"><img src="https://github.com/scbrown/TOOLNAME/actions/workflows/ci.yml/badge.svg" alt="CI"/></a>
<a href="https://github.com/scbrown/caboodle"><img src="https://img.shields.io/badge/stack-quipu-8B5E3C.svg" alt="Part of the caboodle stack"/></a>
</p>
**TOOLNAME IS A WHAT-IT-IS FOR WHO-IT-IS-FOR. It comes as a CLI, an MCP server
and FORMS.** ONE OR TWO MORE SENTENCES ON WHAT IT DOES FOR THEM. (OPTIONAL: ONE
SENTENCE ON WHERE THE NAME COMES FROM.)
## Why you would want it
- **OUTCOME ONE**, in the reader's terms.
- **OUTCOME TWO**.
- **OUTCOME THREE**.
The full case, and how TOOLNAME compares with the alternatives:
[Why TOOLNAME](docs/book/src/introduction.md).
## Install
Linux x86_64 and macOS (PLATFORMS): download the checksummed release.
```bash
INSTALL COMMAND FROM THE RELEASE
```
Anywhere else, build from source (needs TOOLCHAIN):
```bash
cargo install --git https://github.com/scbrown/TOOLNAME --locked
```
Check it:
```bash
TOOLNAME --version
```
```text
TOOLNAME X.Y.Z
```
If that prints an older version, another copy is earlier on your `PATH`:
`which -a TOOLNAME`.
## First success in three commands
```bash
FIXTURE SETUP (SELF-CONTAINED: A TEMP DIR, A TINY SAMPLE)
COMMAND ONE
COMMAND TWO
```
```text
THE EXACT OUTPUT A CLEAN RUN PRINTS
```
ONE SENTENCE: WHAT THAT OUTPUT SHOWS AND WHY IT MATTERS.
## On your own code
| QUESTION | `COMMAND` |
| QUESTION | `COMMAND` |
| QUESTION | `COMMAND` |
Every command and flag: [CLI reference](docs/book/src/reference.md).
## Wire it into your agent
```bash
MCP ONE-LINER (e.g. claude mcp add TOOLNAME -- TOOLNAME serve)
```
MINIMAL HOOK OR CONFIG, IF ANY.
Hooks, other agents and every option: [Using TOOLNAME with agents](docs/book/src/agents.md).
## Before you start
| TOOLNAME | release | release | build | build |
PREREQUISITES, ONE LINE EACH.
## What's next
- [The TOOLNAME book](docs/book/src/introduction.md): start here to go deeper
- [Docs map](docs/book/src/docs-map.md): every document in this repo, routed
- [NEXT PAGE A NEW USER SHOULD READ](docs/book/src/PAGE.md)
## ๐งบ The stack
Caboodle installs these together and proves each one works; every tool also stands alone.
The Quipu stack is built around a governed, bitemporal knowledge store: shared
facts, decisions and work history your agents can query. Quipu can check writes
against your rules, records where each fact came from, and answers what was true
when.
| [caboodle](https://github.com/scbrown/caboodle) | ๐งฐ Agent Platform Toolkit - installs and configures the quipu stack |
| [quipu](https://github.com/scbrown/quipu) | stores shared facts with provenance and history; can check writes against your rules |
| [camayoc](https://github.com/scbrown/camayoc) | prepares knowledge and vocabulary for Quipu, with checks before it is admitted |
| [bobbin](https://github.com/scbrown/bobbin) | searches your code and can include related knowledge from Quipu |
| [yupana](https://github.com/scbrown/yupana) | shows code impact and can read policies from Quipu to check changes |
| [desire-path](https://github.com/scbrown/desire-path) | turns agent mistakes into feature requests; works on its own without Quipu |
| [seeds](https://github.com/scbrown/seeds) | a work item tracker backed by the Quipu knowledge base |
| [shantytown](https://github.com/scbrown/shantytown) | runs crews of AI agents on work items, triggered by hand, on a schedule or by events; can share work and memory through Quipu |
| [shuttle](https://github.com/scbrown/shuttle) | runs signed agent workflows and keeps their records in Quipu |
## Contributing
```bash
just build
just test
just ci # what CI runs
```
## ๐ License
[MIT](LICENSE)
<p align="center">
<img src="assets/footer.svg" width="100%" alt="ALT TEXT FOR THE FOOTER"/>
</p>