actionxm
v0.1.17
Published
ActionXM CLI — command-line interface for the ActionXM analytics platform
Readme
ActionXM CLI
Command-line interface for the ActionXM analytics platform.
Installation
npm install -g actionxmRequires Node.js 18 or later.
Quick Start
# Authenticate via browser-based device flow
actionxm auth login
# List your projects
actionxm projects list
# Create a project
actionxm projects create --name "My Store" --type web --domain mystore.com
# Check CLI status
actionxm statusCommands
| Command | Description |
| ---------------------------------- | --------------------------------------------------- |
| actionxm auth login | Authenticate via browser-based device authorization |
| actionxm auth logout | Clear stored credentials |
| actionxm auth status | Show current authentication state |
| actionxm projects list | List projects in your tenant |
| actionxm projects create | Create a new project |
| actionxm projects edit | Edit an existing project |
| actionxm projects remove | Remove a project |
| actionxm status | Show CLI state overview |
| actionxm config get | Get a configuration value |
| actionxm config set | Set a configuration value |
| actionxm config list | Show all configuration |
| actionxm config path | Show config file location |
| actionxm docs | Open documentation in browser |
| actionxm genome create | Create a new genome version |
| actionxm genome list | List genome versions |
| actionxm genome status | Show most recent genome version status |
| actionxm genome cancel | Cancel an in-progress genome version |
| actionxm genome remove | Delete a genome version |
| actionxm genome summary view | View genome summary markdown |
| actionxm genome summary edit | Override genome summary with a local file |
| actionxm genome suggestion view | View suggested event rules and configuration |
| actionxm genome suggestion apply | Apply suggestions to project configuration |
Genome
The genome commands manage AI-powered site analysis versions. Genome crawls your site, builds a tracking plan, ICP profile, and generates suggested event rules.
# Create a new genome version (uses default project)
actionxm genome create
# Create with a custom name and scoped URLs
actionxm genome create --version "post-redesign" --scope /pricing /signup /docs
# Check status of the most recent version (works for in-progress, created, completed, etc.)
actionxm genome status
# List all versions
actionxm genome list
actionxm genome list --limit 5
# Cancel an in-progress version
actionxm genome cancel --version v3
# View results
actionxm genome summary view --version v1
actionxm genome suggestion view --version v1
# Apply suggested event rules and labels to your project
actionxm genome suggestion apply --version v1
# Override the genome summary with a local markdown file
actionxm genome summary edit --version v1 --file ./my-summary.md
# Delete a version
actionxm genome remove --version v2
# Use --site to target a specific project
actionxm genome status --site 550e8400-e29b-41d4-a716-446655440000Pipeline Stages
When a genome version is in progress, genome status shows the current stage:
| Stage | Description |
| ----------------- | ------------------------------------------------ |
| discover | Analyzing site structure and building crawl plan |
| collect_analyze | Fetching and analyzing individual pages |
| synthesize | Building tracking plan from collected data |
| suggestions | Generating event rules and configuration |
Configuration
Configuration is stored at ~/.config/actionxm/config.json.
# Point CLI to a different API server (default: https://app.action-xm.com)
actionxm config set api_url https://app-staging.action-xm.com
# View current configuration
actionxm config listCI/CD Usage
For non-interactive environments, set credentials via environment variables or config file:
mkdir -p ~/.config/actionxm
echo '{"api_url":"https://app.action-xm.com","access_token":"YOUR_TOKEN"}' > ~/.config/actionxm/config.json
chmod 600 ~/.config/actionxm/config.jsonDocumentation
Full documentation is available at cli.action-xm.com.
License
Proprietary
