squarecloud-rs

A lightweight, idiomatic, async Rust client for the SquareCloud API. Deploy applications, manage files and environment variables, provision databases, take snapshots, and organize workspaces, with compile-time type safety and zero-cost async through Tokio.

Installation

[dependencies]
squarecloud = "0.1"
tokio = { version = "1", features = ["full"] }

Configuration

The client reads API_TOKEN on first use, either from the process environment or a .env file in the working directory.

API_TOKEN=your_squarecloud_api_token

Quick start

use squarecloud::ApiClient;

#[tokio::main]
async fn main() {
    let client = ApiClient::new();

    let me = client.me().await.unwrap();
    println!("Logged in as {} ({})", me.user.name, me.user.email);

    let status = client.app("application_id").status().await.unwrap();
    println!("CPU: {}  RAM: {}", status.cpu, status.ram);
}

Realtime log streaming

AppResource::realtime() returns a live SSE stream of log and system events:

use futures_util::StreamExt;
use squarecloud::{ApiClient, RealtimeEvent};

#[tokio::main]
async fn main() {
    let client = ApiClient::new();
    let mut stream = client.app("application_id").realtime();
    while let Some(event) = stream.next().await {
        match event.unwrap() {
            RealtimeEvent::Log(msg) => println!("[log]    {msg}"),
            RealtimeEvent::System(msg) => println!("[system] {msg}"),
        }
    }
}

Examples

The examples/ directory contains one file per method, organized by resource:

cargo run --example me
cargo run --example app_status -- <app_id>
cargo run --example app_realtime -- <app_id>
cargo run --example database_info -- <db_id>

Contributing

See CONTRIBUTING.md.

License

MIT