Skip to content

actionxm projects

Manage projects (sites) in your tenant.

actionxm projects list

List all projects in your tenant.

bash
actionxm projects list [--tenant-id <id>]

Options:

FlagDescription
--tenant-id <id>Override tenant (platform_admin only)

Example:

bash
$ actionxm projects list
     Name           Domain             Type  ID
──────────────────────────────────────────────────────────
*    Acme Store     acme-store.com     web   550e8400-...
     Acme API                          api   550e8400-...

Showing 2 of 5 allowed projects. * = active.

The * marker indicates your currently active project.

Exit codes:

  • 0 — Projects listed successfully
  • 1 — Not authenticated, insufficient permissions, or API error

actionxm projects create

Create a new project.

bash
actionxm projects create --name <name> --type <type> [--domain <domain>] [--tenant-id <id>]

Options:

FlagDescription
--name <name>Required. Project name (1-100 characters)
--type <type>Required. Project type: web or api
--domain <domain>Project domain. Required when type is web
--tenant-id <id>Override tenant (platform_admin only)

Validation:

  • Project name must be unique within the tenant
  • Domain must be unique within the tenant
  • Domain is required for web type projects
  • Tenant must not have exceeded its active project limit

Example:

bash
$ actionxm projects create --name "My Store" --type web --domain mystore.com
 Project created: My Store
  ID:     a1b2c3d4-...
  Domain: mystore.com
  Type:   web

 Active project set to My Store
Run actionxm setup to configure tracking for this project.

When --tenant-id is not specified, the newly created project is automatically set as the active project.

Exit codes:

  • 0 — Project created successfully
  • 1 — Validation error, duplicate name/domain, limit reached, or API error

actionxm projects edit

Edit an existing project.

bash
actionxm projects edit <project-id> [--name <name>] [--domain <domain>] [--type <type>] [--tenant-id <id>]

Arguments:

ArgumentDescription
<project-id>Required. UUID of the project to edit

Options:

FlagDescription
--name <name>New project name
--domain <domain>New project domain
--type <type>New project type: web or api
--tenant-id <id>Override tenant (platform_admin only)

At least one of --name, --domain, or --type must be provided.

Validation:

  • New name must be unique within the tenant (excluding the project being edited)
  • New domain must be unique within the tenant (excluding the project being edited)

Example:

bash
$ actionxm projects edit a1b2c3d4-... --name "Renamed Store" --domain newdomain.com
 Project updated: Renamed Store
  ID:     a1b2c3d4-...
  Domain: newdomain.com
  Type:   web

Exit codes:

  • 0 — Project updated successfully
  • 1 — Project not found, validation error, duplicate name/domain, or API error

actionxm projects remove

Remove (soft-delete) a project.

bash
actionxm projects remove <project-id> [--tenant-id <id>] [--confirm]

Arguments:

ArgumentDescription
<project-id>Required. UUID of the project to remove

Options:

FlagDescription
--tenant-id <id>Override tenant (platform_admin only)
--confirmSkip confirmation prompt

In interactive mode (TTY), you will be prompted to confirm the deletion. In non-interactive mode (piped stdin), the --confirm flag is required.

If the removed project was your active project, it will be automatically cleared.

Example:

bash
$ actionxm projects remove a1b2c3d4-...
Are you sure you want to remove project a1b2c3d4-...? (y/N): y
 Project a1b2c3d4-... removed.

With --confirm flag (useful for scripting):

bash
$ actionxm projects remove a1b2c3d4-... --confirm
 Project a1b2c3d4-... removed.

Exit codes:

  • 0 — Project removed successfully
  • 1 — Project not found, not authenticated, or API error

Platform Admin: Tenant Override

Platform administrators (platform_admin role) can manage projects in any tenant by passing the --tenant-id flag:

bash
# List projects for a specific tenant
actionxm projects list --tenant-id 550e8400-e29b-41d4-a716-446655440000

# Create project in another tenant
actionxm projects create --name "Client Store" --type web --domain client.com --tenant-id 550e8400-...

# Edit project in another tenant
actionxm projects edit a1b2c3d4-... --name "Renamed" --tenant-id 550e8400-...

# Remove project from another tenant
actionxm projects remove a1b2c3d4-... --tenant-id 550e8400-... --confirm

Non-admin users' --tenant-id flag is silently ignored (the user's own tenant is used).

ActionXM Analytics Platform