Skip to content

Commit 3e6d454

Browse files
lcandy2cursoragent
andauthored
docs(cli): update for Node.js environment (#23)
* docs(cli): update for Node.js environment The npm bundle now targets Node.js (shebang #!/usr/bin/env node, build --target node). Update CLI docs to reflect: - Remove Bun shebang requirement note from installation - Change global install from `bun add -g` to `npm install -g` - Simplify one-off section to npx (no longer needs Bun on PATH) - Add note that Node >= 18 is sufficient, Bun is optional - Update description to match new tagline Co-authored-by: Cursor <cursoragent@cursor.com> * docs(cli): show all package managers, comment out Homebrew - One-off section: npx / pnpx / bunx tabs - Global install: npm / pnpm / yarn / bun tabs - Comment out Homebrew section (not ready yet) - Bun no longer a hard dependency, Node >= 18 is sufficient Co-authored-by: Cursor <cursoragent@cursor.com> * fix(docs): use second-person voice in runtime notes Addresses CodeRabbit feedback on #23. Co-authored-by: Cursor <cursoragent@cursor.com> --------- Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent 2e85ddb commit 3e6d454

2 files changed

Lines changed: 33 additions & 13 deletions

File tree

cli/installation.mdx

Lines changed: 30 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
22
title: Installation
3-
description: Install the Photon CLI via Homebrew, npm, Bun, or as a standalone binary
3+
description: Install the Photon CLI via npm, or as a standalone binary
44
---
55

6-
## Homebrew (macOS / Linux)
6+
{/* ## Homebrew (macOS / Linux)
77
88
If you're on macOS or Linux, Homebrew is the easiest option. You get a self-contained binary with no runtime dependencies.
99
@@ -12,9 +12,9 @@ brew install photon-hq/photon/photon
1212
photon login
1313
```
1414
15-
Updates automatically with `brew upgrade photon`.
15+
Updates automatically with `brew upgrade photon`. */}
1616

17-
## One-off with npx / bunx
17+
## One-off — no install
1818

1919
You can run any CLI command on demand without a global install:
2020

@@ -24,6 +24,11 @@ npx @photon-ai/cli login
2424
npx @photon-ai/cli projects ls
2525
```
2626

27+
```sh pnpx
28+
pnpx @photon-ai/cli login
29+
pnpx @photon-ai/cli projects ls
30+
```
31+
2732
```sh bunx
2833
bunx @photon-ai/cli login
2934
bunx @photon-ai/cli projects ls
@@ -32,25 +37,38 @@ bunx @photon-ai/cli projects ls
3237

3338
Each time you run it, it pulls the latest release automatically. This is useful for scripts, throwaway machines, or trying the CLI before committing.
3439

35-
<Note>
36-
The npm bundle uses a `#!/usr/bin/env bun` shebang, so you need Bun on your `PATH`. Install it with:
40+
## Global install
3741

38-
```sh
39-
curl -fsSL https://bun.sh/install | bash
42+
For daily use, you can install globally so `photon` is always on your `PATH`:
43+
44+
<CodeGroup>
45+
```sh npm
46+
npm install -g @photon-ai/cli
4047
```
41-
</Note>
4248

43-
## Global install with Bun
49+
```sh pnpm
50+
pnpm add -g @photon-ai/cli
51+
```
4452

45-
For daily use, you can install globally so `photon` is always on your `PATH`:
53+
```sh yarn
54+
yarn global add @photon-ai/cli
55+
```
4656

47-
```sh
57+
```sh bun
4858
bun add -g @photon-ai/cli
59+
```
60+
</CodeGroup>
61+
62+
```sh
4963
photon login
5064
```
5165

5266
The `pho` shortcut alias is created automatically the first time you run `photon`.
5367

68+
<Note>
69+
You need Node.js >= 18 to run the CLI. You can also use Bun, but it's not required.
70+
</Note>
71+
5472
## Standalone binary
5573

5674
If you don't want any runtime dependency (e.g. CI environments), you can download a prebuilt binary directly. Replace `<os>` and `<arch>` with your platform:

cli/overview.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Photon CLI
3-
description: Manage projects, Spectrum, billing, and your profile from the terminal
3+
description: Bring your agents to any interface — manage projects, Spectrum, billing, and your profile from the terminal
44
---
55

66
The Photon CLI replaces the [Dashboard](https://app.photon.codes) web UI for everyday work. Manage projects, Spectrum users and lines, billing, and your developer profile — all from a terminal.
@@ -9,6 +9,8 @@ The Photon CLI replaces the [Dashboard](https://app.photon.codes) web UI for eve
99
npx @photon-ai/cli login
1010
```
1111

12+
You can run it on Node.js >= 18 — no additional runtime required.
13+
1214
## Quick demo
1315

1416
After [installing](/cli/installation) the CLI:

0 commit comments

Comments
 (0)