Quickstart - Poolside

Prerequisites

Step 1: Install Poolside Agent CLI

Run one of the following commands:

Install with curl

curl -fsSL https://downloads.poolside.ai/pool/install.sh | sh

Install with wget

wget -qO- https://downloads.poolside.ai/pool/install.sh | sh

In PowerShell, run:

irm https://downloads.poolside.ai/pool/install.ps1 | iex

Verify the installation:

pool --version

The command prints the installed version. For installation details, see Install Poolside Agent CLI.

Step 2: Log in

Run:

pool login

Looking for the fastest way to get a free Poolside API key? Choose Use Poolside Platform for free (recommended).

Choose how you want to access models with the Poolside agent:

Option shown in the CLI Description
Use Poolside Platform for free (recommended) Choose this option for fast, free developer access. Sign in to Poolside Platform, then copy the API key it creates for you. Recommended for most users.
Use your organization’s Poolside deployment (enterprise) Choose this option if your organization has a Poolside deployment.
Use your OpenRouter account Choose this option if you already use OpenRouter or need paid access to Poolside models.
Connect an OpenAI-compatible provider Choose this option if you use another provider, your own server, or an organization gateway that serves Poolside models.

For more information, including where to get an API key or token, see Log in to Poolside.

Step 3: Start a session

Go to the project directory you want to work in and start pool:

cd <project-path>
pool

The session stays open so you can:

Send your first prompt:

Summarize this project and suggest one small improvement.

You know setup worked when Poolside responds in the terminal and waits for your next prompt.

Next steps

Keep working in the terminal \n\ Use pool for longer interactive sessions.

Use Poolside in an editor \n\ Connect Poolside to an editor or editor extension.

Automate a task \n\ Use pool exec for one-shot prompts and scripts.

Call the API \n\ Send model requests from your own tools and services.

Example prompts \n\ Try prompts for common development tasks.

Configure Poolside \n\ Shape agent behavior and control what it can access.