Skip to main content
Use this page to start working with Poolside Agent CLI from your terminal.

​
Prerequisites

  • Access to a Poolside API URL. If you do not have one, contact your Poolside administrator.
  • A local project or repository you can use for your first task.
  • On macOS or Linux, curl or wget, and tar.
  • On Windows, PowerShell and tar.

​
Get started with pool CLI

1

Install the CLI

On macOS or Linux, run one of the following commands:
curl -fsSL https://downloads.poolside.ai/pool/install.sh | sh

wget -qO- https://downloads.poolside.ai/pool/install.sh | sh
On Windows, run:
irm https://downloads.poolside.ai/pool/install.ps1 | iex
For installation details, see Install Poolside Agent CLI.
2

Authenticate

Connect to your Poolside deployment:
pool login --api-url <api-url>
Replace <api-url> with the API URL for your Poolside deployment.
3

Open a project

Change into the project you want Poolside to work with:
cd <project-path>
4

Ask your first question

Start an interactive session:
pool
Ask Poolside to explain the project:
Summarize this project and explain how the main pieces fit together.
For help writing effective prompts, see Prompting best practices.
5

Make a change

Ask Poolside to identify a low-risk improvement:
Review this codebase for 2-3 low-risk ways to improve maintainability or performance.
Don't make any changes yet.
Explain the impact of each option, then ask which one I want to pursue.
After you choose an option, ask Poolside to make the change:
Make improvement 2.
Poolside might ask for approval before reading files, editing files, or running commands.
6

Review the change

Inspect the changes in your usual development workflow. For example:
git diff
If you want to undo the change, ask Poolside to revert its edits or use your version control workflow.

​
Next steps

Poolside Agent CLI

Learn about interactive mode, automated mode, and CLI commands.

Example prompts

Try prompts for common development tasks.