Python packageSupported stable generatorAvailable now

Infer a normalized generation model from OpenAPI and apply bundled or project-owned Jinja template packs.

GitHub PyPI All links

python -m pip install codepotg

On this page

`Codepotg.yaml` configuration

CodepotG discovers one of these files in the current working directory:

If both exist, the command fails and asks for one explicit config. An explicit path can be passed with --config.

Root shape

`allow`

allow must be exactly true before generation can mutate the project or run commands.

Missing, false, or non-boolean values do not grant permission.

`defaults`

defaults is an optional object merged into every task before task-specific values are validated.

Task fields override defaults at the top level. Nested objects are not deep-merged unless their owning field explicitly implements that behavior.

`tasks`

tasks must be a non-empty mapping. The mapping key is the task name.

Required task fields

Field	Type	Meaning
`input`	path string	OpenAPI JSON or YAML source
`language`	string	Bundled or registered language adapter
`output`	path string	Task output root

Relative paths resolve from the configuration directory.

Optional task fields

Field	Type	Meaning
`templateDir`	path string	Project-owned template pack
`templates`	path string	Compatibility alias for `templateDir`
`clean`	path list	Paths eligible for explicit refresh cleanup
`before`	command list	Commands before rendering/writes
`after`	command list	Commands after successful generation
`env`	string map	Environment values for task and commands
`description`	string	Human-readable task purpose
`frontend`	string	Selected authored frontend, or `*` where supported

Commands

A command can be a string:

or an object:

Command fields:

Field	Meaning
`name`	Optional display name
`run`	Required shell command
`cwd`	Optional working directory relative to config
`optional`	Continue when this command fails
`env`	Command-specific environment values

Review commands as executable project code. Dry runs and --skip-before/--skip-after prevent their execution.

Frontend selection

The name must refer to explicitly authored frontend metadata in the normalized contract.

Use * only when the task intentionally exposes all authored frontends.

Multiple tasks

Run one task by name or all tasks in file order.

Legacy filename rejection

CodepotFile.yml and CodepotFile.yaml are reserved for the TypeScript runtime. CodepotG reports a clear configuration error rather than guessing which engine should run the file.

Codepotg.yaml configuration