Splat CLI and Agent Skills

Install and use the Splat CLI, plus optional Codex and Claude Code agent guidance.

The Splat CLI lets you use Splat from a terminal or from local automation. It can authenticate with your Splat account, inspect market and portfolio data, manage API/OAuth access, prepare trading actions, and run delegated signing flows when you explicitly enable trading access.

The optional Splat agent skills package installs guidance for Codex and Claude Code so AI coding agents know how to inspect the live CLI surface before giving advice, and how to avoid unsafe final trading, signing, bridge, reward, token, or revoke actions unless you explicitly ask for them.

Install the CLI

The recommended macOS install path is Homebrew:

brew install protastudios/tap/splat

To update an existing Homebrew install:

brew upgrade splat

You can also use the public release installer:

curl -fsSL https://raw.githubusercontent.com/protastudios/splat-cli-releases/main/install-release.sh | bash

After installing, verify the CLI:

splat --help
splat doctor
splat --json commands

splat doctor checks local CLI configuration, API reachability, and platform scope endpoint availability. splat --json commands prints the structured command catalog and is the safest source of truth for automation.

Log in

For normal production use:

splat auth login
splat auth status
splat me

splat auth is an alias for the default production login flow.

Some operations require delegated local trading credentials. Only request them when you intend to use commands that sign or submit swaps, staged orders, cancellations, reward claims, or similar trading actions:

splat auth login --enable-trading

The browser approval page should show that trading delegation is requested. Without --enable-trading, the CLI can still authenticate for read and API workflows, but local signing commands will not have the Turnkey CLI credential they need.

For local development:

splat auth login --dev
splat doctor

What the CLI can do

Use the live command catalog for the complete current surface:

splat --json commands

The current CLI includes these major areas:

Area	Purpose	Example
Auth	Log in, save tokens, inspect status, create or revoke personal API tokens	splat auth status
Account	Fetch Hyperliquid open orders, spot balances, perp balance, and portfolio history	splat account portfolio
Market	Search tokens, fetch token details, candles, and market transactions	splat market tokens search SOL
Portfolio	Fetch Solana PnL graph data for the current or specified wallet	splat portfolio solana-pnl
Solana	Quote, build, execute, and inspect Solana swaps, limit orders, tokens, PnL, and trading history	splat solana tokens
Orders	Create or stage Hyperliquid spot/perp orders, TP/SL orders, cancellations, and builder-fee approvals	splat orders pending
Rewards	Inspect reward totals and claim Solana or Hyperliquid rewards when signed access is enabled	splat rewards summary <userId>
Bridge	Create, send, withdraw, quote, and poll bridge flows	splat bridge poll <userAddress>
OAuth	Manage OAuth clients and exchange, refresh, introspect, or revoke OAuth tokens	splat oauth clients list
API	Call backend GET, POST, PATCH, and DELETE routes directly	splat api get /health

For group-specific usage, run:

splat help auth
splat help orders
splat help solana
splat help oauth

Safe operating model

The CLI separates low-risk inspection from actions that can affect wallets, tokens, orders, rewards, or bridge state.

Generally safe diagnostic commands:

splat --help
splat doctor
splat --json commands
splat auth status
splat me
splat market tokens search SOL
splat portfolio solana-pnl

Commands that create, revoke, sign, submit, claim, bridge, cancel, or confirm should be run only when you intend that exact operation.

Final-action commands require extra care, including:

splat orders confirm <executionId>
splat solana swap execute ...
splat solana swap submit ...
splat solana swap limit-execute ...
splat solana swap limit-orders cancel ...
splat rewards claim-solana
splat rewards claim-hyperliquid
splat auth token revoke ...
splat api-tokens revoke ...

When in doubt, inspect or stage first, review the planned command and expected impact, then run the final command only after explicit confirmation.

Install agent skills

The agent skills package is separate from the CLI. It does not replace splat; it gives AI coding agents Splat-specific operating instructions.

Install both Codex and Claude Code guidance:

npx @asksplat/agent-skills install

Install only one target:

npx @asksplat/agent-skills install --codex
npx @asksplat/agent-skills install --claude

The installer copies:

Target	Installed files
Codex	~/.codex/skills/splat-cli
Claude Code	~/.claude/commands/splat.md and ~/.claude/SPLAT_CLAUDE.md

You can override the target homes:

npx @asksplat/agent-skills install --codex-home /path/to/.codex
npx @asksplat/agent-skills install --claude-home /path/to/.claude

Preview the file operations without writing:

npx @asksplat/agent-skills install --dry-run

Restart Codex or Claude Code after installation if the new skill or command is not discovered immediately.

What the agent skill changes

The Codex skill is named splat-cli. It tells Codex to:

• Check whether splat is installed.

• Run splat doctor when setup, auth, API reachability, trading, signing, or local environments matter.

• Run splat --json commands before giving detailed command advice.

• Use splat help <group> for group-specific command usage.

• Prefer JSON output when another tool or agent will parse the result.

• Verify auth with splat auth status and splat me before assuming a user is logged in.

• Treat final submit, confirm, revoke, claim, bridge, grant, and signing actions as explicit-confirmation operations.

The Claude Code command is exposed as /splat and follows the same core rules: inspect the live CLI surface, prefer read-only checks first, and do not run final trading or token-changing actions unless the user explicitly asks for that final action.

Troubleshooting

If splat is not found after installation, open a new terminal and check your PATH. Homebrew installs the binary under the Homebrew prefix, commonly /opt/homebrew/bin on Apple Silicon Macs.

If auth appears configured but a command still fails, run:

splat doctor
splat auth status
splat me

If a signing or execution command fails because no delegated trading credential is available, log in again with:

splat auth login --enable-trading

If an agent gives stale command advice, ask it to run:

splat --json commands

That command is the canonical live command catalog.