Skip to content

ptkl template

Search, install, and manage project templates and marketplace activation codes.

Overview

ptkl template wraps the platform's template & marketplace surface: searching the template catalog, listing templates available to your project, and installing/upgrading/uninstalling a template into a workspace. A separate activation-code subtree looks up and lists activation codes redeemed against your account (account/app/integration/template benefits).

Every subcommand supports the standard output flags (-f/--format, -o/--output, --template) plus the --env <dev|live> option.

Subcommands

Subcommand Description
search Search available templates
available List templates available to the current project
install Install a template into a workspace
upgrade Upgrade an installed template
uninstall Uninstall a template from a workspace
activation-code redeem <code> Redeem an activation code for the current user and project
activation-code list List activation codes redeemed by the current user

Search the template catalog.

ptkl template search [options]

Options

Option Description
-q, --query <json> Search query, as a JSON object string (default: {})

Example

ptkl template search --query '{"category":"ecommerce"}'

ptkl template available

List templates available to the current project.

ptkl template available [options]

Example

ptkl template available --format table

ptkl template install

Install a template into a workspace.

ptkl template install [options]

Options

Option Description
-t, --template-id <uuid> Template UUID (required)
-w, --workspace-uuid <uuid> Workspace UUID (required)
-d, --data <json> Additional install options, as a JSON object string

Example

ptkl template install \
  --template-id <template-uuid> \
  --workspace-uuid <workspace-uuid>

ptkl template upgrade

Upgrade an already-installed template.

ptkl template upgrade [options]

Options

Option Description
-t, --template-id <uuid> Template UUID (required)
-w, --workspace-uuid <uuid> Workspace UUID (required)
-d, --data <json> Additional upgrade options, as a JSON object string

Example

ptkl template upgrade \
  --template-id <template-uuid> \
  --workspace-uuid <workspace-uuid>

ptkl template uninstall

Uninstall a template from a workspace.

ptkl template uninstall [options]

Options

Option Description
-t, --template-id <uuid> Template UUID (required)
-w, --workspace-uuid <uuid> Workspace UUID (required)
-d, --data <json> Additional uninstall options, as a JSON object string

Example

ptkl template uninstall \
  --template-id <template-uuid> \
  --workspace-uuid <workspace-uuid>

ptkl template activation-code

Redeem and list activation codes. Activation codes cover several benefit types (account/app/integration/template) redeemed through the same endpoint — this is distinct from ptkl template install, which installs a specific template you already have access to.

ptkl template activation-code redeem

Redeem an activation code for the current user and project.

ptkl template activation-code redeem <code>

ptkl template activation-code redeem ACME-2026-PROMO

ptkl template activation-code list

List activation codes redeemed by the current user.

ptkl template activation-code list [options]

ptkl template activation-code list --format json

Note

activation-code redeem/list are a different subsystem than search/available/ install/upgrade/uninstall above: they redeem/list account-level activation codes, not template install operations. See the platform documentation on marketplace codes for details.

See Also