vrr/codeburn
2
0
Fork 0
mirror of https://github.com/AgentSeal/codeburn.git synced 2026-07-30 03:15:30 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

docs(app): DISTRIBUTION.md states the codeburn CLI prerequisite

Browse source 
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.
This commit is contained in:
iamtoruk 2026-07-16 07:21:22 -07:00
parent 2c66601b47
commit 5ceaf6bd52
1 changed files with 16 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

16
app/DISTRIBUTION.md
View file

@ -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