Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion celesto-sdk/cli.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: Celesto CLI reference

Check warning on line 2 in celesto-sdk/cli.mdx

View check run for this annotation

Mintlify / Mintlify Validation (celestoai) - vale-spellcheck

celesto-sdk/cli.mdx#L2

Did you really mean 'Celesto'?
sidebarTitle: CLI reference
description: "Use the celesto CLI to authenticate, create computers, run commands, publish ports, and manage sandbox lifecycle from the terminal."

Check warning on line 4 in celesto-sdk/cli.mdx

View check run for this annotation

Mintlify / Mintlify Validation (celestoai) - vale-spellcheck

celesto-sdk/cli.mdx#L4

Did you really mean 'celesto'?
---

The `celesto` CLI lets you manage Celesto from your terminal. Use it for one-off sandbox work, scripts, and debugging SDK workflows.

Check warning on line 7 in celesto-sdk/cli.mdx

View check run for this annotation

Mintlify / Mintlify Validation (celestoai) - vale-spellcheck

celesto-sdk/cli.mdx#L7

Did you really mean 'Celesto'?

## Install and sign in

Expand Down Expand Up @@ -129,7 +129,7 @@
celesto computer port list einstein
```

Unpublish the port when you are done:

Check warning on line 132 in celesto-sdk/cli.mdx

View check run for this annotation

Mintlify / Mintlify Validation (celestoai) - vale-spellcheck

celesto-sdk/cli.mdx#L132

Did you really mean 'Unpublish'?

```bash
celesto computer port unpublish einstein --port 8000
Expand All @@ -137,10 +137,12 @@

| Command | Description |
|---|---|
| `celesto computer port publish NAME [--port N]` | Expose a port on the public internet. Defaults to `8000` |
| `celesto computer port publish NAME [--port N]` | Expose an application port (`1024`–`65535`) on the public internet. Defaults to `8000` |
| `celesto computer port list NAME` | List published ports for a computer |
| `celesto computer port unpublish NAME [--port N]` | Stop exposing a port. Defaults to `8000` |

A computer can have up to four ports published at a time, and Celesto system ports are reserved for the platform.

Check warning on line 144 in celesto-sdk/cli.mdx

View check run for this annotation

Mintlify / Mintlify Validation (celestoai) - vale-spellcheck

celesto-sdk/cli.mdx#L144

Did you really mean 'Celesto'?

## Auto-resume stopped computers

