Skip to content

docs(cli): update for Node.js environment #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
citron (lcandy2) merged 3 commits into from
May 13, 2026
+33 −13
Merged

docs(cli): update for Node.js environment #23

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1e68856
docs(cli): update for Node.js environment
lcandy2 May 13, 2026
05040a4
docs(cli): show all package managers, comment out Homebrew
lcandy2 May 13, 2026
4fac691
fix(docs): use second-person voice in runtime notes
lcandy2 May 13, 2026
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
36 changes: 17 additions & 19 deletions cli/installation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Installation
description: Install the Photon CLI via Homebrew, npm, Bun, or as a standalone binary
description: Install the Photon CLI via Homebrew, npm, or as a standalone binary
---

## Homebrew (macOS / Linux)
Expand All @@ -14,43 +14,41 @@ photon login

Updates automatically with `brew upgrade photon`.

## One-off with npx / bunx
## One-off with npx

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

<CodeGroup>
```sh npx
```sh
npx @photon-ai/cli login
npx @photon-ai/cli projects ls
```

```sh bunx
bunx @photon-ai/cli login
bunx @photon-ai/cli projects ls
```
</CodeGroup>

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

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

```sh
curl -fsSL https://bun.sh/install | bash
```
</Note>
For daily use, you can install globally so `photon` is always on your `PATH`:

## Global install with Bun
<CodeGroup>
```sh npm
npm install -g @photon-ai/cli
```

For daily use, you can install globally so `photon` is always on your `PATH`:
```sh bun
bun add -g @photon-ai/cli
```
</CodeGroup>
Comment thread
coderabbitai[bot] marked this conversation as resolved.
Outdated

```sh
bun add -g @photon-ai/cli
photon login
```

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

<Note>
The npm bundle runs on Node.js >= 18. Bun is also supported but not required.
Comment thread
coderabbitai[bot] marked this conversation as resolved.
Outdated
</Note>

## Standalone binary

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:
Expand Down
4 changes: 3 additions & 1 deletion cli/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Photon CLI
description: Manage projects, Spectrum, billing, and your profile from the terminal
description: Bring your agents to any interface — manage projects, Spectrum, billing, and your profile from the terminal
---

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.
Expand All @@ -9,6 +9,8 @@ The Photon CLI replaces the [Dashboard](https://app.photon.codes) web UI for eve
npx @photon-ai/cli login
```

Runs on Node.js >= 18 — no additional runtime required.
Comment thread
lcandy2 marked this conversation as resolved.
Outdated

## Quick demo

After [installing](/cli/installation) the CLI:
Expand Down
Loading