Developer Documentation & SDKs
Built for Developers Who Value Speed
Integrate CloudPi directly into your CLI scripts, CI/CD pipelines, and microservices with our unified REST APIs and official language client libraries.
Quickstart in 60 Seconds
Step 1
Install CloudPi CLI
Install via single-line curl script or npm package manager.
$ curl -sSL https://get.cloudpi.io | sh
Step 2
Authenticate CLI
Log in using browser OAuth or provide your account API key.
$ cloudpi login
Step 3
Deploy to Global Edge
Execute deploy command in any project directory with zero config.
$ cloudpi deploy --prod
CloudPi REST API Reference (v1)
Base URL: https://api.cloudpi.io/v1 — Authenticate via Bearer Token header.
// Request Payload
{
"name": "microservice-payments",
"image": "cloudpi/payments:v1.4",
"replicas": 3,
"region": "us-east-1"
}
// Response (201 Created)
{
"id": "cpi_wkl_882910a",
"status": "RUNNING",
"live_url": "https://payments.acme.cloudpi.app",
"created_at": "2026-10-23T14:30:00Z"
}
// Response (200 OK)
{
"data": [
{
"id": "inst_01a",
"name": "production-api-cluster",
"tier": "Pro-4x",
"region": "us-east-1",
"ip_address": "198.51.100.24",
"status": "running"
}
]
}
// Response (200 OK)
{ "status": "TERMINATED", "id": "cpi_wkl_882910a" }
Official Language SDKs
Idiomatic libraries with built-in retry handling, type definitions, and connection pooling.
TypeScript & Node.js
$ npm install @cloudpi/sdk
Fully typed with Zod schema validation & async streams.
Python SDK
$ pip install cloudpi-sdk
Asyncio support, Pydantic models, and Jupyter notebook helpers.
Go Package
$ go get github.com/cloudpi/go
Context-aware client with goroutine concurrency safety.
CloudPi CLI Command Reference
| Command | Description |
|---|---|
| cloudpi login | Authenticate local machine with your CloudPi account. |
| cloudpi deploy [--prod] | Build and deploy the current directory application. |
| cloudpi logs --follow | Stream live production application logs directly to terminal. |
| cloudpi ssh <instance_id> | Open an encrypted zero-trust terminal session to compute instance. |
| cloudpi env set KEY=VALUE | Add or update encrypted production environment variable. |