Developer Tools

Splixir CLI

Zero-dependency developer CLI for transforming local files or remote URLs, inspecting wallet balance, managing jobs, and running a local stdio MCP server.

Installation#

Install globally with npm or run directly with npx (Node.js 20+):

Install globallybash
npm i -g splixir
Or run without installingbash
npx splixir --help

Authentication & balance#

Credentials are stored in ~/.splixir/config.json (with 0600 permissions on Unix). You can also override via SPLIXIR_API_KEY and SPLIXIR_API_URL environment variables.

Auth & wallet commandsbash
# Save and verify API key against GET /v1/balance
splixir login --key splx_live_...

# Check current wallet balance (promo, monthly allowance, prepaid)
splixir balance
splixir balance --json

# Check active config & clear credentials
splixir whoami
splixir logout

splixir image#

Transform either a local file (automatically staged via POST /v1/uploads/presign) or a remote URL in one command:

splixir image examplesbash
# Local file -> resize + convert to WebP + strip EXIF -> download to disk
splixir image ./raw-photo.jpg --resize 1200x800 --fit cover --format webp --quality 85 -o hero.webp

# Remote URL -> smart 16:9 crop + AVIF
splixir image "https://example.com/banner.png" --aspect 16:9 --gravity smart --format avif -o banner.avif

# Cloud-to-cloud direct delivery (async)
splixir image "https://example.com/in.png" --resize 800x --destination "https://s3..." --no-wait --json
FlagExampleDefaultDescription
--resize <WxH>1200x800, 800x, x600OptionalTarget dimensions.
--fit <mode>contain|cover|fill|inside|outsideinsideResize fit strategy.
--allow-enlargementbooleanfalseAllow upscaling smaller images.
--crop <x,y,w,h>100,50,800,600OptionalRegion pixel crop.
--aspect <W:H>16:9OptionalAspect-ratio crop.
--gravity <pos>center|north|south|east|west|smartcenterAnchor for --aspect crop.
--format <fmt>webp|avif|png|jpegOptionalTarget output format.
--quality <1-100>85OptionalEncoder quality.
--lossless / --progressivebooleanfalseLossless or progressive encoding.
--strip / --no-stripboolean--strip (true)Strip EXIF/XMP/GPS while keeping orientation & color profile.
--rotate <angle>90|180|270OptionalClockwise rotation.
-o, --output <path>./out.webpOptionalDownload verified output to a local file.
--destination <url>https://...OptionalPre-signed PUT URL for direct cloud delivery.
--callback <url>https://...OptionalPer-job webhook URL.
--no-waitbooleanWaits (true)Submit async and print job ID immediately.
--jsonbooleanfalseEmit machine-readable JSON output.

Job & offline commands#

Job lifecycle & offline validationbash
# Generate a starter splixir.job.json matching @splixir/types
splixir init --kind image

# Validate a job JSON file offline (no API key required)
splixir validate splixir.job.json

# Submit, inspect, list, or cancel jobs
splixir job submit splixir.job.json --wait
splixir job status job_01JMX9K2...
splixir job list --state delivered --limit 20
splixir job report job_01JMX9K2...
splixir job cancel job_01JMX9K2...

# Open docs.splixir.com in your browser
splixir docs

Stdio MCP Server built in

The CLI also ships a zero-dependency stdio MCP server via npx -y splixir mcp. See the MCP Server guide for copy-paste client configs.