CLI

splice <command> [options]

Install

npm install -g @spliceloom/cli     # Node.js >= 22.18; installs the `splice` command

Install it with npm install -g @spliceloom/cli (Node.js >= 22.18), or use a local tarball (releasing.md) or npm link -w @spliceloom/cli from a source checkout. The unscoped npm name splice belongs to an unrelated package, hence the scope. New to Splice? Start with getting-started.md.

Commands

Live data commands

Real provider data for Robinhood Chain mainnet (4663, the only supported chain). Every result is shown as ● LIVE, ○ CACHED (not live; --fresh refetches), – UNAVAILABLE or ✗ ERROR, with its provider and block. Keys come from provider environment variables only; see data-providers.md.

Options: --chain <key|id>, --fresh (bypass the cache), --json; ai: --model, --provider, --system, --max-tokens, --temperature, --schema, --no-fallback, --search; github: --ref, --page, --per-page, --state, --max-bytes; market: --vs, --timeframe, --aggregate, --limit; web: --provider, --limit, --content, --max-chars, --include-domain, --exclude-domain. Exit codes for these commands: 0 live or cached, 3 unavailable, 1 provider error, 2 invalid input.

Global options

Registry precedence: --registry → SPLICE_REGISTRY → splice.json registry → ~/.splice/config.json (splice config set registry …) → https://registry.spliceloom.com (the live production registry). For a local registry: splice config set registry local.

Environment: SPLICE_REGISTRY, SPLICE_TOKEN (overrides the saved token), SPLICE_HOME (default ~/.splice), NO_COLOR.

Exit codes

Package references

• @splice/example — latest stable version (saved as ^<version> in splice.json).
• @splice/example@0.1.0 — exact version.
• @splice/example@^0.1.0, @splice/example@~0.1.0, @splice/example@*.

Tool references

• example.hello — short form, resolved among installed packages by name.
• @splice/example.hello — full form; required when two installed packages share a name.

Tool input

splice run example.hello name=Dim excited=true
splice run example.hello --input '{"name":"Dim","excited":true}'
splice run example.hello --input '{"name":"Dim"}' excited=true   # pairs override --input

key=value values are coerced using the tool's input schema: string properties stay strings, number/integer/boolean are converted, untyped properties are parsed as JSON when possible.

Output: the tool's JSON output on stdout; tool logs on stderr, prefixed with the tool name. With --json, stdout contains the full result envelope:

{ "ok": true, "package": "@splice/example", "tool": "hello",
  "output": { "message": "Hello, Dim!" }, "logs": "", "durationMs": 118 }

On failure ok is false and error holds { code, message, details? } (codes: INVALID_INPUT, INVALID_OUTPUT, TOOL_NOT_FOUND, PERMISSION_DENIED, TOOL_LOAD_FAILED, TOOL_ERROR, TIMEOUT, OUTPUT_TOO_LARGE, TOOL_CRASHED).

Example session

$ splice search example
@splice/example
Official example skill: greetings and text statistics. No external APIs.
latest: 0.1.1

$ splice add @splice/example
Resolving @splice/example...
Downloading @splice/example@0.1.1...
Verifying sha256-6da7…...
Installing .splice/packages/@splice/example...
Installed @splice/example@0.1.1
  permissions: none (sandboxed: no file, network or environment access)
  tools: example.hello, example.stats

$ splice list
@splice/example  0.1.1

$ splice run example.hello name=Dim
{
  "message": "Hello, Dim."
}

$ splice outdated
Package          Current  Wanted  Latest  Range
@splice/example  0.1.1    0.1.1   0.1.1   ^0.1.1  up to date

All packages are up to date within their ranges.

--json output of add/install: [{ name, version, integrity, alreadyInstalled, previousVersion, fromCache, offline, permissions, tools }] (fromCache/offline added in Phase 6; existing fields unchanged).