Skip to content

armgit / kiln

Public Imported from GitHub
0

Build and revise procedural 3D assets with your coding agent. Local MCP server, CLI and TypeScript engine with rendered review, editable source and GLB export.

Point the install guide, README and site at the v0.10.0 download (#130)

Matthew Kissingera396612e475f
diff --git a/README.md b/README.md
index b59c2e34..27c22158 100644
--- a/README.md
+++ b/README.md
@@ -66,18 +66,21 @@ builds on 0.9.0's optional projects, material library, Live Review and calibrate
each breaking one marked, and the [migration notes](docs/migration.md#changes-in-0100)
list what an existing author will notice.
-**0.10.0 is the source and site preview for dogfooding.** Package publication is
-deferred to v1.0 after feedback. Build a local tarball from this checkout to try
-the current engine; the site deployment does not publish a package to npm.
+**0.10.0 is the source and site release for dogfooding.** Its package tarball is attached
+to the [v0.10.0 release](https://github.com/matthew-kissinger/kiln/releases/tag/v0.10.0)
+with `SHA256SUMS.txt` and the installed-package receipts, as later releases' tarballs are
+on the [releases page](https://github.com/matthew-kissinger/kiln/releases); registry
+publication is deferred to v1.0 after feedback, and the site deployment publishes no
+package.
## Install and start an asset workspace
Use Node.js **20.15.0+ on the 20.x line**, or **22.2.0 and later**, with npm.
-For this candidate, [build a local package](docs/install.md#install-a-local-package)
-from the exact checkout, including its runtime build. If using a published release,
-use only a tarball actually attached to that release and its matching documentation;
-the release page does not imply that this candidate is available. Bun and a separate
-model API key are not required to install an already-built tarball:
+Download the tarball and `SHA256SUMS.txt` from the release and check the tarball
+against the checksum file before installing. Use only a tarball actually attached to
+a release, with that release's documentation; a checkout ahead of the release
+[builds its own package](docs/install.md#install-a-local-package). Bun and a separate
+model API key are not required to install the tarball:
```sh
mkdir kiln-install
diff --git a/docs/install.md b/docs/install.md
index 95042c3d..db6de880 100644
--- a/docs/install.md
+++ b/docs/install.md
@@ -4,17 +4,23 @@ This guide installs Kiln **0.10.0**: standalone authoring with optional projects
material library and Live Review in the local dashboard, served to a coding agent over
the 2026-07-28 and 2025 protocol revisions. [CHANGELOG.md](../CHANGELOG.md)
lists what changed. Existing users should read the [migration notes](migration.md)
-before upgrading a workspace. **0.10.0 is a source and site preview for dogfooding.** Build this checkout
-to evaluate the current engine. Package publication is deferred to v1.0.
+before upgrading a workspace. **0.10.0 is a source and site preview for dogfooding**, with its
+package tarball attached to the
+[v0.10.0 release](https://github.com/matthew-kissinger/kiln/releases/tag/v0.10.0).
+Package publication is deferred to v1.0.
## Install the package
-Kiln can be packaged as a tarball, `kiln-engine-VERSION.tgz`, and installed with
-Node.js and npm. For the current candidate, use
-[Install a local package](#install-a-local-package). For a published package, use
-the tarball and checksum actually attached to its
-[release](https://github.com/matthew-kissinger/kiln/releases); a source-only release
-does not imply that a built tarball is available.
+Kiln is distributed as a tarball, `kiln-engine-VERSION.tgz`, installed with Node.js and
+npm. Use the tarball and checksum actually attached to the current
+[release](https://github.com/matthew-kissinger/kiln/releases) (for 0.10.0, the
+[v0.10.0 release](https://github.com/matthew-kissinger/kiln/releases/tag/v0.10.0)): download
+the tarball and `SHA256SUMS.txt`, check the tarball against the checksum file before
+installing (`sha256sum -c SHA256SUMS.txt` beside it, or `Get-FileHash` on Windows), and read
+that release's documentation; the release also attaches the installed-package receipts that
+name the tarball. A source-only release does not imply that a built tarball is available;
+a source-only release, like a checkout ahead of the release, builds its own package under
+[Install a local package](#install-a-local-package).
The package includes the built CLI/MCP runtimes, renderer code, plugins and skills.
You do not need Bun, a source checkout, a build step or a separate model API key to
use the CLI/MCP tools. Use the real tarball path and filename:
diff --git a/docs/plans/2026-10-01-v1-readiness-cycle.md b/docs/plans/2026-10-01-v1-readiness-cycle.md
index d8031f85..a940dbea 100644
--- a/docs/plans/2026-10-01-v1-readiness-cycle.md
+++ b/docs/plans/2026-10-01-v1-readiness-cycle.md
@@ -127,8 +127,9 @@ below; where one changes an earlier decision it says so.
| 36 | Private sync | The evidence folder `kiln-dogfood/v1-readiness-2026-10` becomes a private GitHub repository, `matthew-kissinger/kiln-dogfood-v1-readiness-2026-10`, curated: runtime and fresh clones, rig folders, Agy homes, OpenCode state, `node_modules` and temp excluded, scanned for secrets before the push; the laptop clones it to the same path as here. |
| 37 | Pack home | The Troy pack enters the public repository under `packs/troy/` (sources, material and project records, manifests, an inventory and a `HANDOFF.md` marked in progress and unreviewed by the owner, with the brief for the real battle scene); every revision's GLB and preview go to the public R2 bucket `kiln-assets` under `troy/`, with the whole review workspace as one zip; nothing enters the site or its gallery now (the gallery renders standalone examples and cannot take project-pinned materials without site work). Not `scenes/packages/`: that is a bun workspace with a frozen lockfile; the hub agent moves the pack there when it becomes a scene. |
| 38 | Laptop paths and the scene | The laptop mirrors this PC's paths under user `Mattm`: `C:\Users\Mattm\X\kiln-oss` for the repository and `C:\Users\Mattm\X\kiln-dogfood\v1-readiness-2026-10` for the private clone, so the evidence tools' hard-coded root holds. The composed `battle-scene` is a reference, not the target: the owner wants a real scene in the manner of Farm and Golden Gate (the wall in a landscape, the buildings inside it, soldiers on the field, archers on the walk, Achilles and Hector about to fight), composed later by the hub agent, not in this cycle; the owner expects to revise several assets first. |
+| 39 | Merge method and release (13:12) | GitHub refused decision 35's merge commit: `main` requires linear history, enforced for admins. The owner chose the squash merge the repository has always used: PR #129 is `9375d04` on `main`, its body the branch's commit messages; the hashes the report cites stay on the PR and in the worktree, and the repository's setting deleted the remote branch. The release waits for `main`'s CI, then is packed but not published: the annotated tag `v0.10.0` on `9375d04` and a GitHub release attaching the engine CI's tarball, the installed-package receipts and `SHA256SUMS.txt`, with the docs and the site pointing at that download. |
-Decision 33 came as a message; the others as question-tool answers.
+Decision 33 and the release shape of 39 came as messages; the others as question-tool answers.
### Follow-up goal statement
@@ -565,6 +566,8 @@ Stamp each entry from the clock, not from an estimate.
| 2026-10-02 12:21 -04:00 | Branch tip `30c0bdb` (pack `5cd775a`, records `30c0bdb`) differs from the fresh-cloned `5a803eb` only under `packs/` and `docs/` (`git diff --name-only`: nothing else); the fast gate steps on the tip at 12:21: check:toolchain exit 0 (0 s), check:skills exit 0 (0 s), typecheck exit 0 (2 s), lint exit 0 (1 s). Pushing `v1-readiness` to origin and opening the PR against `main` with the report linked and no footer (decision 19 and the follow-up goal's item 5); the merge follows by a merge commit once the PR's checks pass (decision 35), nothing deleted. |
| 2026-10-02 12:36 -04:00 | The Website workflow (not a required check) failed on `site/scripts/social-cards.test.ts`, which wrote "0.9" into the home share card's expected note; the test now derives it from `release.json` (3 pass). PR #129 was `BEHIND` under strict protection: `origin/main` (`c734e2a`, three site and scene commits, no overlapping file) merged into the branch with a merge commit, pushed; the owner asked for the merge before the hub configuration and will pass further scene and asset optimization documentation. |
| 2026-10-02 12:48 -04:00 | The required check `typecheck · lint · test (Windows)` failed on the Agy bootstrap test: the assertion added with the lean default (`5db5c5d`) compared `KILN_WORKSPACE` with the test's temp path by string, and the GitHub runner's `tmpdir()` is the 8.3 alias `RUNNER~1` while the setup writes the real path. Reproduced locally with `TEMP` pointed at an 8.3 alias (fail), fixed through the file's `expectSameDirectory` (pass; 15 pass for the file; typecheck and lint exit 0), pushed. |
+| 2026-10-02 13:21 -04:00 | Both CI fixes green (13 checks on `a959f1c`). `main` requires linear history, so decision 35's merge commit was refused by GitHub; the owner chose a squash merge (decision 39). PR #129 merged as `9375d04` (tree identical to `a959f1c`); the repository auto-deleted the remote branch; the hub's `~/X/kiln` is on that `main`. The draw-optimization branch (24 local commits, other agent) was checked against the squash: no overlapping file, a clean trial merge, its wiring patches still apply. |
+| 2026-10-02 13:21 -04:00 | After main's CI passed on `9375d04`: annotated tag `v0.10.0` and the GitHub release "Kiln 0.10.0" (Latest) with the engine CI's `npm pack --ignore-scripts` artifact `kiln-engine-0.10.0.tgz` (sha256 `e1ce85d7a27106cc2706bb23d2707e3904e214cf4afda329da5dbfceabf60c9f`, byte-identical to a local pack of the same tree), the six installed-package receipts (Linux Node 20.15.0, 22.2.0 and 24.20.0; macOS arm64 and x64; Windows) and `SHA256SUMS.txt`, verified by public read-back; nothing on npm (the owner: pack, do not publish). The install guide, README and the site's install copy now point at the download with the checksum step. |
### Four-harness table on 0.9.0, live baseline sessions of 1 October 2026
diff --git a/docs/reviews/2026-10-01-v1-readiness-live-sessions.md b/docs/reviews/2026-10-01-v1-readiness-live-sessions.md
index 8f8321d1..394726dd 100644
--- a/docs/reviews/2026-10-01-v1-readiness-live-sessions.md
+++ b/docs/reviews/2026-10-01-v1-readiness-live-sessions.md
@@ -519,3 +519,18 @@ mirroring this PC's paths under user `Mattm`, and the real battle scene left to
composed `battle-scene` being a reference only (38). What landed under them is recorded in the
plan's log and in `packs/troy/HANDOFF.md`; the private repository's `README.md` says what it
holds and what stays out.
+
+Decision 39 (13:12): `main` requires linear history, so GitHub refused the merge commit of
+decision 35, and the owner chose the squash merge the repository has always used. PR #129 is
+`9375d04` on `main`, after two checks were fixed on the branch: the Website workflow's
+`social-cards.test.ts`, which wrote "0.9" into its expectation (`7c13a96`), and the Agy bootstrap
+assertion that compared an 8.3 temp path (`RUNNER~1`) by string on the Windows runner
+(`a959f1c`); the hashes cited above remain on the PR. After `main`'s CI passed, the owner asked
+for the release, packed but not published to npm: `v0.10.0` is the annotated tag on `9375d04`,
+and the GitHub release attaches the engine CI's `kiln-engine-0.10.0.tgz` (sha256 `e1ce85d7…`,
+identical to a local `npm pack --ignore-scripts` of the same tree), six installed-package
+receipts (Linux with Node 20.15.0, 22.2.0 and 24.20.0; macOS arm64 and x64; Windows) and
+`SHA256SUMS.txt`, verified by public read-back. The install guide, the README and the site's
+install copy point at that download; the site deployment is a separate step. The laptop turned
+out to be Linux (decision 38 assumed Windows paths): the engine checkout there is `~/X/kiln` and
+the private repository `~/X/kiln-dogfood/v1-readiness-2026-10`.
diff --git a/packs/troy/HANDOFF.md b/packs/troy/HANDOFF.md
index 1a0ddec8..6bb4907f 100644
--- a/packs/troy/HANDOFF.md
+++ b/packs/troy/HANDOFF.md
@@ -11,7 +11,7 @@ on the site.
| --- | --- |
| The pick records (source, manifest), materials, project, inventory | this folder (`README.md` has the table) |
| Every saved revision's GLB and preview, the material maps | public R2 bucket `kiln-assets`: `https://assets.kilnstudio.tools/troy/assets/<assetId>/<revisionId>/asset.glb` and `preview.png`; `troy/materials/<id>/<revision>/`; `r2-manifest.json` here lists each object's sha256 |
-| The live Kiln workspace of the pack (project `troy`, pinned materials, every revision, retained programs) | the private repository `matthew-kissinger/kiln-dogfood-v1-readiness-2026-10`, cloned to `C:\Users\Mattm\X\kiln-dogfood\v1-readiness-2026-10`: `review/troy-refine/ws`; the same workspace without its build cache as `troy/workspace/troy-refine-ws-2026-10-02.zip` on R2 (sha256 `69b4fb6b35a3a08db2ac0b67b501271cdbceefb64749fe0aef9a2165ac4f75d0`) |
+| The live Kiln workspace of the pack (project `troy`, pinned materials, every revision, retained programs) | the private repository `matthew-kissinger/kiln-dogfood-v1-readiness-2026-10`, cloned to `C:\Users\Mattm\X\kiln-dogfood\v1-readiness-2026-10` on the owner's PC and to `~/X/kiln-dogfood/v1-readiness-2026-10` on the hub (Linux, user `matthewk`; its engine checkout is `~/X/kiln`): `review/troy-refine/ws`; the same workspace without its build cache as `troy/workspace/troy-refine-ws-2026-10-02.zip` on R2 (sha256 `69b4fb6b35a3a08db2ac0b67b501271cdbceefb64749fe0aef9a2165ac4f75d0`) |
| The material-pass sources, render sheets and the scene recomposer | `review/troy-refine/{sources,out,scene}` in the private repository |
| Picks, alternates and what changed per asset | `picks.md` in the private repository; `findings.md` has one row per session |
| The report | `docs/reviews/2026-10-01-v1-readiness-live-sessions.md` (section 7 candidates, section 9 the owner's decisions, section 11 the follow-ups and the material pass) |
diff --git a/site/src/lib/config.ts b/site/src/lib/config.ts
index fa0dd146..1052a418 100644
--- a/site/src/lib/config.ts
+++ b/site/src/lib/config.ts
@@ -6,8 +6,10 @@ export const SITE = 'https://kilnstudio.tools';
export const REPO = 'https://github.com/matthew-kissinger/kiln';
export const ASSET_BASE = 'https://assets.kilnstudio.tools';
export const PACKS_ENABLED = !['0', 'false'].includes(import.meta.env.KILN_SITE_PACKS ?? '1');
-/** 0.9 is a preview. Build its tarball from reviewed source; registry publication is planned for 1.0. */
+/** The release attaches its tarball and SHA256SUMS.txt (0.10.0 onward); registry publication is planned for 1.0. */
export const PACKAGE_TARBALL = `kiln-engine-${VERSION}.tgz`;
+export const RELEASE_URL = `${REPO}/releases/tag/${RELEASE_TAG}`;
+export const PACKAGE_DOWNLOAD_URL = `${REPO}/releases/download/${RELEASE_TAG}/${PACKAGE_TARBALL}`;
export const INSTALL_COMMAND = `npm install /absolute/path/to/${PACKAGE_TARBALL} --omit=dev --include=optional`;
export const WORKSPACE_COMMAND = 'npm exec --offline -- kiln-init ../my-assets --harness opencode';
export const HARNESSES = [
diff --git a/site/src/pages/docs/[slug].astro b/site/src/pages/docs/[slug].astro
index 8ec06ed8..9db12d8a 100644
--- a/site/src/pages/docs/[slug].astro
+++ b/site/src/pages/docs/[slug].astro
@@ -11,6 +11,7 @@ import {
PACKAGE_TARBALL,
WORKSPACE_COMMAND,
RELEASE_TAG,
+ RELEASE_URL,
VERSION,
VERSION_SHORT,
} from "../../lib/config";
@@ -42,15 +43,17 @@ const { Content, headings } = await render(entry);
<DocsMobileNav slot="navigation" current={entry.id} headings={headings} />
</PageHeader>
{entry.id === "install" && (
- <Callout label={`${VERSION_SHORT} candidate status`} boundary>
+ <Callout label={`${VERSION_SHORT} release status`} boundary>
<h2 class="text-xl font-semibold">
- Install the local {VERSION_SHORT} package
+ Install the {VERSION_SHORT} package
</h2>
<p>
- The <code>{RELEASE_TAG}</code> candidate is under local review. Build
- <code>{PACKAGE_TARBALL}</code> from the reviewed source as described below,
- then install that local tarball. Kiln
- is not published to the npm registry; publication is planned for v1.0 after deployed dogfooding.
+ <code>{PACKAGE_TARBALL}</code> is attached to the{" "}
+ <a href={RELEASE_URL} class="text-link">{RELEASE_TAG} release</a> with{" "}
+ <code>SHA256SUMS.txt</code> and the installed-package receipts. Download the
+ tarball and the checksum file, check the tarball against it, then install it
+ from its real path. Kiln is not published to the npm registry; publication is
+ planned for v1.0 after feedback.
</p>
<CodeBlock
code={`mkdir kiln-install\ncd kiln-install\nnpm init -y\n${INSTALL_COMMAND}`}
diff --git a/site/src/pages/index.astro b/site/src/pages/index.astro
index 0d162dd3..60ffc9d6 100644
--- a/site/src/pages/index.astro
+++ b/site/src/pages/index.astro
@@ -18,6 +18,8 @@ import {
PACKAGE_TARBALL,
WORKSPACE_COMMAND,
PACKS_ENABLED,
+ RELEASE_TAG,
+ RELEASE_URL,
REPO,
VERSION,
VERSION_SHORT,
@@ -492,17 +494,17 @@ const CARD_SIZES = "(max-width: 767px) 100vw, 33vw";
<section class="container" aria-labelledby="start-heading">
<div class="grid gap-8 border-t border-ink pt-8 lg:grid-cols-12 lg:gap-12">
<div class="lg:col-span-4">
- <h2 id="start-heading" class="text-subheading">Try Kiln 0.9 locally.</h2>
+ <h2 id="start-heading" class="text-subheading">Try Kiln {VERSION_SHORT} locally.</h2>
<p class="mt-5 max-w-reading">
Use Node.js 20.15+ on the 20.x line, or 22.2 and later. Kiln is not
- published to the npm registry. Build the package tarball locally
- from the reviewed source, then install <code>{PACKAGE_TARBALL}</code>
- from that build. The installation guide includes the build commands.
+ published to the npm registry: download <code>{PACKAGE_TARBALL}</code>{" "}
+ and <code>SHA256SUMS.txt</code> from the{" "}
+ <a href={RELEASE_URL} class="text-link">{RELEASE_TAG} release</a>, check
+ the tarball against the checksum file, then install it with npm.
</p>
<p class="mt-4 max-w-reading text-dim">
- The v{VERSION} preview is available for dogfooding. Package publication
- is planned for v1.0 after deployed dogfooding and feedback. Give npm
- your locally built tarball’s real path.
+ The {VERSION} release is for dogfooding. Package publication is planned
+ for v1.0 after feedback. Give npm the downloaded tarball’s real path.
</p>
<a href="/docs/install/" class="text-link mt-3">
Read the installation guide <span aria-hidden="true">→</span>