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 splixirOr run without installingbash
npx splixir --helpAuthentication & 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 logoutsplixir 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| Flag | Example | Default | Description |
|---|---|---|---|
--resize <WxH> | 1200x800, 800x, x600 | Optional | Target dimensions. |
--fit <mode> | contain|cover|fill|inside|outside | inside | Resize fit strategy. |
--allow-enlargement | boolean | false | Allow upscaling smaller images. |
--crop <x,y,w,h> | 100,50,800,600 | Optional | Region pixel crop. |
--aspect <W:H> | 16:9 | Optional | Aspect-ratio crop. |
--gravity <pos> | center|north|south|east|west|smart | center | Anchor for --aspect crop. |
--format <fmt> | webp|avif|png|jpeg | Optional | Target output format. |
--quality <1-100> | 85 | Optional | Encoder quality. |
--lossless / --progressive | boolean | false | Lossless or progressive encoding. |
--strip / --no-strip | boolean | --strip (true) | Strip EXIF/XMP/GPS while keeping orientation & color profile. |
--rotate <angle> | 90|180|270 | Optional | Clockwise rotation. |
-o, --output <path> | ./out.webp | Optional | Download verified output to a local file. |
--destination <url> | https://... | Optional | Pre-signed PUT URL for direct cloud delivery. |
--callback <url> | https://... | Optional | Per-job webhook URL. |
--no-wait | boolean | Waits (true) | Submit async and print job ID immediately. |
--json | boolean | false | Emit 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 docsStdio 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.