Skip to main content

​
Skills + CLI

Use the official CLI to work with DumplingAI’s Unified API Platform directly from your terminal. The CLI is built around the /api/v2 workflow:
  1. search the catalog
  2. inspect the capability or endpoint you want
  3. run it with JSON input

​
Install

npm install -g dumplingai-cli
dumplingai init
dumplingai init walks through authentication and can install bundled agent skills in the same flow.

​
Authenticate

dumplingai login --api-key sk_yourkey
Get your API key from app.dumplingai.com/settings/api-keys. Then confirm setup: 
dumplingai status

​
Common commands

CommandDescription
dumplingai initAuthenticate and optionally install bundled agent skills
dumplingai login --api-key <key>Save API credentials
dumplingai logoutRemove stored credentials
dumplingai statusShow CLI version, auth status, and /v2 balance context
dumplingai env pullWrite API key into .env
dumplingai catalog search <prompt>Search /api/v2 capabilities, providers, and endpoints
dumplingai catalog details <type> <id>Inspect a specific catalog object
dumplingai run <type> <id> --input '<json>'Execute a capability or endpoint
dumplingai balanceShow balance and budget information
dumplingai usageShow request usage logs
dumplingai transactionsShow credit transaction history
dumplingai view-configPrint resolved configuration
dumplingai versionPrint CLI version

​
Examples

# Discover available capabilities
dumplingai catalog search "google search"

# Inspect a capability before running it
dumplingai catalog details capability google_search

# Execute a capability with inline JSON input
dumplingai run capability google_search --input '{"query":"latest TypeScript release"}'

# Execute an endpoint with JSON from disk
dumplingai run endpoint firecrawl.scrape --input-file payload.json

# Inspect account data
dumplingai balance
dumplingai usage --object-type capability --limit 20

​
Output and automation tips

  • Use --input-file when your request body is easier to manage as JSON on disk.
  • Redirect large JSON responses into .dumplingai/ or another local file when you want to inspect them incrementally.
  • Use dumplingai env pull when you want the CLI key written into a local .env file for adjacent tooling.
dumplingai run capability scrape_page --input '{"url":"https://example.com"}' > .dumplingai/page.json
head -40 .dumplingai/page.json

​
Agent skills

The CLI repo also ships packaged skills for supported coding agents. These help agents discover DumplingAI APIs, choose the right CLI commands, and reuse workflow templates.

​
Install

For Codex, Claude Code, and Cursor, dumplingai init is the recommended path because it can install bundled skills during setup. Use manual installation only if:
  • you skipped skills during dumplingai init
  • you want to selectively install skills
  • you are using another compatible agent environment
npx skills add dumplingai/cli
You can list and selectively install packaged skills: 
npx skills add dumplingai/cli --list
npx skills add dumplingai/cli --skill discovering-dumplingai-apis --skill dumplingai-cli
You can also run dumplingai init and install skills during setup.

​
Supported environments

Local agent/runtime folders such as these are intentionally supported:
  • ./.claude/skills/dumplingai-cli (Claude Code)
  • ./.agents/skills/dumplingai-cli (Agents)
  • ./.cursor/skills/dumplingai-cli (Cursor)
  • ./.codex/skills/dumplingai-cli (Codex)

​
What gets installed

Depending on the package you install, these skills can include API discovery guidance, CLI usage patterns, and reusable workflow templates such as YouTube-to-blog-post or social media generation.

​
Validate installation

Inspect one of the installed directories for your agent environment: 
ls -la ./.codex/skills/dumplingai-cli

​
Next steps