From 5ceaf6bd525fccdfc02ed8598ca097d58a509d50 Mon Sep 17 00:00:00 2001 From: iamtoruk Date: Thu, 16 Jul 2026 07:21:22 -0700 Subject: [PATCH] docs(app): DISTRIBUTION.md states the codeburn CLI prerequisite A packaged DMG on a machine without the CLI opens into the 'CLI not found' state; the distribution doc now says so up front, with the install command and the future bundle-the-CLI path. --- app/DISTRIBUTION.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/app/DISTRIBUTION.md b/app/DISTRIBUTION.md index 5d2d4de..71a9053 100644 --- a/app/DISTRIBUTION.md +++ b/app/DISTRIBUTION.md @@ -5,6 +5,22 @@ Electron desktop app **without a paid Apple Developer account**. There is no CI automation for this yet (unlike the CLI and menubar release processes in `../RELEASING.md`) — packaging is run by hand on a maintainer's machine. +## Prerequisite on the target machine: the codeburn CLI + +The desktop app does not bundle the CLI — every screen gets its data by +spawning `codeburn`, resolved from the persisted path file, Homebrew/node +version-manager locations, or `PATH` (`electron/cli.ts`). On a machine +without it, the app launches into its "CLI not found" state until the user +runs: + +```sh +npm install -g codeburn +``` + +Bundling `dist/cli.js` into the app (`extraResources` + spawning it with +Electron's own binary via `ELECTRON_RUN_AS_NODE`) is the known path to a +zero-dependency install; not implemented yet. + ## Build ```sh