yoi/README.md

1.5 KiB

Yoi

Yoi is an agent runtime for building, running, and orchestrating LLM Pods while preserving explicit history, scoped capabilities, and developer-controlled workflows.

Runtime surfaces use yoi, .yoi, ~/.yoi, and YOI_*.

Documentation map

Start with docs/README.md. The repository documentation is intentionally small: it should explain current design intent and development workflow, not preserve every old plan or external research note.

Important entry points:

Development

This repository dogfoods Yoi to develop Yoi. Work is tracked through work-items/ and ./tickets.sh; git history plus work item files are the authoritative record of state changes.

Common local checks:

./tickets.sh doctor
git diff --check
cargo test --workspace

E2E testing with real spawned processes is not yet designed. Avoid adding compatibility layers or broad formatting churn only to reduce short-term edit size; prefer clear boundaries and type safety.