CLI Installation

The Sprites CLI (sprite) is available for macOS, Linux, and Windows.

Quick Install (Recommended)

The easiest way to install the CLI is with our install script:

curl -fsSL https://sprites.dev/install.sh | sh

The install script automatically:

Detects your operating system and architecture
Downloads the latest release binary
Verifies the SHA256 checksum
Installs to ~/.local/bin

After installation, you may need to add ~/.local/bin to your PATH if it’s not already included. The script will provide instructions if needed.

Manual Installation

Latest CLI release: v0.0.1-rc48. For Apple Silicon/Intel or ARM64/x86-64 variants not shown, swap the architecture in the URL (arm64 ↔ amd64).

macOS
Linux
Windows

Apple Silicon
Intel

Download

curl -LO https://sprites-binaries.t3.storage.dev/client/v0.0.1-rc48/sprite-darwin-arm64.tar.gz

Verify checksum (recommended)

curl -sL https://sprites-binaries.t3.storage.dev/client/v0.0.1-rc48/sprite-darwin-arm64.tar.gz.sha256 | awk '{print $1 "  sprite-darwin-arm64.tar.gz"}' | shasum -a 256 -c

Extract and install

tar xzf sprite-darwin-arm64.tar.gz
sudo mv sprite /usr/local/bin/

Download

curl -LO https://sprites-binaries.t3.storage.dev/client/v0.0.1-rc48/sprite-darwin-amd64.tar.gz

Verify checksum (recommended)

curl -sL https://sprites-binaries.t3.storage.dev/client/v0.0.1-rc48/sprite-darwin-amd64.tar.gz.sha256 | awk '{print $1 "  sprite-darwin-amd64.tar.gz"}' | shasum -a 256 -c

Extract and install

tar xzf sprite-darwin-amd64.tar.gz
sudo mv sprite /usr/local/bin/

x86-64
ARM64

Download

curl -LO https://sprites-binaries.t3.storage.dev/client/v0.0.1-rc48/sprite-linux-amd64.tar.gz

Verify checksum (recommended)

curl -sL https://sprites-binaries.t3.storage.dev/client/v0.0.1-rc48/sprite-linux-amd64.tar.gz.sha256 | awk '{print $1 "  sprite-linux-amd64.tar.gz"}' | sha256sum -c

Extract and install

tar xzf sprite-linux-amd64.tar.gz
sudo mv sprite /usr/local/bin/

Download

curl -LO https://sprites-binaries.t3.storage.dev/client/v0.0.1-rc48/sprite-linux-arm64.tar.gz

Verify checksum (recommended)

curl -sL https://sprites-binaries.t3.storage.dev/client/v0.0.1-rc48/sprite-linux-arm64.tar.gz.sha256 | awk '{print $1 "  sprite-linux-arm64.tar.gz"}' | sha256sum -c

Extract and install

tar xzf sprite-linux-arm64.tar.gz
sudo mv sprite /usr/local/bin/

x86-64
ARM64

Download

Invoke-WebRequest -Uri "https://sprites-binaries.t3.storage.dev/client/v0.0.1-rc48/sprite-windows-amd64.zip" -OutFile "sprite-windows-amd64.zip"

Extract to your bin directory

Expand-Archive sprite-windows-amd64.zip -DestinationPath $env:USERPROFILE\bin

Add to PATH (run as Administrator)

[Environment]::SetEnvironmentVariable("Path", $env:Path + ";$env:USERPROFILE\bin", "User")

For ARM64 Windows, replace amd64 with arm64 in the URL above.

Download

Invoke-WebRequest -Uri "https://sprites-binaries.t3.storage.dev/client/v0.0.1-rc48/sprite-windows-arm64.zip" -OutFile "sprite-windows-arm64.zip"

Extract to your bin directory

Expand-Archive sprite-windows-arm64.zip -DestinationPath $env:USERPROFILE\bin

Add to PATH (run as Administrator)

[Environment]::SetEnvironmentVariable("Path", $env:Path + ";$env:USERPROFILE\bin", "User")

For ARM64 Windows, replace amd64 with arm64 in the URL above.

Verify Installation

sprite --help

You should see the help output with available commands.

Upgrading

If you installed from the direct download links, upgrade to the latest version:

sprite upgrade

To check for updates without installing:

sprite upgrade --check

Configuration

The CLI stores configuration in ~/.sprites/sprites.json. This includes:

Organization tokens
Current organization selection
Current sprite selection

Config File Location

Platform	Location
macOS/Linux	`~/.sprites/sprites.json`
Windows	`%USERPROFILE%\.sprites\sprites.json`

Note: config.json is kept for backward compatibility with older clients, but current versions read/write sprites.json.

Optional: Local Directory Context

The CLI supports a .sprite file in your project directory to remember which sprite to use:

# Set the sprite for current directory
sprite use my-project-sprite

This creates a .sprite file that the CLI reads automatically. Add .sprite to your .gitignore as it’s user-specific.

Optional: Install Shell Completions

The CLI provides completion scripts for various shells. Run sprite help completion for more information.

bash

Install the bash completion script by adding it to your .bashrc:

echo 'eval "$(sprite completion bash)"' >> ~/.bashrc

zsh

If you haven’t enabled completions in your .zshrc yet:

echo "autoload -U compinit; compinit -i" >> ~/.zshrc

Install the zsh completion script by adding it to your local functions:

sprite completion zsh > ~/.local/share/zsh/site-functions/_sprite

# If the local functions directory isn't in your fpath
echo "fpath=(\"$HOME/.local/share/zsh/site-functions\" \$fpath)" >> ~/.zshrc

fish

Install the fish completion script:

sprite completion fish > ~/.config/fish/completions/sprite.fish

PowerShell

Install the PowerShell completion script by appending it to your profile:

Add-Content $PROFILE "`nsprite completion powershell | Out-String | Invoke-Expression"

Troubleshooting

Permission Denied

If you get a permission denied error on macOS or Linux:

chmod +x sprite
sudo mv sprite /usr/local/bin/

Command Not Found

Ensure the binary is in your PATH:

# Check if sprite is in PATH
which sprite

# If not, add /usr/local/bin to PATH
export PATH="/usr/local/bin:$PATH"

macOS Security Warning

On macOS, you may see a security warning when first running the CLI. To allow it:

Open System Preferences > Security & Privacy
Click “Allow Anyway” next to the message about sprite
Run sprite again and click “Open”

Or use the command line:

xattr -d com.apple.quarantine /usr/local/bin/sprite

Getting Started

Concepts

CLI Reference

Integrations

CLI Installation

Quick Install (Recommended)

Manual Installation

Verify Installation

Upgrading

Configuration

Config File Location

Optional: Local Directory Context

Optional: Install Shell Completions

bash

zsh

fish

PowerShell

Troubleshooting

Permission Denied

Command Not Found

macOS Security Warning

Next Steps

Authentication

Commands Reference

​Quick Install (Recommended)

​Manual Installation

​Verify Installation

​Upgrading

​Configuration

​Config File Location

​Optional: Local Directory Context

​Optional: Install Shell Completions

​bash

​zsh

​fish

​PowerShell

​Troubleshooting

​Permission Denied

​Command Not Found

​macOS Security Warning

​Next Steps

Authentication

Commands Reference

Quick Install (Recommended)

Manual Installation

Verify Installation

Upgrading

Configuration

Config File Location

Optional: Local Directory Context

Optional: Install Shell Completions

bash

zsh

fish

PowerShell

Troubleshooting

Permission Denied

Command Not Found

macOS Security Warning

Next Steps