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

# Use Poolside

> Choose where to use Poolside and how to connect it to your development workflow.

Poolside supports several ways to work with agentic coding models. Choose a path based on where you want to work, then follow the guide for that surface.

Some paths run Poolside's agent directly, such as Poolside Agent CLI and ACP-compatible editors. Other paths use a third-party tool that calls Poolside models through the providers each tool supports.

## Where to use Poolside

| Surface      | Best for                                                       | Start here                                             |
| ------------ | -------------------------------------------------------------- | ------------------------------------------------------ |
| Terminal     | Interactive agent work, scripts, CI jobs, and other automation | [Poolside Agent CLI](/cli/pool)                        |
| Editors      | Working with Poolside where you write code                     | [Editors](/cli/editor-integration)                     |
| Desktop apps | Using a dedicated app experience outside your editor           | [Desktop apps](/tools/desktop-apps)                    |
| Agent tools  | Using Poolside models in external coding agents                | [OpenCode](/tools/opencode) or [Hermes](/tools/hermes) |
| Applications | Sending model requests from your own tools and services        | [Poolside API](/api/overview)                          |

## Choose a path

### Work from the terminal

Use [Poolside Agent CLI](/cli/pool) for interactive, multi-turn terminal sessions or one-shot automation with `pool exec`.

<CardGroup cols={2}>
  <Card title="Work with Poolside from the terminal" icon="terminal" href="/cli/interactive-mode">
    Use `pool` for interactive, multi-turn sessions.
  </Card>

  <Card title="Automate tasks" icon="bolt" href="/cli/automated-mode">
    Use `pool exec` for scripts, CI jobs, and one-shot tasks.
  </Card>
</CardGroup>

### Work in an editor

Use [Editors](/cli/editor-integration) to choose between Poolside Assistant, ACP-compatible editors, and editor extensions that can call Poolside models.

<CardGroup cols={2}>
  <Card title="JetBrains" icon="window" href="/tools/jetbrains">
    Use Poolside in JetBrains.
  </Card>

  <Card title="Neovim with CodeCompanion" icon="keyboard" href="/tools/neovim">
    Use Poolside in Neovim with CodeCompanion.
  </Card>

  <Card title="Zed" icon="code" href="/tools/zed">
    Use Poolside in Zed.
  </Card>

  <Card title="Other ACP-compatible editor" icon="plug" href="/tools/other-acp">
    Use Poolside in another ACP-compatible editor.
  </Card>

  <Card title="Poolside Assistant for VS Code" icon="https://mintlify.s3.us-west-1.amazonaws.com/poolside/logo/poolside-icon-purple.svg">
    Use Poolside Assistant inside VS Code.
  </Card>

  <Card title="Poolside Assistant for Visual Studio" icon="https://mintlify.s3.us-west-1.amazonaws.com/poolside/logo/poolside-icon-purple.svg">
    Use Poolside Assistant inside Visual Studio on Windows.
  </Card>

  <Card title="Cline" icon="puzzle-piece" href="/tools/cline">
    Use Poolside models in Cline.
  </Card>

  <Card title="GitHub Copilot" icon="puzzle-piece" href="/tools/copilot">
    Use Poolside models in GitHub Copilot.
  </Card>

  <Card title="Kilo Code" icon="puzzle-piece" href="/tools/kilo-code">
    Use Poolside models in Kilo Code.
  </Card>
</CardGroup>

### Use a desktop app

Use [desktop apps](/tools/desktop-apps) when you want a dedicated app experience outside your editor.

<CardGroup cols={2}>
  <Card title="Poolside Assistant for desktop" icon="https://mintlify.s3.us-west-1.amazonaws.com/poolside/logo/poolside-icon-purple.svg" href="/tools/desktop-apps">
    Use the Poolside Assistant desktop app.
  </Card>

  <Card title="Goose" icon="desktop" href="/tools/desktop-apps">
    Use Poolside models in Goose.
  </Card>
</CardGroup>

### Use an agent tool

Use agent tools when you want another coding agent to call Poolside models.

<CardGroup cols={2}>
  <Card title="Hermes" icon="robot" href="/tools/hermes">
    Use Poolside models in Hermes.
  </Card>

  <Card title="OpenCode" icon="puzzle-piece" href="/tools/opencode">
    Use Poolside models in OpenCode.
  </Card>
</CardGroup>

### Build applications

Use the [Poolside API](/api/overview) when you want to call Poolside models from your own application, internal tool, script, or service. Poolside provides an OpenAI-compatible API, so you can call it directly or use the OpenAI SDK with the Poolside base URL and API key.

<CardGroup cols={2}>
  <Card title="Poolside API" icon="brackets-curly" href="/api/overview">
    Find your base URL and API key, then make your first request.
  </Card>

  <Card title="OpenAI-compatible API examples" icon="flask" href="/api/openai-api-examples">
    See endpoint reference, extra context, and tool use.
  </Card>
</CardGroup>

After you choose where to work, see [Configure](/configure) to shape agent behavior and control what it can do.