Theme
CLI frontendOfficial runtime frontendActive development

Expose codepotx runtime operations through the codepotx command without duplicating engine logic.

codepotx
On this page

Command reference

validate

Loads the project through the runtime and validates configuration, authoring, template packs, tasks, sources, variables, and compatibility boundaries. It does not generate files.

Use --json for machine-readable diagnostics.

inspect

Returns an inspectable view of the resolved Codepot project. The runtime owns the exact response shape; the CLI only formats it.

variables

Returns the template-variable catalog available to the selected task. Use it to document a pack, power editor suggestions, or diagnose missing variables.

A positional task name is accepted where a command requires one.

plan

Produces a deterministic generation plan without writing files. The plan describes outputs, lifecycle modes, dependencies, commands, cleanup actions, refusals, and diagnostics.

generate

Executes one task or all tasks through the runtime.

Useful controls:

--dry-run renders without writes, cleanup, or commands.

features

Reports runtime and package feature information suitable for compatibility checks and user interfaces.

help

Displays command usage. Help output is presentation owned by the CLI; domain documentation remains in the package docs and runtime contracts.

version

Reports CLI version information. Project operations may still use the compatible project-local runtime version selected by the consumer project.

Exit behavior

The CLI converts typed runtime results into process exit codes. Validation failures, unresolved project configuration, invalid arguments, and failed required generation steps produce non-zero exits. Informational warnings should remain distinguishable from failures in JSON output.