Skip to content

Configuration

ActionXM CLI stores its configuration in a JSON file at ~/.config/actionxm/config.json.

Config file location

OSPath
Linux~/.config/actionxm/config.json
macOS~/.config/actionxm/config.json
Windows%USERPROFILE%\.config\actionxm\config.json

Config keys

KeyTypeDefaultDescription
api_urlstringhttp://localhost:3002ActionXM API server URL
access_tokenstringJWT authentication token
current_site_idstringActive site UUID
current_site_namestringActive site display name
userobjectCached user profile
sitesarrayCached site list

File permissions

The config file is created with 0600 permissions (owner read/write only) to protect the stored access token.

Modifying configuration

Use the actionxm config commands:

bash
# View all settings
actionxm config list

# Get a specific value
actionxm config get api_url

# Set a value
actionxm config set api_url https://analytics.yourcompany.com

# Show file path
actionxm config path

WARNING

Do not manually edit the config file while the CLI is running. Use actionxm config set instead.

ActionXM Analytics Platform