Getting started with codepotx-cli

The CLI currently ships from the Codepot workspace while the package is prepared for release. It expects a compatible project-local codepotx runtime and a project configured with codepotx.config.ts and CodepotFile.yml.

Build the workspace packages

From the repository root:

For development, run the workspace command through the package scripts or link the CLI into a test project according to the repository workflow.

Prepare a project

A typical project contains:

The task file must explicitly allow generation:

Validate before generation

Validation loads the project configuration through the runtime and reports authoring, template, task, source, and compatibility diagnostics.

Inspect the project

Use inspection to understand the resolved project and runtime inputs without applying generation.

Inspect template variables

This command asks the runtime for the task's template-variable catalog. It is useful before writing templates or diagnosing missing values.

Plan and dry run

The plan exposes intended outputs, lifecycle modes, dependencies, commands, cleanup, refusals, and diagnostics. A dry run renders without writes or commands.

Generate

Review the resulting created, updated, unchanged, immutable, skipped, refused, and cleaned files. Treat warnings and refusals as structured outcomes rather than relying only on process text.

Use explicit project paths

When running outside the project root:

Next steps

• Commands
• Options
• Runtime resolution