Repository Markdown is the authored source for engineering guidance. The website is maintained and published separately from kumo-ai/docs. Keep one maintained explanation per topic and link to it from agent guidance.
| Need | Start here |
|---|---|
| Product and available source interfaces | Repository overview |
| System topology and execution boundaries | Architecture |
| Development prerequisites and setup side effects | Setup |
| Local StateDB inspection and reset behavior | SQLite |
| Run tests without cloud credentials | Public tests |
| Choose a validation tier | Testing |
| Regenerate derived files | Generated artifacts |
| UI conventions and shared components | UI development |
| Query and training review | ML development |
| Review and PR requirements | Review guide |
Publish the kumo-engine wheel |
Releasing kumo-engine |
| Use a coding agent | Agent setup |
| Deploy the application or inspect infrastructure examples | Helm boundary and index |
| Cloud storage integration | Storage contract |
| Maintain documentation | Maintenance |
Use the architecture map for package roles and these guides for their interfaces and development workflows.
| Package | Existing entry point |
|---|---|
| API schemas | kumo-api |
| Service Python client | kumo-sdk |
| In-process Python interface | kumo-engine |
| Shared execution runtime | kumo-core |
| Query language | kumo-pql and existing instructions |
| UI component library | catalog and existing component guide |
| Native graph engine | DiskGraph; maintained directly in this repository |
| Source providers | S3, GCS, ADLS, BigQuery, Databricks, Snowflake |