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

# Quickstart

> Five minutes to your first refactor.

<Steps>
  <Step title="Launch">
    ```bash theme={null}
    cd your-project
    soulforge
    ```

    The first launch scans your codebase to build a live graph (a few seconds). Press `Ctrl+L` to pick a model.
  </Step>

  <Step title="Ask something">
    Type any question. The agent already knows your file layout.

    ```
    > what does the auth middleware do?
    ```
  </Step>

  <Step title="Make a change">
    Describe the change in plain English.

    ```
    > rename UserService to AccountService across the project
    ```

    Watch the agent run `rename_symbol` — one tool call updates every file.
  </Step>

  <Step title="Commit">
    Press `Ctrl+G`, then `c`. SoulForge writes the commit message and runs lint + typecheck before committing. Or just say:

    ```
    > commit my changes
    ```
  </Step>
</Steps>

## Essential shortcuts

| Key                 | Does                          |
| ------------------- | ----------------------------- |
| `Ctrl+L`            | Switch model                  |
| `Ctrl+E`            | Toggle editor panel (Neovim)  |
| `Ctrl+G`            | Git menu                      |
| `Ctrl+K`            | Command palette               |
| `Ctrl+B` / `Ctrl+F` | Browse prev / next checkpoint |
| `Ctrl+X`            | Stop the agent                |
| `Ctrl+T` / `Ctrl+W` | New tab / close tab           |

## Common tasks

<CardGroup cols={2}>
  <Card title="Rename & refactor" href="/recipes/rename-refactor" icon="pen">
    Rename a symbol across every file with one prompt.
  </Card>

  <Card title="Test, lint, commit" href="/recipes/test-and-commit" icon="check">
    Run your toolchain through the agent.
  </Card>

  <Card title="Use multiple models" href="/recipes/task-router" icon="route">
    Cheap model for search, strong model for code.
  </Card>

  <Card title="Run from CI" href="/recipes/headless" icon="server">
    Headless mode for scripts and pipelines.
  </Card>

  <Card title="Reach it from your phone [experimental]" href="/tools/hearth" icon="mobile">
    Hearth — Telegram or Discord. (Experimental — expect rough edges.)
  </Card>

  <Card title="Connect MCP servers" href="/tools/mcp" icon="plug">
    GitHub, Sentry, anything MCP.
  </Card>
</CardGroup>

## Next

* Browse the [recipes](/recipes/rename-refactor) for copy-paste workflows.
* Skim [commands](/reference/commands) — type `/` to see them all in the app.
* Tune `~/.soulforge/config.json` — see [configuration](/reference/configuration).