TagadaPay Plugin CLI

Latest Version

v3.0.3 — @tagadapay/plugin-cli

A command-line tool for deploying React apps, static websites, and plugins on TagadaPay with routing, domain management, and instance management.

npm install -g @tagadapay/plugin-cli

The CLI installs two binary aliases: tgd (short) and tgdcli (long). All examples below use tgd.

Quick Start

tgd login

Opens your browser for secure authentication. Defaults to production.

Deploy your plugin

cd my-plugin
tgd deploy

The CLI reads plugin.manifest.json, creates a ZIP of your dist/ folder, uploads it, and deploys.

Interactive Mode

The easiest way to manage everything — deploy, mount, install, manage domains:

tgd interactive

🎛️  TagadaPay Plugin Manager
────────────────────────────

? What would you like to do? (Use arrow keys)
❯ 🚀 Deploy Plugin
  📋 List Deployments
  🔌 Install Plugin from Store
  🔗 Mount Plugin to Alias
  📊 List Instances
  🌐 Manage Domains
  ❌ Exit

Interactive mode provides store selection, config variant picking, real-time upload progress, and guided workflows.

Commands

Authentication

tgd login              # Production (default)
tgd login --dev        # Development
tgd login --local      # Local dev server

tgd logout
tgd logout --dev

tgd whoami

Deploy

tgd deploy                                     # Auto-detect manifest, prompt for store
tgd deploy --store store_abc123                # Specify store
tgd deploy --store store_abc123 --config config/production.json
tgd deploy --plugin-id "custom-id"             # Override plugin ID
tgd deploy --auto-suffix                       # Append random suffix to plugin ID
tgd deploy --overwrite                         # Replace existing deployment (same plugin+version)

Flag	Alias	Description
`--store`	`--store-id`, `-s`	Target store ID (prompts if omitted)
`--config`	`-c`	Path to manifest (default: `plugin.manifest.json`)
`--env`	`-e`	Environment: `dev`, `local`, `prod`
`--dev`	`-d`	Shortcut for `--env dev`
`--local`	`-l`	Shortcut for `--env local`
`--prod`	`-p`	Shortcut for `--env prod` (default)
`--plugin-id`		Override plugin ID from manifest
`--auto-suffix`		Append random 6-char suffix to plugin ID
`--overwrite`	`--force`	Delete existing deployment and replace
`--verbose`		Show detailed API logs

--overwrite permanently deletes the existing deployment (record, instances, routes) and replaces it. This is not reversible.

After deploying, the CLI auto-syncs config templates if a config/ folder exists (presets, schema, uiSchema).

List

tgd list --store store_abc123           # List active plugins
tgd list --store store_abc123 --inactive # Include inactive

Instance Management

tgd install --store store_abc123
# Interactive — select plugin, configure, create instance

tgd list-instances --store store_abc123
# Shows instances grouped by plugin → version → config

tgd mount-alias --store store_abc123
# Interactive — select instance, pick alias

tgd list-mounts --store store_abc123
# Shows all aliases/domains and their mounted routes

Domain Management

Domain commands authenticate via your login session. They do not require --store-id.

tgd list-domains
tgd list-domains --dev

tgd add-domain checkout.example.com
# Adds and auto-verifies

tgd verify-domain cdm_abc123
# Takes a domain ID (not domain name)

tgd remove-domain cdm_abc123

tgd domain-info checkout.example.com

tgd auto-verify-domains

Plugin Manifest

Every plugin requires a plugin.manifest.json. The CLI validates it before deploying.

Required Fields

{
  "pluginId": "my-checkout-plugin",
  "name": "My Checkout Plugin",
  "version": "1.0.0",
  "description": "A custom checkout experience",
  "author": "Your Name",
  "category": "checkout",
  "mode": "direct-mode",
  "pages": [
    {
      "path": "/",
      "features": ["landing"],
      "remappable": false
    },
    {
      "path": "/checkout",
      "features": [
        {
          "type": "checkout",
          "requirements": ["payment"]
        }
      ],
      "remappable": true
    },
    {
      "path": "/thankyou/:orderId",
      "features": [
        {
          "type": "thankyou"
        }
      ],
      "remappable": true
    }
  ],
  "router": {
    "basePath": "/",
    "matcher": ".*",
    "excluder": null
  },
  "requirements": {
    "sdk": "@tagadapay/plugin-sdk",
    "sdkVersion": "v2"
  }
}

All Manifest Fields

