Python SDK and CLI for the Celesto AI platform.
Project description
Celesto
Celesto runs AI agents and harnesses in a cloud computer. An AI agent is software that can plan and run tasks. A harness is the code that starts, tests, or supervises an agent. They can run commands, write files, and use tools without touching your machine.
Use Celesto when you want to:
- Run an AI agent or harness in a clean computer.
- Run shell commands from Python, JavaScript, TypeScript, or the command line.
- Keep agent work separate from your laptop, server, or production system.
- Manage a computer from start to finish: create, list, run commands, stop, start, and delete.
This README covers the Python SDK, which is a code package, and the CLI, which
is the celesto command. The JavaScript and TypeScript SDK is also available as
@celestoai/sdk.
Install
Install the Python package to get both the SDK and the celesto command:
pip install celesto
Celesto requires Python 3.10 or newer.
For JavaScript and TypeScript projects, install the npm package:
npm install @celestoai/sdk
Get an API Key
An API key is a secret token that lets Celesto know a request is yours. Create one in Celesto Settings under Settings > Security.
For SDK code, set the key in your shell before running your program:
export CELESTO_API_KEY="your-api-key"
For CLI commands, you can save the key once:
celesto auth login
The CLI stores the key in your operating system's secure credential store. On
Linux machines without a credential store, it saves the key in
$XDG_CONFIG_HOME/celesto/credentials.json when XDG_CONFIG_HOME is set, or
~/.config/celesto/credentials.json otherwise, with user-only file
permissions. SDK code does not read that saved CLI key; it reads
CELESTO_API_KEY or the api_key value you pass to Celesto.
Create a Computer from Python
This example creates a minimal Ubuntu computer, runs one command, prints the
output, and deletes the computer. Celesto uses the scratch template by
default.
from celesto import Celesto
client = Celesto()
computer = client.computers.create()
print(f"Computer ready: {computer['name']}")
result = client.computers.exec(computer["id"], "uname -a")
print(result["stdout"])
client.computers.delete(computer["id"])
To pass the key directly instead of using CELESTO_API_KEY:
from celesto import Celesto
with Celesto(api_key="your-api-key") as client:
result = client.computers.list()
print(result["count"])
Manage Computers from the CLI
Run these commands in a macOS or Linux shell after celesto auth login. The
first command creates a computer with the default scratch template.
celesto computer create
# Name: curie
# ID: cmp_123
# Status: creating
For later examples, save the generated name in COMPUTER_NAME. The command
uses --json so Python can read the output.
COMPUTER_NAME=$(
celesto computer create --json |
python3 -c 'import json, sys; print(json.load(sys.stdin)["name"])'
)
Inspect that computer by name or ID:
celesto computer get "$COMPUTER_NAME"
# Name: curie
# ID: cmp_123
# Status: running
List your computers:
celesto computer list
Filter the list by status:
celesto computer list --status running
Filter the list by template. Template IDs come from celesto computer templates;
browser-agent is one ready-made template.
celesto computer list --template browser-agent
Filter the list by project. Replace proj_123 with a project ID from your
Celesto workspace.
celesto computer list --project proj_123
Limit the number of computers returned:
celesto computer list --limit 10
Run a command in the computer:
celesto computer run "$COMPUTER_NAME" "uname -a"
Use a longer timeout for slow commands. The value is in seconds and must be between 1 and 300.
celesto computer run "$COMPUTER_NAME" "sleep 10 && echo done" --timeout 30
Stream output while a command is still running:
celesto computer run "$COMPUTER_NAME" "for i in 1 2 3; do echo $i; sleep 1; done" --stream
# 1
# 2
# 3
celesto computer run --json prints one JSON object for scripts and exits with
the same exit code as the remote command. celesto computer run --stream --json
prints one compact JSON event per line.
Current caveat: commands run as the computer image's default exec user. The CLI
and SDK do not yet expose a --user option. Run whoami first if your script
depends on a specific home directory or file permission.
List templates when you want a computer with tools already installed:
celesto computer templates
Create a computer from a template:
celesto computer create --template coding-agent
Publish port 8000 when a process in the computer needs a public URL:
celesto computer port publish "$COMPUTER_NAME" --port 8000
# https://p-test.celesto.ai
List published ports:
celesto computer port list "$COMPUTER_NAME"
Unpublish the port when you are done:
celesto computer port unpublish "$COMPUTER_NAME" --port 8000
To open an interactive terminal, connect to the same computer:
celesto computer ssh "$COMPUTER_NAME"
Press Ctrl+] to exit the terminal, then delete the computer:
celesto computer delete --force "$COMPUTER_NAME"
Use celesto computer list to see the computers in your account.
Manage Computers from JavaScript or TypeScript
In an ESM or TypeScript file:
import { Celesto } from "@celestoai/sdk";
const celesto = new Celesto({ token: process.env.CELESTO_API_KEY });
const computer = await celesto.computers.create();
try {
console.log(`Computer ready: ${computer.name}`);
const result = await celesto.computers.exec(computer.id, "uname -a");
console.log(result.stdout);
} finally {
await celesto.computers.delete(computer.id);
}
See the JavaScript and TypeScript README for Node.js requirements, Gatekeeper examples, and terminal connection details.
Python Computers API
Use the Python SDK when you want Celesto inside an app, script, or agent.
Create
from celesto import Celesto
with Celesto() as client:
computer = client.computers.create(
cpus=2,
memory=2048,
disk_size_mb=15360,
)
try:
print(computer["name"])
finally:
client.computers.delete(computer["id"])
Omit CPU, memory, or disk fields to use the default size.
Templates
By default, Celesto uses scratch, a minimal Ubuntu computer. Use a template
when you want a computer that already has extra tools installed. For example,
coding-agent includes common tools for coding tasks.
List available templates:
from celesto import Celesto
with Celesto() as client:
templates = client.computers.list_templates()
for template in templates:
print(template["id"], template.get("preinstalled_tools", []))
Template responses may include metadata such as aliases, capabilities,
preinstalled tools, recommended uses, default published ports, and browser
support flags. Older template records may omit those fields, so use .get()
when your code can run against multiple API versions.
Create a computer from a template:
from celesto import Celesto
with Celesto() as client:
computer = client.computers.create(template_id="coding-agent")
try:
print(computer["name"])
finally:
client.computers.delete(computer["id"])
Run a Command
from celesto import Celesto
with Celesto() as client:
computer = client.computers.create()
try:
result = client.computers.exec(computer["id"], "ls -la", timeout=60)
print(result["exit_code"])
print(result["stdout"])
print(result["stderr"])
finally:
client.computers.delete(computer["id"])
The timeout value is the remote command timeout in seconds. The SDK gives the
HTTP request a little more time than the command itself so slow command output
can still return cleanly.
Current caveat: exec() runs as the computer image's default exec user. The SDK
does not yet expose a user selector.
List, Stop, Start, and Delete
computer_id can be the ID returned by client.computers.create(), such as
computer["id"], or a computer name shown by celesto computer list.
Filter a list when you only want matching computers:
from celesto import Celesto
with Celesto() as client:
result = client.computers.list(status="running", template_id="browser-agent")
for computer in result["computers"]:
print(computer["name"])
| Method | What it does |
|---|---|
client.computers.list() |
List computers in your account |
client.computers.list(status="running", template_id="browser-agent", project_id="proj_123", limit=10) |
List matching computers |
client.computers.get(computer_id) |
Get one computer by name or ID |
client.computers.stop(computer_id) |
Stop a running computer |
client.computers.start(computer_id) |
Start a stopped computer |
client.computers.delete(computer_id) |
Delete a computer |
Publish Ports
Publish a port when a service inside the computer needs a public URL:
from celesto import Celesto
with Celesto() as client:
published = client.computers.publish_port("curie", port=8000)
print(published["url"])
List and remove published ports:
from celesto import Celesto
with Celesto() as client:
print(client.computers.list_published_ports("curie"))
client.computers.unpublish_port("curie", port=8000)
CLI Commands
| Command | What it does |
|---|---|
celesto auth login |
Save your API key for CLI commands |
celesto auth status |
Check whether an API key is saved |
celesto auth logout |
Remove your saved API key |
celesto computer create [--cpus N] [--memory MB] [--disk-size-mb MB] [--template ID] |
Create a computer |
celesto computer templates |
List templates with preinstalled tools |
celesto computer list |
List your computers |
celesto computer list [--status STATUS] [--template ID] [--project ID] [--limit N] |
List matching computers |
celesto computer get NAME |
Get one computer by name or ID |
celesto computer run NAME "command" [--timeout N] |
Run a command on a computer |
celesto computer run NAME "command" --stream |
Stream command output while it runs |
celesto computer ssh NAME |
Open an interactive terminal |
celesto computer port publish NAME --port 8000 |
Publish a computer port |
celesto computer port list NAME |
List published ports |
celesto computer port unpublish NAME --port 8000 |
Unpublish a computer port |
celesto computer stop NAME |
Stop a computer |
celesto computer start NAME |
Start a stopped computer |
celesto computer delete [--force] NAME |
Delete a computer |
Most computer commands support --json, which prints structured data for
scripts and automation:
celesto computer list --json
celesto computer templates --json
celesto computer create --disk-size-mb 15360 --json
celesto computer ssh is interactive and does not support JSON output.
Other Python SDK APIs
The Python SDK also includes:
client.deploymentfor deploying agents to Celesto.client.gatekeeperfor connecting user-approved external resources, such as Google Drive.
See the full documentation for these advanced APIs.
OpenAI Agents SDK Sandboxes
OpenAI agents can use Celesto as their working computer. This lets the agent read files, run commands, and create artifacts in a separate place.
A sandbox is a separate computer where an agent can work. A session is one running connection to that computer.
Install the optional dependencies:
pip install "celesto[openai-agents]"
Set both API keys before running the example. Celesto uses CELESTO_API_KEY to
create the computer. The OpenAI Agents SDK uses OPENAI_API_KEY to run the
agent.
export CELESTO_API_KEY="your-celesto-api-key"
export OPENAI_API_KEY="your-openai-api-key"
Then create a sandbox session for the agent:
import asyncio
from agents import Runner
from agents.run import RunConfig
from agents.sandbox import SandboxAgent, SandboxRunConfig
from celesto.integrations.openai_agents import CelestoSandboxClient
async def main() -> None:
agent = SandboxAgent(
name="Workspace analyst",
instructions="Inspect the sandbox workspace before answering.",
)
client = CelestoSandboxClient()
session = await client.create()
try:
async with session:
result = await Runner.run(
agent,
"Run `uname -a` in the sandbox and summarize the result.",
run_config=RunConfig(sandbox=SandboxRunConfig(session=session)),
)
print(result.final_output)
finally:
await client.delete(session)
asyncio.run(main())
If your agent needs common coding tools preinstalled, pass
options=CelestoSandboxClientOptions(template_id="coding-agent") when you call
client.create(). Import CelestoSandboxClientOptions from
celesto.integrations.openai_agents.
For local sandbox runs, use SmolVMSandboxClient and
SmolVMSandboxClientOptions from celesto.integrations.openai_agents. SmolVM
is a local tool for running a separate sandbox on your own machine.
Handle Errors in Python
Catch Celesto exceptions when your app needs custom recovery behavior.
from celesto.sdk.exceptions import (
CelestoAuthenticationError,
CelestoNetworkError,
CelestoNotFoundError,
CelestoRateLimitError,
CelestoServerError,
CelestoValidationError,
)
CelestoRateLimitError includes a retry_after value when the API sends one.
Develop Locally
If you are contributing and have uv installed, run these commands from the
repository root:
uv sync
uv run pytest
uv run ruff check .
uv run ruff format .
Links
License
Apache License 2.0
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file celesto-0.0.9.tar.gz.
File metadata
- Download URL: celesto-0.0.9.tar.gz
- Upload date:
- Size: 92.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2ab719ade86bf800c6c26390b0e15679cc00d009bb5f0638ae9ddd6ddc5e6d21
|
|
| MD5 |
5adb6f9cffcb808452ebf7d2dc0d8000
|
|
| BLAKE2b-256 |
1478de44f9846cfcf082b017d69d61ac5943d9b3212ab976358f72c68eac7668
|
Provenance
The following attestation bundles were made for celesto-0.0.9.tar.gz:
Publisher:
release.yml on CelestoAI/sdk
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
celesto-0.0.9.tar.gz -
Subject digest:
2ab719ade86bf800c6c26390b0e15679cc00d009bb5f0638ae9ddd6ddc5e6d21 - Sigstore transparency entry: 1968873942
- Sigstore integration time:
-
Permalink:
CelestoAI/sdk@cb8d9ba91b2a402eaba1d8b65748e8f089c2061c -
Branch / Tag:
refs/tags/v0.0.9 - Owner: https://github.com/CelestoAI
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@cb8d9ba91b2a402eaba1d8b65748e8f089c2061c -
Trigger Event:
push
-
Statement type:
File details
Details for the file celesto-0.0.9-py3-none-any.whl.
File metadata
- Download URL: celesto-0.0.9-py3-none-any.whl
- Upload date:
- Size: 45.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
db95e8efd05c99759d2562dee29692d8a455ac69005097257a76e09d17c57fba
|
|
| MD5 |
d46f9ad3d87a8c47b808accc47754a8c
|
|
| BLAKE2b-256 |
6af4a09509604c04c35eaea38c52b93e25f5b72d8cc8d91d8c4b0e302f03f73c
|
Provenance
The following attestation bundles were made for celesto-0.0.9-py3-none-any.whl:
Publisher:
release.yml on CelestoAI/sdk
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
celesto-0.0.9-py3-none-any.whl -
Subject digest:
db95e8efd05c99759d2562dee29692d8a455ac69005097257a76e09d17c57fba - Sigstore transparency entry: 1968873992
- Sigstore integration time:
-
Permalink:
CelestoAI/sdk@cb8d9ba91b2a402eaba1d8b65748e8f089c2061c -
Branch / Tag:
refs/tags/v0.0.9 - Owner: https://github.com/CelestoAI
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@cb8d9ba91b2a402eaba1d8b65748e8f089c2061c -
Trigger Event:
push
-
Statement type: