Skip to main content
The pixa CLI lets AI agents and scripts interact with Pixa’s image and video tools from the command line.

​
Install

curl -fsSL https://www.pixa.com/install.sh | bash
This downloads the latest pixa binary for your platform and adds it to your PATH.

​
Authenticate

Open a browser-based login flow to connect your Pixa account: 
pixa auth login
This opens your default browser to complete an OAuth login. Once authenticated, your session is stored locally in ~/.pixa/. Alternatively, set an API key directly: 
export PIXA_API_KEY="sk_your_api_key_here"

​
Verify

Check your auth status: 
pixa auth status
This shows the current user, organization, and environment.

​
Update

Update to the latest version: 
pixa update

​
Key commands

Once installed, these are the commands you’ll use most:
CommandDescription
pixa runRun prompts, tools, and pipelines — the primary entrypoint for agents
pixa assetsUpload, list, search, and manage media assets
pixa collectionsOrganize assets into groups
pixa pipelinesInspect and run saved workflows
pixa modelsBrowse available AI models
pixa brandsManage brand libraries and identities
pixa share-linksCreate shareable links to asset selections
pixa jobsInspect and manage long-running operations
pixa usageCheck credit balance and usage history
For the full list of commands and flags, see the CLI Reference.

​
Next steps

Use with Claude Code

Learn how to configure Claude Code to use the Pixa CLI.

CLI Reference

Explore every command, flag, and input format.