octet

Documentation Getting started

Basic usage

Read a repository, make a change and verify it.

Documentation · Getting started

Start a session#

From your repository, using your source-built binary and a configured provider:

sh
octet --safe-mode
text
Explain how this project handles authentication. Show me the relevant files.

Safe mode asks before file changes and every shell call. It is not a sandbox; use OS isolation for untrusted code. Full access is the default without it. Tools and permissions.

Make a change#

text
Fix the parser's handling of empty input. Add a regression test and run it.
Do not commit the change.

Review proposed actions before approving them, then inspect the resulting diff and tests yourself. Name the goal, constraints, and expected result explicitly; use prompt templates for repeated tasks. /answer [instruction] asks for an answer from existing evidence at the next safe boundary instead of further tools. Run controls.

Resume work#

sh
octet --continue

This reopens the latest current-workspace session. Use octet --resume SESSION_ID for a specific session, /fork for an earlier user message, or /clone for the current head. Sessions.

Images and audio#

Explicitly paste/drop a path through the terminal paste mechanism, or select it with @ completion. Check the image/audio chip before submitting; typed paths alone are not attachments. Native audio is WAV/MP3 only on compatible OpenAI Chat routes; the graphical composer does not accept audio. See the audio/image recipe, formats, limits, and privacy rules.

Subagents#

With the subagents package enabled and independently trusted:

text
Have one worker trace the parser and another inspect its tests.
Give both only read and search tools. Summarize their findings; do not edit.

Workers otherwise inherit the parent's standard read/search/edit/write/bash scope. The host enforces depth one, at most eight active children and thirty-two retained records, inherited policy and cost/token limits, cancellation, and owner-authorized read-only transcripts. A shared cwd is not isolation. Open /subagents to inspect phase, tool calls, tokens, spend, and transcripts. Cleanup retains bounded terminal diagnostics/roster when a live record disappears; child spend is persisted once in the root ledger before settlement.

Executable extensions require full-access mode and use your OS authority. Install/enable/trust are separate; publication-gated package setup. The working-tree bundle declares API 0.4; exact host-version pins still apply.

Extend or embed#