Skip to main content

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.

Install the pool command line interface (CLI) to use Poolside from the terminal or in CI.

​
Prerequisites

  • On macOS or Linux, curl or wget, and tar
  • BETA On Windows, PowerShell and tar

​
Steps

1

Install

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

wget -qO- https://downloads.poolside.ai/pool/install.sh | sh
The script installs pool to ~/.local/bin by default unless POOL_INSTALL_DIR or XDG_BIN_HOME is set. If that directory is already on your PATH, the CLI is ready to use immediately. Otherwise, the installer either prompts to add it to your shell config or prints instructions to add it manually. You can rerun with POOL_INSTALL_UPDATE_PATH=1 to update your shell config automatically.
2

Authenticate

Choose the option that matches where you use Poolside:
Use this to connect to your Poolside deployment.
pool setup --api-url https://your-deployment.example.com
Choose browser login or provide an API token. To sign in again later, run pool login.
3

Verify

pool --version
Then choose the workflow you want to use:
For pool CLI bugs and feature requests, open an issue on GitHub.

​
Configure and inspect paths

Run pool config to see where the CLI stores configuration, credentials, logs, and trajectories. Run pool config settings to edit settings.yaml in your editor. After the editor exits, the CLI validates the file before saving it. By default, Poolside stores configuration files in ~/.config/poolside. This includes settings.yaml, which stores the saved API URL and other CLI settings, and credentials.json, where the CLI stores your saved auth token. If your environment uses a custom configuration directory, pool uses that location instead. Set POOLSIDE_API_URL to override the API URL saved in settings.yaml without editing the file.

​
CI and automation

Use environment variables instead of stored credentials in non-interactive environments.
VariableWhat it sets
POOLSIDE_API_KEYAuth token for a Poolside deployment or standalone mode
POOLSIDE_TOKENAlternative auth token for a Poolside deployment
POOLSIDE_API_URLAPI URL, overrides the saved setting
pool checks these before reading from configuration files. For authentication, pool checks in this order:
  • When connected to a Poolside deployment: POOLSIDE_API_KEY, POOLSIDE_TOKEN, then credentials.json
  • In standalone mode: POOLSIDE_API_KEY, then credentials.json