Skip to content

Kumiki

Kumiki is a programmatic CAD library for designing timber-framed structures and woodworking joinery in Python. It's used together with kigumi, a VS Code extension for viewing and iterating on your kumiki designs.

For the full kigumi + VS Code setup, see Getting Started.

Where to go next

  • Concepts — coordinate system, timber/board terminology, and Kumiki's overall design philosophy. Start here if you're authoring designs by hand.
  • Pattern Book — the Pattern system that powers the kigumi sidebar's built-in joint examples, and how to add your own.
  • API Reference — every public class and function, generated straight from the library's docstrings. Everything here is also reachable directly as kumiki.<name> after from kumiki import * or import kumiki.

For AI Agents & LLMs

Kumiki is purpose-built for agentic AI coding. Agents designing timber structures should consult:

  • llms.txt — fast project summary and agent quickstart conventions.
  • llms-full.txt — complete consolidated documentation, prompt guidelines, and joint catalog in a single file.