The `run` and `ssh` commands automatically resume a stopped computer before executing. You can run a command or open a terminal session without calling `start` first.
Expand Down Expand Up @@ -170,7 +172,7 @@
celesto update
```

The command upgrades `celesto` using `pip` when it is available, and falls back to `uv` when you installed Celesto with `uv` or are running inside a `uv run` environment.

Check warning on line 175 in celesto-sdk/cli.mdx

View check run for this annotation

Mintlify / Mintlify Validation (celestoai) - vale-spellcheck

celesto-sdk/cli.mdx#L175

Did you really mean 'Celesto'?

If neither `pip` nor `uv` is available, the command prints the exact command to run yourself, for example:

Expand Down
4 changes: 4 additions & 0 deletions celesto-sdk/computers.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Create and manage sandboxed computers

Check warning on line 2 in celesto-sdk/computers.mdx

View check run for this annotation

Mintlify / Mintlify Validation (celestoai) - vale-spellcheck

celesto-sdk/computers.mdx#L2

Did you really mean 'sandboxed'?
sidebarTitle: Sandboxed computers

Check warning on line 3 in celesto-sdk/computers.mdx

View check run for this annotation

Mintlify / Mintlify Validation (celestoai) - vale-spellcheck

celesto-sdk/computers.mdx#L3

Did you really mean 'Sandboxed'?
description: "Use the Celesto Computers API to create sandboxed computers, select templates, run shell commands, publish ports, and manage the VM lifecycle."

Check warning on line 4 in celesto-sdk/computers.mdx

View check run for this annotation

Mintlify / Mintlify Validation (celestoai) - vale-spellcheck

celesto-sdk/computers.mdx#L4

Did you really mean 'Celesto'?

Check warning on line 4 in celesto-sdk/computers.mdx

View check run for this annotation

Mintlify / Mintlify Validation (celestoai) - vale-spellcheck

celesto-sdk/computers.mdx#L4

Did you really mean 'sandboxed'?
---

The Computers API gives your code or agent an isolated Linux computer. You create a computer, run work inside it, and then stop, start, or delete it when your workflow is done.
Expand All @@ -21,7 +21,7 @@
</Steps>

<Note>
Celesto accepts Nano (1 vCPU, 512 MB), Small (1 vCPU, 1 GB), Standard (2 vCPU, 4 GB), and Large (4 vCPU, 12 GB). Free and Nano plans can create Nano computers. Builder and Growth can create every named size. See [Choose computer size](/celesto-sdk/features/resources).

Check warning on line 24 in celesto-sdk/computers.mdx

View check run for this annotation

Mintlify / Mintlify Validation (celestoai) - vale-spellcheck

celesto-sdk/computers.mdx#L24

Did you really mean 'Celesto'?

Check warning on line 24 in celesto-sdk/computers.mdx

View check run for this annotation

Mintlify / Mintlify Validation (celestoai) - vale-spellcheck

celesto-sdk/computers.mdx#L24

Did you really mean 'Nano'?

Check warning on line 24 in celesto-sdk/computers.mdx

View check run for this annotation

Mintlify / Mintlify Validation (celestoai) - vale-spellcheck

celesto-sdk/computers.mdx#L24

Did you really mean 'Nano'?

Check warning on line 24 in celesto-sdk/computers.mdx

View check run for this annotation

Mintlify / Mintlify Validation (celestoai) - vale-spellcheck

celesto-sdk/computers.mdx#L24

Did you really mean 'Nano'?
</Note>

<View title="Python" icon="python">
Expand Down Expand Up @@ -136,7 +136,7 @@

## Stream command output

Use `run_stream()` when you want to see output as it is produced instead of waiting for the command to finish. It returns an iterator of event dicts that arrive over a server-sent events stream, which is useful for long-running builds, test suites, or agent tool calls that print progress.

Check warning on line 139 in celesto-sdk/computers.mdx

View check run for this annotation

Mintlify / Mintlify Validation (celestoai) - vale-spellcheck

celesto-sdk/computers.mdx#L139

Did you really mean 'dicts'?

```python stream_command.py
from celesto import Computer
Expand Down Expand Up @@ -179,6 +179,8 @@

Publishing a port gives your computer a public HTTPS URL. Use it when an app, API server, or notebook running inside the computer needs to be reachable from outside the sandbox.

Pick any application port from `1024` through `65535`. A computer can have up to four ports published at a time, and Celesto system ports are reserved for the platform.

Check warning on line 182 in celesto-sdk/computers.mdx

View check run for this annotation

Mintlify / Mintlify Validation (celestoai) - vale-spellcheck

celesto-sdk/computers.mdx#L182

Did you really mean 'Celesto'?

```python publish_port.py
from celesto import Computer

Expand All @@ -198,7 +200,7 @@

## Open a terminal connection

Use `create_terminal_session()` when your application needs an interactive shell against a running computer, for example to power a web terminal in your own product. It calls `POST /computers/{id}/terminals` and returns a short-lived, direct connection to Celesto's fast terminal gateway. Your account must have write access to the computer.

Check warning on line 203 in celesto-sdk/computers.mdx

View check run for this annotation

Mintlify / Mintlify Validation (celestoai) - vale-spellcheck

celesto-sdk/computers.mdx#L203

Did you really mean 'Celesto's'?

```python terminal.py
import websockets
Expand Down Expand Up @@ -442,6 +444,8 @@

Publishing a port gives your computer a public HTTPS URL. Use it when an app, API server, or notebook running inside the computer needs to be reachable from outside the sandbox.

Pick any application port from `1024` through `65535`. A computer can have up to four ports published at a time, and Celesto system ports are reserved for the platform.

Check warning on line 447 in celesto-sdk/computers.mdx

View check run for this annotation

Mintlify / Mintlify Validation (celestoai) - vale-spellcheck

celesto-sdk/computers.mdx#L447

Did you really mean 'Celesto'?

