https://github.com/kohaku-lab/kt-template
A template project for create KohakuTerrarium creatures/plugins and more
https://github.com/kohaku-lab/kt-template
Last synced: 2 months ago
JSON representation
A template project for create KohakuTerrarium creatures/plugins and more
- Host: GitHub
- URL: https://github.com/kohaku-lab/kt-template
- Owner: Kohaku-Lab
- License: other
- Created: 2026-04-22T12:51:05.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2026-04-24T21:01:52.000Z (3 months ago)
- Last Synced: 2026-04-24T23:10:11.191Z (3 months ago)
- Language: Python
- Size: 24.4 KB
- Stars: 2
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# kt-template
Clone this folder to start a new KohakuTerrarium package.
It is structured as a real reusable pack, not just a loose example:
- `kohaku.yaml` — package manifest used by `kt install`
- `creatures/` — standalone creature templates
- `terrariums/` — multi-creature terrarium templates
- `kt_template/` — installable Python package for reusable code
## What is included
### Standalone creature template
`creatures/template-creature/` includes:
- a heavily commented `config.yaml`
- prompt files
- memory files
- a full template for every custom extension surface:
- tool
- input
- output
- trigger
- sub-agent config export
- plugin
- each template demonstrates the full user-facing author API for that surface,
with comments showing what every overrideable method or field is for
Run it with:
```bash
kt run creatures/template-creature
```
## Terrarium template
`terrariums/template-team/` includes:
- a commented `terrarium.yaml`
- a root prompt
- three creature roles wired through channels
Run it with:
```bash
kt terrarium run terrariums/template-team
```
## Package usage
Install locally in editable mode while developing:
```bash
kt install ./kt-template -e
```
Then run by package reference:
```bash
kt run @kt-template/creatures/template-creature
kt terrarium run @kt-template/terrariums/template-team
```
## How to customize
1. Rename the package in `kohaku.yaml`.
2. Rename `kt_template/` to your own Python package name.
3. Rename the creature and terrarium folders.
4. Update `module:` paths in creature configs if you move files.
5. Replace prompt and memory content with your actual persona and workflow.
## Notes on config shape
This repository's config loader accepts custom-module options as inline fields.
That is why the sample configs here use:
```yaml
- name: my_tool
type: custom
module: ./tools/my_tool.py
class: MyTool
greeting: hello
```
instead of nesting those extra fields under `options:`.
## Suggested first edits
- `kt-template/kohaku.yaml`
- `kt-template/creatures/template-creature/config.yaml`
- `kt-template/creatures/template-creature/prompts/system.md`
- `kt-template/terrariums/template-team/terrarium.yaml`
- `kt-template/kt_template/tools/package_tool.py`