Before you begin
- Install the coding agent you want to use. Check its section below for any version or runtime requirements.
- Have a Fly.io account with access to the intended Sprites organization.
- For OAuth-based plugins, have a browser available for authorization. For Pi and Hermes Agent, create a Sprites API token and use the storage method in their setup instructions.
- For Herdr, authenticate the Sprites CLI and review the agent login handoff described below.
Codex
The Sprites plugin for Codex adds the hosted MCP server and Sprites workflow guidance. Install Sprites from the Codex plugin marketplace. On first use, follow the plugin’s browser authentication flow, choose the intended Fly.io organization, and review the connector access policy. For local installation from a checkout of the repository:Cursor
Install Sprites from the Cursor Marketplace. The Sprites plugin for Cursor bundles the hosted MCP server and Sprites workflow guidance. Cursor starts browser OAuth on the first Sprites request. Verify it by asking:~/.cursor/mcp.json or a project’s .cursor/mcp.json:
Antigravity
Install the Sprites plugin for Antigravity from GitHub:/mcp, authenticate the sprites server in your browser, and use restricted connector access unless the workflow intentionally needs organization-wide control. Verify the connection with:
Grok Build
Install and enable the Sprites plugin for Grok Build:/plugins and r, or restart Grok. Then run /sprites-status or ask Grok to list your Sprites and complete browser OAuth.
An empty Sprite list means the connection is authenticated. For a fuller check, run /sprites-smoke; it lists Sprites, creates a test Sprite, runs a command, and asks before destroying it.
DeepSeek Harness
The Sprites bundle for DeepSeek Harness requires Node.js 20.19 or newer and the DeepSeek Harness developer preview. Install the bundle into the built-in Web profile, then start that profile:dsh-sprites-plugin, sprites-mcp, and sprites-skill-filesystem. The bundle uses mcp-remote because Harness’s current remote HTTP transport does not complete MCP OAuth itself; you do not need a Sprites API token.
Then ask Harness to list your Sprites and check that the tool returns successfully. The configuration dump confirms installation; it does not by itself confirm an authenticated connection.
OpenCode
The Sprites plugin for OpenCode supports OpenCode 1.18.23 or newer and OpenCode 2 beta.opencode.json:
plugins key and accepts either a path or a file:// URL. Restart OpenCode after changing the configuration.
Run /sprites-status or ask OpenCode to list your Sprites. If the browser does not open, start authorization explicitly:
opencode2 mcp auth sprites for OpenCode 2. No Sprites CLI or pasted API token is required.
Pi
The Pi extension for Sprites requires Node.js 24 or newer. It is not published to npm, so install it directly from GitHub:SPRITE_TOKEN is also accepted. The token stays in the local Pi process and is not copied into remote commands or the Sprite.
Select or create a Sprite, then bootstrap the workspace:
/sprite-local to return them to your local machine.
Herdr
The Sprites plugin for Herdr, listed in the Herdr plugin marketplace, runs a coding agent inside a persistent Sprite controlled from a local Herdr pane. Each agent pane gets its own Sprite. Unlike the hosted-MCP plugins above, the agent itself runs remotely. On your local machine, install Herdr 0.9.0 or newer, Node.js 22 or newer, Git, and the Sprites CLI. The CLI must supportexec --tty, sessions, checkpoint create, restore, and api.
Authenticate and install the plugin; no npm install or build step is required:
config.json in the directory printed by the last command, replacing the organization placeholder:
claude, codex, or opencode for agent.
From a Git worktree in Herdr, launch the configured agent. For a new project, run git init first; no commit is required.
setup-launched response only means setup started; check the pane and run Info to confirm the Sprite mapping and remote session, or see setup errors:
Hermes Agent
The Sprites plugin for Hermes Agent adds a terminal backend. Hermes stays on its existing host, while its shell commands execute in persistent Sprites. It uses the Sprites Python SDK and an API token, not hosted MCP or browser OAuth. Use a current Hermes installation that includes the pluggable terminal-backend extension (Hermes PR #94400). The commands below assume the standard macOS/Linux installation and default~/.hermes home. For a custom installation or profile, use its plugin directory, secrets file, and Python environment.
Clone the plugin and install its supported SDK version into Hermes’s Python environment, not your system Python:
~/.hermes/.env locally and add the token, replacing this placeholder. Keep existing settings in the file:
hermes doctor checks whether the token and SDK are present. It does not prove that the token can authenticate to Sprites. Restart any running Hermes session or gateway, then start a new session and ask:
terminal.container_persistent to false creates disposable Sprites that are deleted on cleanup, so do not use that mode for work you need to retain.
Cortex Code
Cortex Code has a focused guide because its plugin includes Snowflake-specific workflows, long-running task support, and explicit authorization steps. Continue with Cortex Code.If setup gets stuck
- OAuth fails or repeats: see authentication troubleshooting.
- An expected Sprite is missing: check the selected organization and connector access policy. A successful empty list is different from an authentication error; see Sprite visibility.
- A package cannot be found: check the integration’s source-installation notice above before trying another package with a similar name.