Documentation
Start here, then choose a task.
octet is a fast, small coding host across cloud and local models. Extensions add tools and bounded host-shaped integrations; they do not promise Pi execution parity or an everything-as-extension platform. These docs describe octet 0.8.0; see installation for supported channels.
Getting started#
Usage#
- Terminal, plain and print modes
- Commands and keyboard shortcuts
- CLI options
- Tools
- Models, providers and reasoning
- Images and audio
- Sessions and goals
- Session file format
- Context and compaction
Configuration#
- Settings
- Permissions
- Instructions, prompt templates and skills
- Resource discovery
- Themes
- Shell aliases
- tmux setup
- Herdr integration
- Windows setup
- Termux (Android)
Integrations#
Development#
- Extension authoring
- Extension event bus (bounded, host-mediated)
- Extension API 0.4 and retained wire reference
- Native embedding — host protocol 1
- Examples and their compatibility status
- Architecture: model clients, agent runtime, application, terminal renderer
- Performance and measurement contract
- Build profiles
- Distribution
- Maintainer prompts, skills and playbooks
- Contributing
Project#
- Security
- Changelog
- 0.8.0 release notes
- 0.7.6 hotfix notes
- 0.7.5 release notes
- 0.7.4 release notes and documentation correction
- 0.7.3 release notes
- 0.7.1 release notes
- Benchmarks and performance
- Download benchmark results
- Brand Kit
- License and attribution
Previous reference headings remain available as topic links.
Moved sections
These earlier section links now continue in the references below.
#quick-start→ Models, providers and reasoning#use-a-cloud-model→ Models, providers and reasoning#use-custom-openai-compatible-providers→ Models, providers and reasoning#start→ Getting started#providers→ Models, providers and reasoning#workflows→ Basic usage#extensions→ Extension authoring#agent-loop→ Agent runtime reference#migrate→ Pi import and restore#reference→ CLI options