Theme
On this page

Getting started

There are two practical starting points. Choose according to whether you need the most mature production-used workflow or want to evaluate the official JavaScript rewrite.

Path A: supported OpenAPI and Jinja workflow

Use this path when you need a mature generator that has already been used in real projects.

1. Install the packages

2. Author and emit OpenAPI

Create a TypeScript contract using codepot-openapi, then generate JSON or YAML:

The output is a standard OpenAPI document. Optional x-codegen metadata carries additional information about resources, entities, access, hooks, frontends, and operation roles.

3. Configure CodepotG

Create Codepotg.yaml in the consuming project:

4. Preview and generate

Read the full prototype workflow guide for custom Jinja packs, lifecycle policy, and safe cleanup.

Path B: official codepotx rewrite

Use this path when contributing to or evaluating the frontend-neutral JavaScript runtime being prepared as the official stable release.

The packages are currently developed in this workspace:

A consumer combines:

The CLI frontend exposes the codepotx command:

Read the codepotx workflow guide for the complete model.

Exploring the final platform

The Rust project is developed in the separate codepot_lang repository. From a local clone:

The final CLI command is:

Read Codepot Lang, codepot CLI, Codepot LSP, and Language extension before treating experimental features as release commitments.

Next steps