Configuration#
Global options#
These work before the command, e.g. ipx --json usage get, and also after it (ipx usage get --json).
Option |
Meaning |
|---|---|
|
Print machine-readable JSON instead of formatted output (also |
|
Run the command in this organization, overriding the saved context. |
|
Ignore the organization context for this command. |
|
Use a different API endpoint (also |
|
Only print results and errors. |
|
Answer yes to confirmation prompts (required for destructive commands in scripts). |
|
Disable colors ( |
|
Version and help. |
Settings#
$ ipx config list
$ ipx config set default_gen_model lightning
$ ipx config get ollama_url
$ ipx config unset output_dir
$ ipx config path
Key |
Meaning |
|---|---|
|
API endpoint. Default |
|
Where the local Ollama runtime listens. Default |
|
Active organization (prefer |
|
Model used when you do not pass |
|
Folder generated images, video and audio are saved to when you do not pass |
Files#
The config folder is %APPDATA%\ipx on Windows, ~/Library/Application Support/ipx on macOS and
$XDG_CONFIG_HOME/ipx (~/.config/ipx) on Linux. Set IPX_HOME to use another folder.
File |
Purpose |
|---|---|
|
Preferences and the organization context. Also holds a stable |
|
Sign-in tokens or API key (owner-only permissions on macOS/Linux). |
|
Cached organization desktop policy. |
|
State and log of |
Exit codes#
|
Success. |
|
The command failed (error message on standard error). |
|
Usage error (unknown option, missing argument). |
|
Cancelled with Ctrl+C. |