Documentation
Start here, then choose a task.
Manual for v0.9.5. Stable release: v0.9.5.
octet is a fast, small coding host for cloud and local models. Extensions add tools and bounded, host-shaped integrations. They don't promise Pi execution parity or an everything-as-extension platform. These docs describe the octet 0.9.5 release. Installation separates source builds from version-pinned publication channels and their recorded qualification.
Getting started#
Usage#
- Terminal, plain and print modes
- Commands and keyboard shortcuts
- CLI options
- Tools
- Models, providers and reasoning
- Inference measurements
- 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
- Tern native surfaces
- Herdr integration
- Linux setup (Omarchy/Hyprland)
- Windows setup
- Termux (Android)
Integrations#
- Subagents
- Computer use
- Web search
- MCP
- Pi import and restore
- Pi extension adapter (source-only; not shipped in v0.9.5)
- Pi extension compatibility: release status and merge notes
Development#
- Extension authoring
- Extension event bus (bounded, host-mediated)
- Extension API 0.4 and retained wire reference
- Remote component UI (API 0.4)
- Native embedding — host protocol 1
- Examples and their compatibility status
- Architecture: model clients, agent runtime, application, terminal renderer
- Performance and measurement contract
- Build profiles
- Testing lanes
- Distribution
- Maintainer prompts, skills and playbooks
- Contributing
Project#
- Security
- Changelog
- Release notes: 0.9.5, 0.9.4, 0.9.3, 0.9.2, 0.9.1, 0.9.0, 0.8.2, 0.8.1, 0.8.0, 0.7.6 hotfix, 0.7.5, 0.7.4 and its documentation correction, 0.7.3, 0.7.1
- Benchmarks and performance
- Download benchmark results
- Brand Kit
- License and attribution
Looking for an older section name? Previous reference headings still work 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