Skip to main content
The PPIO CLI manages sandboxes, runs commands, builds templates and performs common development tasks from the terminal. The command is ppio, installed from the ppio-sandbox-cli package. This page installs it, points it at PPIO, and signs it in.

Install

1

Install the CLI

Install the package globally so the ppio command is on the path.
2

Set the environment variables

Set two environment variables before running any example. Replace <your-api-key> with a key from the API Keys page of the console.
The SDK and the CLI read both variables from the environment.
string
Authenticates requests to Agent Sandbox.
string
Selects the Agent Sandbox service for ppio.ai. Without it, the SDK and the CLI connect to their built-in default service instead.
These commands set the variables for the current terminal session only.
3

Check the API key

The CLI reads PPIO_API_KEY and PPIO_DOMAIN from the environment. A list call confirms that the key reaches the PPIO Agent Sandbox service.
Authenticate before the CLI acts on sandboxes. The ppio auth command group manages the login session, the active team and the login stored at ~/.ppio/config.json.

Sign in

1

Run the login command

ppio auth login signs in to PPIO.
2

Approve the request in the browser

The CLI opens a browser-based authorization page. After approval, it stores the session, selects the default team, and writes the login to ~/.ppio/config.json.
On success, the CLI prints the signed-in email and the selected team:
Output
If a session already exists, the command reports the current session instead of signing in again. To sign in as a different user, run ppio auth logout first. To switch teams, run ppio auth configure.

Sign out

ppio auth logout signs out. It deletes the local login file at ~/.ppio/config.json.
It prints Logged out. when a session exists, and Not logged in, nothing to do when there is no session.

Show the current session

ppio auth info shows information about the current user, including the signed-in email and the selected team.
Example output:
Output
With no login stored, it prints Not logged in.
ppio auth info reads only the login configuration file. To check an API key that is set in the environment, use ppio sandbox list.

Switch teams

ppio auth configure changes the active team for an existing session. The CLI fetches the teams the login belongs to and prompts for one. The chosen team’s name, ID and API key are saved back to ~/.ppio/config.json.
A login is required first. With no user configuration, the CLI asks to run ppio auth login before configuring a team.
After the selection, it confirms the chosen team:
Output
Last modified on November 19, 2026