Command Reference#

Run ipx <command> --help for options and examples of any command. <org> means the command needs an organization context (or -O).

Account#

Command

Purpose

ipx auth login

Sign in (email, OAuth providers, SSO, API key).

ipx auth logout / signout

Sign out and delete local credentials.

ipx auth status / whoami

Show the active identity, plan and context.

ipx auth context [org] [--clear]

Show or set the organization context.

ipx auth token

Print the current bearer token.

ipx usage get / tiers / ledger

Quotas, wallet and organization spend.

Organizations (<org> except where noted)#

Command

Purpose

ipx org list / plans / create (no context)

Discover and create organizations.

ipx org info / update / delete / transfer

Manage the active organization.

ipx org members list|role|remove|suspend|unsuspend|limits

Members and their roles and limits.

ipx org invite create|list|revoke|resend, accept (no context)

Invitations.

ipx org teams list|create|update|delete|members|add|remove

Teams.

ipx org keys list|create|update|revoke

Organization API keys.

ipx org billing info|ledger|plan|credits|portal|invoices|details|promo|contact-sales

Wallet, plan and invoices.

ipx org usage breakdown|export|report

Usage reporting.

ipx org audit list|export|webhook

Audit log.

ipx org domains list|add|verify|remove, ipx org sso get|set|remove

Domain verification and single sign-on.

ipx org policy get|set, desktop-policy get|set, notifications get|set|test

Policy and alerts.

Cloud generation#

ipx gen (Lightning, subscription) and ipx p2g (Pay-2-Go, credits) share these:

Command

Purpose

chat [-m MODEL] [--system TEXT]

Interactive chat.

text [PROMPT|-] [-m] [--system] [-f FILE] [--stdin] [--no-stream]

One-off text generation.

image PROMPT [-n 1-4] [--mode fantasy|realistic] [--ref IMG] [-o]

Image generation.

video PROMPT [--size] [--seconds] [--ref] [--no-wait] [-o]; --status ID; --download ID

Asynchronous video.

audio speech|sfx|timestamps|transcribe|voice-change|isolate|stems

Audio generation and processing.

models [-t TYPE] [-s TEXT]

Available models.

models --type also accepts embedding, realtime and decision on ipx p2g.

Only ipx gen: plan. Only ipx p2g: 3d, embed, decision [STATE] [-m MODEL] [-q QUESTIONS.json | -f REQUEST.json|-] [-o OUTPUT.json], realtime chat|transcribe, balance, ledger, pricing, keys list|create|revoke, deploy models|status|create|list|get|usage|cancel|uncancel|delete.

Featherless, agents and MCP#

Command

Purpose

ipx featherless models|status|list|get|deploy|cancel|restore|terminate|usage

Featherless deployments; the organization’s when a context is set (Featherless deployments: ipx featherless).

ipx agent list|registry|get|create|update|delete|chat|ask

Managed agents (Agents: ipx agent).

ipx agent profile show|set, settings show|set, roles

Agent username, preferences and sharing roles.

ipx agent invite create|list|preview|accept|deny|revoke, members list|role|remove

Share agents.

ipx mcp council tiers|models|reason|tools|test|connect

Council of LLMs MCP server (Council of LLMs: ipx mcp council).

Local#

Command

Purpose

ipx model list|search|pull|show|ps|copy|rm|create

Manage local models.

ipx model import gguf|hf

Import a GGUF file or Hugging Face model.

ipx local chat|text

Chat with local models.

ipx server start|stop|status|logs

Host your models.

ipx import space|website|file|list|rm

Desktop library imports.

Tools#

Command

Purpose

ipx config list|get|set|unset|path

Preferences.

ipx status

Service health.

ipx doctor

Diagnose your setup.

ipx api METHOD PATH [-d JSON] [-q key=value]

Raw authenticated request.

ipx rewards list|summary|claim

Rewards and discounts.

ipx completion bash|zsh|fish

Shell completion script.

AI Shield#

Full guide: ipx shield reference.

Command

Purpose

ipx shield check TYPE [VALUES…]

Bulk single-type checks (email, domain, url, ip, phone, username, user_agent, wallet, jwt, hash, secret).

ipx shield disposable [VALUES…]

Is this email or domain a disposable address?

ipx shield scan [TEXT]

Prompt attacks, abuse, scams, links, secrets and PII in text, files or stdin.

ipx shield analyze

Risk-score a signup, login or payment from signals.

ipx shield phishing

Phishing verdict for text or an .eml file.

ipx shield url / request / file

Link analysis, WAF-style request check, upload triage.

ipx shield password / listing / review / domain

Password strength and breaches, marketplace listings, reviews, domains and wallets.

ipx shield tasks

Task profiles, features and check types (no sign-in).