Field	Required	Description
`pluginId`	Yes	Unique plugin identifier
`name`	Yes	Human-readable name
`version`	Yes	Semver (`1.0.0`)
`description`	Yes	Short description
`author`	Yes	Author name
`category`	Yes	Category (e.g. `checkout`, `landing`, `upsell`)
`pages`	Yes	Array of page definitions (at least one)
`router`	Yes	Routing config: `basePath`, `matcher`, `excluder`
`requirements`	Yes	SDK info: `sdk`, `sdkVersion` (`v1` or `v2`)
`mode`	No	`direct-mode` (default) or `proxy-mode`
`configuration`	No	Config schema for CRM: `schema`, `uiSchema`, `presets`
`homepage`	No	URL to plugin homepage
`repository`	No	URL to source repository
`license`	No	License identifier
`tags`	No	Array of tag strings
`landingImgUrl`	No	Preview image URL
`public`	No	Whether plugin is listed publicly

Page Features

Simple string features:

{ "path": "/", "features": ["landing"] }

Features with requirements (for pages that need data):

{
  "path": "/checkout",
  "features": [
    {
      "type": "checkout",
      "requirements": ["payment", "shipping", "customer"]
    }
  ]
}

Feature types: landing, checkout, thankyou, product-page, catalog, upsell, post-purchase, static Requirements: payment, shipping, customer, order, cart, inventory

Environments

The CLI supports three built-in environments:

Flag	Environment	API URL
`--prod` (default)	Production	`https://app.tagadapay.com`
`--dev`	Development	`https://app.tagadapay.dev`
`--local`	Local	`http://app.localhost:3000`

You can also pass a custom URL:

tgd login --base-url https://custom.tagadapay.com

Workflow Examples

Deploy & Mount

Build your plugin

npm run build

Deploy

tgd deploy --store store_abc123

Note the deployment ID from the output.

Install (create instance)

tgd install --store store_abc123

Select the deployment, optionally configure it.

Mount to alias

tgd mount-alias --store store_abc123

Select the instance and choose an alias path.

Update a Plugin

# Bump version in plugin.manifest.json
npm run build
tgd deploy --store store_abc123

# Or overwrite same version
tgd deploy --store store_abc123 --overwrite

A/B Testing

Deploy two variants and mount them via the A/B testing API:

tgd deploy --config config/variant-a.json --store store_abc123
# Note: deployment ID A

tgd deploy --config config/variant-b.json --store store_abc123
# Note: deployment ID B

Then configure split testing via the API or CRM.

Custom Domain

tgd add-domain checkout.mystore.com
# CLI will show CNAME record to add

tgd verify-domain cdm_abc123
# After DNS propagation

Troubleshooting

Authentication failed

tgd logout
tgd login
tgd whoami

Plugin manifest not found

Ensure plugin.manifest.json exists in your current directory and is valid JSON:

cat plugin.manifest.json | python3 -m json.tool

Build directory missing

Build your plugin before deploying:

npm run build
ls dist/

Version conflict on deploy

A deployment already exists for this plugin ID + version. Either:

Bump the version in your manifest
Use --overwrite to replace the existing deployment

Domain verification failed

DNS can take up to 48 hours to propagate. Check status:

tgd domain-info checkout.mystore.com
tgd verify-domain cdm_abc123

Verbose Mode

For detailed API request/response logs:

tgd --verbose deploy

Support

Documentation: docs.tagadapay.com
Support: developer-support@tagadapay.com
GitHub: Report issues

Overview

Web Integration

Tracking & Attribution

Node SDK

Funnels

Shopify

SaaS Billing

Headless SDK

Plugin SDK

Plugin CLI

Studio MCP (AI Agents)

CRM MCP (AI Agents)

Hosting & A/B Testing

Internal

Plugin CLI

TagadaPay Plugin CLI

Latest Version

Quick Start

Interactive Mode

Commands

Authentication

Deploy

Archive

List

Instance Management

Domain Management

Plugin Manifest

Required Fields

All Manifest Fields

Page Features

Environments

Workflow Examples

Deploy & Mount

Update a Plugin

A/B Testing

Custom Domain

Troubleshooting

Verbose Mode

Support

​TagadaPay Plugin CLI

Latest Version

​Quick Start

​Interactive Mode

​Commands

​Authentication

​Deploy

​Archive

​List

​Instance Management

​Domain Management

​Plugin Manifest

​Required Fields

​All Manifest Fields

​Page Features

​Environments

​Workflow Examples

​Deploy & Mount

​Update a Plugin

​A/B Testing

​Custom Domain

​Troubleshooting

​Verbose Mode

​Support

TagadaPay Plugin CLI

Quick Start

Interactive Mode

Commands

Authentication

Deploy

Archive

List

Instance Management

Domain Management

Plugin Manifest

Required Fields

All Manifest Fields

Page Features

Environments

Workflow Examples

Deploy & Mount

Update a Plugin

A/B Testing

Custom Domain

Troubleshooting

Verbose Mode

Support