MeduxMedux
Overview / CLI

Start with the Medux CLI

Install medux-cli from npm and call every Medux capability — with the same account, API key, tasks, and credits system as the public API — straight from your terminal or your coding agent's shell.

Browse API Reference

How to start

1

Sign in and get your Medux API key.

2

Try it instantly with npx — no install needed. Or install it globally with npm, curl, or PowerShell. Whichever you pick, the commands below switch to match.

npx medux-cli --help

Using a non-default npm registry (e.g. a China mirror like registry.npmmirror.com) that hasn't synced this package yet? Point at the official one: npx --registry https://registry.npmjs.org/ medux-cli --help (the --registry flag must come before the package name for npx) or npm install -g medux-cli --registry https://registry.npmjs.org/. The curl/PowerShell scripts always fetch from registry.npmjs.org directly, so they're unaffected by any mirror setting.

3

Save your API key so you don't have to pass it on every call — with auth login, or by setting an environment variable.

npx medux-cli auth login --api-key sk-medux-...
4

Browse capabilities, then inspect one before calling it — every parameter's name, type, required/optional status, enum values, and output media type.

npx medux-cli cap list
5

Call it. Local files passed via --file are uploaded automatically; --wait polls the task and --out downloads the result once it succeeds.

npx medux-cli call <capability_key> --param key=value --file key=path --wait --out result.ext

What this means

  • medux-cli shares the same account, API key, credits, task, and asset system as the public API, Playground, and MCP — results are interchangeable across all four.
  • The shortest path is discover, inspect, then call: cap list, then cap show <capability_key>, then call <capability_key> — cap show already lists every parameter's type, required/optional status, enum values, and output media type, so there's no separate schema to look up.
  • For coding agents that run a shell (Claude Code, Codex CLI, and similar), add the install and call pattern to your project's AGENTS.md or CLAUDE.md — the agent reads it automatically and calls medux-cli correctly with no extra setup.
  • Choosing between CLI and MCP: MCP suits agent frameworks that speak the MCP protocol natively, with no manual auth or HTTP calls to handle; CLI suits anything with shell access — coding agents, CI scripts, or manual calls — with no MCP client or server to configure.

What you get

A single zero-dependency binary published to npm for macOS, Linux, and Windows (arm64 and x64) — no extra runtime to install or keep updated.

The same account, API key, credits, task, and asset system as the public API and Playground — nothing new to configure, and results are interchangeable across API / Playground / CLI / MCP.

Built for humans and coding agents alike: every command and subcommand supports -h, and medux cap show prints the exact machine-readable parameter contract (type, required, enum values, output media type) a script or an agent needs before making a call — no separate schema file to fetch.