Profiles

Manage Arize CLI configuration profiles

The ax profiles commands let you create and manage named configuration profiles. Each profile stores an API key, routing settings, and output preferences. The active profile is used by all other ax commands.

ax profiles create

Create a new configuration profile. Runs interactively by default; use flags or --from-file to skip prompts.

ax profiles create [<profile-name>] [--api-key <key>] [--region <region>] [--output-format <format>] [--from-file <path>]

Option	Description
--api-key	Arize API key
--region	Routing region (e.g. us-east-1b)
--output-format	Output format: table, json, csv, parquet
--from-file, -f	Path to a TOML config file to load values from
--verbose, -v	Enable verbose logs

Precedence (highest to lowest): CLI flags > --from-file > interactive prompts.

If no profiles exist, the profile name defaults to default with no prompt. Detects existing ARIZE_* environment variables when running interactively (only when neither flags nor --from-file are used).

Examples:

# Interactive setup
ax profiles create

# Non-interactive with flags
ax profiles create my-profile --api-key ak_abc123

# From a TOML file
ax profiles create staging --from-file ./staging.toml

ax profiles update

Update an existing profile. With --from-file, the profile is replaced by the file contents (flags are applied on top). With flags only, specified fields are updated and all others are preserved.

ax profiles update [<profile>] [--api-key <key>] [--region <region>] [--output-format <format>] [--from-file <path>]

Option	Description
--api-key	New Arize API key
--region	New routing region
--output-format	New output format
--from-file, -f	Replace profile with values from this TOML file
--verbose, -v	Enable verbose logs

Examples:

# Update the active profile's API key
ax profiles update --api-key ak_new123

# Update a named profile from a file
ax profiles update staging --from-file ./staging.toml

ax profiles list

List all available configuration profiles. The active profile is marked with a dot.

ax profiles list

Example:

ax profiles list

ax profiles show

Show configuration for a profile. By default shows environment variable references like ${ARIZE_API_KEY} without expanding them.

ax profiles show [<profile>] [--all] [--expand]

Option	Description
--all	Show all sections including defaults
--expand	Expand environment variable references to their actual values
--verbose, -v	Enable verbose logs

Examples:

# Show the active profile
ax profiles show

# Show a named profile with all sections expanded
ax profiles show my-profile --all --expand

ax profiles use

Switch to a different configuration profile. Makes the specified profile active for all future commands.

ax profiles use <profile>

Example:

ax profiles use staging

ax profiles validate

Validate a configuration profile. Checks for missing or incorrect configuration and reports any issues.

ax profiles validate [<profile>]

Example:

ax profiles validate my-profile

ax profiles delete

Delete a configuration profile.

ax profiles delete <profile> [--force]

Option	Description
--force, -f	Skip the confirmation prompt

Examples:

ax profiles delete old-profile
ax profiles delete old-profile --force