pool command line interface (CLI) to use Poolside from the terminal or in CI.
Prerequisites
- macOS, Linux, or Windows with WSL
curlorwgetinstalled
Steps
Install
Use the command for the download tool in your environment:Use Use The script installs
curl:wget: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. If not, the script prints instructions to add it manually. You can also rerun with POOL_INSTALL_UPDATE_PATH=1 to have the script update your shell config automatically.Authenticate
- Poolside deployment
- Standalone
Use this to connect to your Poolside deployment.Choose browser login or provide an API key. To sign in again later, run
pool login.Verify
For
pool CLI bugs and feature requests, open an issue on GitHub.Configure and inspect paths
Runpool config to see where the CLI stores configuration, credentials, logs, and trajectories.
Run pool config settings to open settings.yaml in your editor. The CLI validates the file when you save 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 API 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.| Variable | What it sets |
|---|---|
POOLSIDE_API_KEY | Auth token |
POOLSIDE_TOKEN | Auth token (alternative) |
POOLSIDE_API_URL | API URL, overrides saved setting |
pool checks these before reading from configuration files.
For authentication, pool checks for credentials in this order:
POOLSIDE_API_KEYPOOLSIDE_TOKENcredentials.json