> ## Documentation Index
> Fetch the complete documentation index at: https://docs.termyte.xyz/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Install Termyte, connect a coding agent, and verify capture.

# Get Termyte running

## 1. Install it

Termyte requires Node.js 20 or newer.

```bash theme={null}
npm install -g termyte
termyte help
```

## 2. Connect your agents

```bash theme={null}
termyte init
```

Setup detects Claude Code, Codex, and OpenCode. Choose one or more for capture, then choose how memories should be formed:

* verified Claude Code, Codex, or OpenCode authentication;
* an OpenAI-compatible endpoint using `TERMYTE_LLM_API_KEY`;
* capture only.

Agent mode runs the selected CLI non-interactively in the background. API mode calls the configured endpoint. Capture-only mode stores events without forming observations or memories.

## 3. Check the installation

Restart the selected agents, use one on a real repository, then run:

```bash theme={null}
termyte doctor
termyte viewer
```

`doctor` reports the database path, installed hooks, queue state, pending traces, and recent context effects. The Viewer lets you inspect sessions, Work Thread episodes, stored history, context decisions, and runtime failures.

## 4. Create a Work Thread

A Work Thread keeps one task, its current state, and its evidence together. The CLI command is still `termyte task`.

```bash theme={null}
termyte task create \
  --repo github.com/acme/app \
  --title "Fix login redirect" \
  --objective "Return users to the page they requested"
```

The command prints JSON containing the task ID and version. Use those values when adding a step:

```bash theme={null}
termyte task add-step \
  --task <task-id> \
  --title "Reproduce the redirect failure" \
  --position 1 \
  --version 1
```

<Note>
  Task versions prevent an older agent or terminal from overwriting newer state. Use the version returned by the most recent task command.
</Note>

## Next steps

<CardGroup cols={2}>
  <Card title="Work with tasks" icon="list-check" href="/guides/tasks">
    Add steps and record explicit verification.
  </Card>

  <Card title="Checkpoint and resume" icon="rotate" href="/guides/checkpoints-and-resume">
    Save Git state and see what changed before continuing.
  </Card>

  <Card title="Choose an integration" icon="plug" href="/integrations/overview">
    Compare capture and context support.
  </Card>

  <Card title="Troubleshooting" icon="wrench" href="/reference/troubleshooting">
    Diagnose setup, queues, and missing capture.
  </Card>
</CardGroup>