> ## Documentation Index > Fetch the complete documentation index at: https://arize-ax.mintlify.site/docs/llms.txt > Use this file to discover all available pages before exploring further. # AX CLI > Command-line interface for managing Arize AX resources The AX CLI (`ax`) lets you manage your Arize AI platform resources — datasets, projects, spans, and configuration profiles — directly from your terminal. It's useful for scripting workflows, automating data pipelines, and integrating Arize into CI/CD environments. ## Getting Started ### 1. Install the CLI Requires Python 3.11 or later. ```bash theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} pip install arize-ax-cli ``` Verify the installation: ```bash theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} ax --version ``` ### 2. Create a configuration profile ```bash theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} ax profiles create ``` You'll be prompted for your API key, region, and preferred output format. Choose **Simple mode** for most use cases, or **Advanced mode** for custom routing, transport tuning, and SSL settings. `ax profiles create` is required before running any other commands. Without it, most commands will fail with: `Error: Profile 'default' not found.` ### 3. Verify your setup ```bash theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} ax profiles show # Check your profile settings ax projects list # Run your first command ``` ### Shell Completion (optional) Enable tab completion for your shell: ```bash theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} ax --install-completion ``` Supports bash, zsh, fish, and PowerShell. Restart your shell or source your profile to activate. *** ## Configuration Profiles store your API key, region, and output preferences so you don't have to pass them on every command. Configuration files are stored at: * **macOS/Linux:** `~/.arize/profiles/.toml` * **Windows:** `%USERPROFILE%\.arize\profiles\.toml` The CLI automatically detects any `ARIZE_*` environment variables in your shell and offers to use them during `ax profiles create`. You can also reference environment variables in config files using `${VARIABLE_NAME}` syntax. **Using a self-hosted, on-premise, or VPC deployment?** You'll need to configure custom endpoint routing in your profile. See [Self-Hosted / On-Premise Configuration](/docs/api-clients/cli/profiles#self-hosted--on-premise-configuration) for setup instructions. ### Managing Profiles Here's a full reference of profile commands: ```bash theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} ax profiles create # Create a new profile ax profiles list # List all profiles (active profile is marked) ax profiles show # Show active profile settings ax profiles show myprofile # Show a specific profile ax profiles show --expand # Resolve environment variable references ax profiles show --all # Show all sections including defaults ax profiles use # Switch the active profile ax profiles delete # Delete a profile (cannot delete default or active) ax profiles delete --force # Delete without confirmation prompt ``` ### Working with Multiple Environments Create separate profiles for production and staging, then switch between them as needed: ```bash theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} ax profiles create # name it "production" ax profiles create # name it "staging" # Switch the active profile ax profiles use production # Run commands against the active profile ax datasets list --space sp_stg123 ``` *** ## Options & Output ### Top-Level Options These options are available on the root `ax` command itself: | Option | Short | Description | | - | - | - | | `--version` | | Show version and exit | | `--install-completion` | | Install shell completion | | `--show-completion` | | Show completion script for your shell | | `--help` | `-h` | Show help | ### Subcommand Options Most subcommands (e.g., `ax datasets list`, `ax projects get`) accept these options: | Option | Short | Description | | - | - | - | | `--output ` | `-o` | Set output format (`table`, `json`, `csv`, `parquet`) or write to a file path | | `--verbose` | `-v` | Enable detailed logging | | `--help` | `-h` | Show help for the command | The active profile is selected with `ax profiles use `; it applies to every subsequent command. There is no per-command profile flag. `--output` is a subcommand option, not a top-level flag. Use it after the subcommand: `ax datasets list --output json`, not `ax --output json datasets list`. ### Output Formats The default output format is `table`. Use `--output` to change the format or write results directly to a file: | Format | Description | | - | - | | `table` | Human-readable default; formatted for the terminal | | `json` | Machine-parseable JSON | | `csv` | Spreadsheet-compatible format | | `parquet` | Apache columnar format for large datasets | ```bash theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} ax datasets list --output json # Print as JSON ax datasets list --output datasets.json # Write to a JSON file ax datasets export --stdout | jq '.' > out.json # Pipe export to file ``` *** ## Resources Create and manage LLM provider integrations Manage LLM and agent integrations Create and manage annotation schemas Create, refresh, and revoke API keys Create, list, and manage datasets Create and manage LLM-as-judge evaluators Create, list, and manage experiments Create, list, and manage projects Create and version prompt templates Create, list, and manage spaces Export span data with filtering Create and manage evaluation tasks List and export trace data Create, list, and manage users Create and manage human review queues Sign in and out via OAuth Create, list, and manage organizations Restrict and unrestrict platform resources Assign roles to users on resources Create and manage custom roles Install Arize skills for AI coding agents Set up AX tracing with your coding agent Upgrade the CLI to the latest version *** ## Useful Links Install and version history Source code and issues Get help from the community Contact the Arize support team