From 1e98590361cc861e7a017718d75334449c46f52f Mon Sep 17 00:00:00 2001 From: enixCode <58286681+enixCode@users.noreply.github.com> Date: Thu, 4 Jun 2026 21:51:26 +0200 Subject: [PATCH] docs: note project-local install uses npx (light not on PATH) A local `npm install` (no -g) puts the binaries in node_modules/.bin, which is not on PATH, so a plain `light` fails. Document the npx form alongside the global install in both getting-started and the README. build with cc --- README.md | 7 +++++++ website/content/docs/getting-started.mdx | 8 ++++++++ 2 files changed, 15 insertions(+) diff --git a/README.md b/README.md index 711f7cc..5cb5a93 100644 --- a/README.md +++ b/README.md @@ -38,6 +38,13 @@ npm install -g light-process @enixcode/light-run Requires Node 20+ and Docker running on the same host as `light-run`. +Prefer a project-local install? Drop the `-g` and call the CLI through `npx` (the binaries land in `node_modules/.bin`, not your PATH, so plain `light` will not resolve): + +```bash +npm install light-process @enixcode/light-run +npx light doctor +``` +
Alpha snapshots from GitHub diff --git a/website/content/docs/getting-started.mdx b/website/content/docs/getting-started.mdx index 1312a60..2c07bcb 100644 --- a/website/content/docs/getting-started.mdx +++ b/website/content/docs/getting-started.mdx @@ -17,6 +17,14 @@ Install both the orchestrator and the execution server: npm install -g light-process @enixcode/light-run ``` +Installed globally, `light` is a command everywhere. Prefer a **project-local** install? Drop the `-g` and prefix commands with `npx` - the binaries land in `node_modules/.bin`, which is not on your PATH, so plain `light` will not be found: + +```bash +npm install light-process @enixcode/light-run +npx light doctor +npx light run example +``` + `light-process` delegates container execution to `light-run`. Two usage modes: - **All-in-one (default):** leave `LIGHT_RUN_URL` unset. `light serve` and `light run` auto-spawn a local `light-run` process on a free port (requires the binary above).