Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/superfly/sprites-go/llms.txt

Use this file to discover all available pages before exploring further.

The Sprites Go SDK lets you run commands on remote Sprites as if they were local processes. It mirrors the standard exec.Cmd API, so if you already know how to run processes in Go, you already know how to use this SDK.

Quickstart

Install the SDK and run your first command on a Sprite in minutes.

Authentication

Get your API token and configure the client for your organization.

Command Execution

Run commands, capture output, set environment variables and working directories.

API Reference

Complete reference for all Client, Sprite, and Cmd methods.

​
What you can do

The SDK covers the full lifecycle of working with Sprites programmatically:

I/O and Pipes

Stream stdin, stdout, and stderr with pipes for real-time data handling.

TTY and Interactive

Run interactive shell sessions with full TTY and terminal resize support.

Port Forwarding

Forward local ports to services running inside a Sprite over WebSocket proxies.

Filesystem Access

Read, write, and manage files on a Sprite’s filesystem using the standard io/fs interface.

Services

Create, start, stop, and monitor long-running services within a Sprite.

Checkpoints

Snapshot and restore Sprite state using checkpoints for fast iteration.

​
Get started

1

Install the SDK

go get github.com/superfly/sprites-go
2

Create a client

import sprites "github.com/superfly/sprites-go"

client := sprites.New("your-auth-token")
3

Run a command

sprite := client.Sprite("my-sprite")
output, err := sprite.Command("echo", "hello world").Output()
The import path is github.com/superfly/sprites-go but the package name is sprites. Use an alias when importing: import sprites "github.com/superfly/sprites-go".

Build docs developers (and LLMs) love

Get started for freeTalk to us