CLI Commands Reference

Complete reference for all sprite CLI commands.

Global Options

These options work with any command:

Option	Description
--debug[=<file>]	Enable debug logging (logs to stdout if no file specified)
-o, --org	<name> Specify organization (can be used anywhere)
-s, --sprite	<name> Specify sprite (can be used anywhere)
-h, --help	Show this help message

Authentication Commands

sprite login

Usage of login:

sprite login

sprite logout

Usage of logout:

sprite logout

sprite org auth

Usage of org auth:

sprite org auth

Aliases: sprite orgs, sprite organizations, sprite o

sprite org list

Usage of org list:

sprite org list

sprite org logout

Usage of org logout:

sprite org logout

sprite org keyring disable

--- Org selector

sprite org keyring disable

sprite org keyring enable

--- Org selector

sprite org keyring enable

sprite auth setup

Usage of auth setup:

sprite auth setup

Sprite Management

sprite create

Usage of create:

sprite create

sprite use

Usage of use:

sprite use

sprite list

Usage of list:

sprite list

Aliases: sprite ls

sprite destroy

Usage of destroy:

sprite destroy

Command Execution

sprite exec

Usage of exec:

sprite exec

Aliases: sprite x

sprite console

Usage of console:

sprite console

Aliases: sprite c

Checkpoints

sprite checkpoint create

Usage of checkpoint create:

sprite checkpoint create

sprite checkpoint list

Usage of checkpoint list:

sprite checkpoint list

Aliases: sprite checkpoint ls, sprite checkpoints ls

sprite checkpoint info

Usage of checkpoint info:

sprite checkpoint info

sprite checkpoint delete

Usage of checkpoint delete:

sprite checkpoint delete

Aliases: sprite checkpoint rm

sprite restore

Usage of restore:

sprite restore

Aliases: sprite checkpoint restore

Networking

sprite proxy

Usage of proxy:

sprite proxy

sprite url

sprite url - Manage sprite URL settings

sprite url                    Show sprite URL and auth setting sprite url update [options]   Update URL authentication settings URL Format: https://<sprite-name>-<org>.sprites.dev/ Authentication Modes: sprite     Allows access via browser to Sprite org members, and via org tokens (default) public     No authentication - anyone with URL can access Subcommands: update     Update URL authentication settings

Options:

• -o, --org <name> - Specify organization
• -s, --sprite <name> - Specify sprite
• -h, --help Show - this help message
• --auth <type> - Authentication type: ‘public’ or ‘sprite’

Examples:

sprite url                         # Show current URL and auth setting
sprite url update --auth public    # Make URL publicly accessible
sprite url update --auth sprite    # Require org membership (default)
sprite url -o myorg -s mysprite    # Show URL for specific sprite
Accessing Authenticated URLs:
Visit the URL in your browser and log in with Fly.io, or use an org token:
curl -H "Authorization: Bearer $SPRITE_API_TOKEN" https://mysprite-myorg.sprites.dev/
Security Notes:
- Public URLs are accessible to anyone on the internet
- Never expose secrets, env vars, or sensitive data via HTTP
- Use 'public' only for demos, webhooks, or truly public services

sprite url update

Usage of url update:

sprite url update

Utility Commands

sprite api

Usage of api:

sprite api

sprite upgrade

Usage of upgrade:

sprite upgrade

Exit Codes

Code	Meaning
0	Success
1	General error
2	Command not found
126	Command cannot execute
127	Command not found (in sprite)
128+	Command terminated by signal

Environment Variables

Variable	Description
SPRITE_TOKEN	API token override (legacy; falls back if no stored token)
SPRITE_URL	Direct sprite URL (for local/dev direct connections)
SPRITES_API_URL	API URL override (default: https://api.sprites.dev)

Configuration Files

Global Config

~/.sprites/sprites.json (managed by the CLI; format may evolve):

{
  "version": "1",
  "current_selection": {
    "url": "https://api.sprites.dev",
    "org": "personal"
  },
  "urls": {
    "https://api.sprites.dev": {
      "url": "https://api.sprites.dev",
      "orgs": {
        "personal": {
          "name": "personal",
          "keyring_key": "sprites-cli:<user-id>",
          "use_keyring": true,
          "sprites": {}
        }
      }
    }
  }
}

Local Context

.sprite (in project directory):

{
  "organization": "personal",
  "sprite": "my-project-sprite"
}

Related Documentation

Installation

Install the Sprites CLI on your platform

Authentication

Set up your Fly.io account and manage tokens

Working with Sprites

Beyond the basics guide

Checkpoints

Save and restore sprite state