```ts publish-port.ts
import { Computer } from "@celestoai/sdk";

Expand Down Expand Up @@ -473,7 +477,7 @@

## Open a terminal connection

Use `createTerminalSession()` when you are building your own interactive terminal against a Celesto computer, for example to power a web terminal in your own product. It calls `POST /computers/{id}/terminals` and returns a short-lived, direct connection to Celesto's fast terminal gateway. Your account must have write access to the computer.

Check warning on line 480 in celesto-sdk/computers.mdx

View check run for this annotation

Mintlify / Mintlify Validation (celestoai) - vale-spellcheck

celesto-sdk/computers.mdx#L480

Did you really mean 'Celesto'?

Check warning on line 480 in celesto-sdk/computers.mdx

View check run for this annotation

Mintlify / Mintlify Validation (celestoai) - vale-spellcheck

celesto-sdk/computers.mdx#L480

Did you really mean 'Celesto's'?

```ts terminal.ts
import WebSocket from "ws";
Expand Down Expand Up @@ -532,7 +536,7 @@
</ResponseField>

<ResponseField name="vcpus" type="integer" required>
Number of virtual CPUs allocated.

Check warning on line 539 in celesto-sdk/computers.mdx

View check run for this annotation

Mintlify / Mintlify Validation (celestoai) - vale-spellcheck

celesto-sdk/computers.mdx#L539

Did you really mean 'CPUs'?
</ResponseField>

<ResponseField name="ram_mb" type="integer" required>
Expand Down
4 changes: 4 additions & 0 deletions celesto-sdk/features/publish-ports.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: Publish ports from a sandboxed computer

Check warning on line 2 in celesto-sdk/features/publish-ports.mdx

View check run for this annotation

Mintlify / Mintlify Validation (celestoai) - vale-spellcheck

celesto-sdk/features/publish-ports.mdx#L2

Did you really mean 'sandboxed'?
sidebarTitle: Publish ports
description: "Expose a web server, API, notebook, or preview app running inside a Celesto computer through a public HTTPS URL with the SDK or CLI."

Check warning on line 4 in celesto-sdk/features/publish-ports.mdx

View check run for this annotation

Mintlify / Mintlify Validation (celestoai) - vale-spellcheck

celesto-sdk/features/publish-ports.mdx#L4

Did you really mean 'Celesto'?
---

Services inside a Celesto computer are private by default. This isolation is useful for running agents, notebooks, APIs, and preview apps safely, but it also means you need to expose a service before you can open it in a browser or send a webhook to it.

Check warning on line 7 in celesto-sdk/features/publish-ports.mdx

View check run for this annotation

Mintlify / Mintlify Validation (celestoai) - vale-spellcheck

celesto-sdk/features/publish-ports.mdx#L7

Did you really mean 'Celesto'?

Port publishing creates a public HTTPS URL that forwards traffic to a port inside the computer, so you can preview, test, and share running services without deploying them elsewhere.

Expand All @@ -19,6 +19,10 @@
- Receive webhooks during a test run.
- Inspect a notebook, dashboard, or development server.

## What you can publish

Pick any application port that your service listens on inside the computer, from `1024` through `65535`. A computer can have up to four ports published at a time — unpublish one before adding another once you reach the limit. Celesto system ports are reserved for the platform and cannot be published.

Check warning on line 24 in celesto-sdk/features/publish-ports.mdx

View check run for this annotation

Mintlify / Mintlify Validation (celestoai) - vale-spellcheck

celesto-sdk/features/publish-ports.mdx#L24

Did you really mean 'unpublish'?

Check warning on line 24 in celesto-sdk/features/publish-ports.mdx

View check run for this annotation

Mintlify / Mintlify Validation (celestoai) - vale-spellcheck

celesto-sdk/features/publish-ports.mdx#L24

Did you really mean 'Celesto'?

## Publish a service

The following example starts a simple HTTP server on port `8000`, publishes the port, prints the public URL, lists published ports, and then removes the published port.
Expand Down Expand Up @@ -112,7 +116,7 @@
```

<Tip>
For short-lived previews, unpublish the port before deleting the computer.

Check warning on line 119 in celesto-sdk/features/publish-ports.mdx

View check run for this annotation

Mintlify / Mintlify Validation (celestoai) - vale-spellcheck

celesto-sdk/features/publish-ports.mdx#L119

Did you really mean 'unpublish'?
</Tip>

## Troubleshooting
Expand Down