Getting Started
Kumiki is a Python timber-framing library used through the Kigumi VS Code extension. Follow the steps below to go from zero to your first 3D timber frame.
Install VS Code
Download and install Visual Studio Code for your platform. Any recent version works.
Install the Kigumi VS Code extension
Install the Kigumi extension from the VS Code Marketplace.
- Using Cursor? Kigumi is also available on OpenVSX.
- Prefer a manual install? Grab the
.vsixfile from the releases page.
Create and open a workspace folder
Create a new folder anywhere on your machine, then in VS Code choose File › Open Folder and open it. This folder becomes your Kigumi project workspace.
Open the Kigumi sidebar
Find the Kigumi sidebar — it's the Kumiki icon in the VS Code activity bar. A few ways to get there:
- Click the Kigumi icon in the vertical column on the left side of VS Code.
- It may be tucked inside a dropdown at the top of the left panel.
- Open the command palette (Cmd/Ctrl + Shift + P) and choose View: Show Kigumi.
Initialize your project
In the Kigumi sidebar, click the Initialize Project button and wait a few seconds. This installs Kumiki and creates the necessary project files in your workspace.
Explore frames and patterns
Once initialized, the Kigumi sidebar shows two kinds of items:
- Frames — your own design files (
.pyscripts). - Patterns — bundled joint examples you can browse, open, and duplicate into your workspace.
Open your first frame
Click my_cute_frame in the sidebar to open it in the Kigumi viewer.
Edit my_cute_frame.py and click the refresh button in the viewer to see your changes live.
Add new frames
Any new .py frame file you create will appear in the Frames section of the
Kigumi sidebar. If it doesn't show up immediately, click the sidebar's refresh button.
Using AI to design frames
Kumiki frames are written in Python, which means AI coding agents can write them for you.
- We recommend using Claude, Antigravity, or Codex for designing frames.
- Copilot and Cursor are not recommended, though the free Copilot credits may be enough to make a simple design.
Try asking your agent something like:
"Make me a cute saw horse. It has 2 horizontal feet on a 1'×2' footprint, with two vertical legs on top of the feet, and a horizontal beam resting on top of the 2 legs. There should also be a stretcher connecting the 2 legs in the middle. Join everything with mortise and tenon joinery with square pegs please!"