On this page
Getting started
codepotx is currently consumed from the repository workspace.
Requirements
- Node.js 22.18 or newer
- Corepack and pnpm
From the repository root:
Run the complete package check:
Author a contract
Create codepotx.config.ts:
Add a template pack
A pack contains paths.yaml, Handlebars templates, and optional partials or raw files.
Add CodepotFile.yml
The exact source shape is validated by the active package contracts. Keep project files aligned with the workspace version being evaluated.
Use the runtime
Use runtime operations instead of calling internal compiler or filesystem implementations directly.
Use the CLI
The companion codepotx-cli package exposes the codepotx binary from the workspace.
Release-status guidance
- Do not add a public npm install command until the package is actually released.
- Pin the workspace commit when evaluating it in another repository.
- Expect public artifacts and entrypoints to be the compatibility boundary.
- Read migration notes before moving a production project away from
codepot-openapiandcodepotg.