Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

<details>
<summary>Alpha snapshots from GitHub</summary>

Expand Down
8 changes: 8 additions & 0 deletions website/content/docs/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
Loading