kiln

Warning

kiln is in pre-alpha. APIs may change between releases.

kiln is a CLI for autogenerating files from templates. The CLI is the generic codegen code-generation engine; kiln-generator ships four targets that plug into it:

be

FastAPI / SQLAlchemy backend code generator. Produces routes, schemas, serializers, and tests from a Jsonnet config that points at your SQLAlchemy models.

be_root

One-shot bootstrap for a be-driven project. Emits main.py, pyproject.toml, justfile, and the starter config/project.jsonnet.

fe

React / TypeScript frontend code generator. A thin wrapper over @hey-api/openapi-ts that translates a kiln-side jsonnet config into openapi-ts.config.ts so the generated TypeScript client / React-Query hooks stay in lockstep with the same source of truth as the rest of the project.

fe_root

One-shot bootstrap for a fe-driven project. Emits package.json, justfile, tsconfig.json, vite.config.ts, and a src/ skeleton wired to @fsh/components-library.

Run any target with:

codegen generate --target <name> --config <path> --out <dir>

Getting started

• Getting started
  • What be generates – and doesn’t
  • Prerequisites
  • Install
  • Fast path: bootstrap with be_root
  • Project layout
  • Step 1 – Define your SQLAlchemy models
  • Step 2 – Write a config
  • Step 3 – Generate
  • Step 4 – Mount the router
  • Step 5 – Environment and database
  • Step 6 – Run the server
  • Adding authentication
  • Multi-app projects
  • Where to next
• Playground
  • Structure
  • Quick start
  • justfile recipes
  • Project config
  • Apps
  • EventLog and PGCraftAppendOnly
• Usage
  • Install
  • The CLI
  • Config format
  • Operations
  • Nested (related-model) fields
  • Built-in operations
  • Multi-app projects
  • Jsonnet stdlib
  • File uploads
  • Filtering, search, and saved views
  • Testing the generated code
  • API versioning
  • Other targets
  • Extending be

Guides

• Architecture
  • The build pipeline
  • Scopes
  • Operations
  • Typed output objects
  • Renderers
  • Assembler
  • Discovery via entry points
  • Source layout
• Extending kiln
  • Adding an operation
  • Cross-cutting operations with when()
  • Augmenting vs producing
  • Mutating output objects
  • Swapping a renderer
  • Adding a new output type
  • Shipping a new target
  • Operation validation
  • Testing your extension
• OpenTelemetry
  • Enabling
  • Deployment environment
  • What you get
  • Sampler defaults
  • Exporter
  • Per-resource and per-op opt-out
  • PII and the auth router
  • Logging
  • Emitting your own signals
  • Pinned versions
• Background tasks (pgqueuer)
  • Prerequisites
  • Schema setup
  • Defining tasks
  • Worker factory
  • Running the worker
  • Enqueueing from a request
  • Testing
  • Common pitfalls
• Communication platform
  • What you get
  • Enabling
  • Models
  • Comm types
  • Templates: inline or file
  • Transports
  • Renderer
  • Preferences
  • Sending
  • Worker
  • Lifecycle in one diagram
  • Pitfalls

Reference

• Reference
  • Config schema
  • Built-in operations
  • Generated file layout
  • codegen API
  • Stdlib reference
• API reference
  • codegen CLI
  • be target
  • be_root target
  • fe target
  • fe_root target
  • codegen.config
  • codegen.jsonnet
  • codegen.pipeline
  • codegen.assembler
  • codegen.banner
  • be.operations

Contributing

• Development
• Changelog