docs(cli): update for Node.js environment

[citron (lcandy2)]

Summary

• Update CLI docs to reflect the npm bundle now targeting Node.js instead of Bun
• Remove Bun shebang requirement from installation page
• Change global install from bun add -g to npm install -g (with Bun as alternative)
• Simplify one-off section to just npx (no longer needs Bun on PATH)
• Add note that Node >= 18 is sufficient, Bun is optional
• Update description to match new tagline ("bring your agents to any interface")

Follows up on photon-hq/cli#20 which switched the npm bundle to --target node.

Test plan

• Pre-commit hooks pass (lint + vellum + typecheck)
• Mintlify deployment preview renders correctly

Made with Cursor

---

^{Need help on this PR? Tag @codesmith with what you need.}

• Let Codesmith autofix CI failures and bot reviews

Summary by CodeRabbit

• Documentation
  • Installation guide rewritten for clearer workflow and simplified headings
  • Consolidated install commands into a single code group covering npm/pnpm/yarn/bun; removed standalone Bun-only note
  • One-off runner example simplified to a single pnpx-style command block
  • Overview updated to brand the product as “Photon CLI” and highlight CLI capabilities (agents, projects, Spectrum, billing, profile)
  • Clarified Node.js requirement (>= 18)

[coderabbitai]

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 4eee669a-fa30-41a1-8076-bc4f60075eb1

📥 Commits

Reviewing files that changed from the base of the PR and between 1e68856 and 4fac691.

📒 Files selected for processing (2)

• cli/installation.mdx
• cli/overview.mdx

Disabled knowledge base sources:

• Linear integration is disabled

You can enable these sources in your CodeRabbit configuration.

---

📝 Walkthrough

Walkthrough

Docs update: overview now brands “Photon CLI” and adds a Node.js >= 18 requirement; installation page removes Bun-specific phrasing, simplifies Homebrew notes, shows a pnpx one-off example, and consolidates global install commands into a CodeGroup including npm/pnpm/yarn/bun.

Changes

CLI Documentation

Layer / File(s)	Summary
Overview description and requirements cli/overview.mdx	Overview description updated to mention “Photon CLI” and agent interface flexibility; added a note that Node.js >= 18 is required and no extra runtime is needed.
Installation workflow restructure cli/installation.mdx	Top description removed explicit Bun mention; Homebrew wording shortened; One-off examples replaced with a pnpx-only CodeGroup; Global install rewritten as a CodeGroup for npm/pnpm/yarn/bun and Bun-specific shebang/path note removed; Node.js >= 18 requirement added.

Estimated Code Review Effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly Related PRs

• photon-hq/docs#22: Edits the same CLI docs pages with overlapping installation and overview wording changes.

Poem

🐰 I hopped through docs with cheerful cheer,
Photon CLI now clear and near,
Node eighteen stamped, commands aligned,
pnpx for one-offs, installs combined,
A little rabbit clap—docs refined!

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The PR title 'docs(cli): update for Node.js environment' is directly related to the main changes in the changeset, which involve updating CLI documentation to reflect Node.js as the primary runtime environment instead of Bun.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch docs/cli-node-env

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[Copilot]

Pull request overview

Updates the CLI documentation to reflect the npm package now targeting Node.js instead of requiring Bun, while keeping Bun as an optional install path.

Changes:

• Updates CLI overview tagline and adds Node.js >= 18 runtime note.
• Revises installation docs to prefer npx and npm install -g.
• Removes Bun-specific one-off guidance and clarifies Bun is optional.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File	Description
cli/overview.mdx	Updates description metadata and adds Node.js runtime note.
cli/installation.mdx	Updates one-off and global install instructions for npm/Node.js.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[coderabbitai]

Actionable comments posted: 3

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@cli/installation.mdx`:
- Around line 28-40: Rename the section heading "## Global install with npm" to
a neutral title that reflects both commands (for example "## Global install" or
"## Global install with npm or Bun") so it matches the contents inside the
CodeGroup showing both npm and bun install commands; update the heading text
only (leave the CodeGroup block and the two install command snippets unchanged).
- Line 49: The runtime note "The npm bundle runs on Node.js >= 18. Bun is also
supported but not required." should be rewritten in second person and active
voice to address the reader directly; replace it with a sentence such as "You
can run the npm bundle on Node.js >= 18; you can also use Bun, but you don't
need it." Ensure the new sentence preserves the same facts and tone, uses "you"
and active verbs, and replaces the original sentence in cli/installation.mdx.

In `@cli/overview.mdx`:
- Line 12: The runtime requirement sentence "Runs on Node.js >= 18 — no
additional runtime required." should be rewritten in second person and active
voice; replace it with a line addressing the reader directly (e.g., "You can run
Photon CLI on Node.js >= 18 with no additional runtime.") so update the runtime
requirement note in cli/overview.mdx accordingly.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 5384c761-921e-4570-ba43-3b3c7a772be6

📥 Commits

Reviewing files that changed from the base of the PR and between 2e85ddb and 1e68856.

📒 Files selected for processing (2)

• cli/installation.mdx
• cli/overview.mdx

📜 Review details

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Agent

🧰 Additional context used

📓 Path-based instructions (1)

**/*.mdx

📄 CodeRabbit inference engine (AGENTS.md)

**/*.mdx: Pages should be written as MDX files with YAML frontmatter
Use active voice and second person ("you") in documentation
Keep sentences concise with one idea per sentence in documentation
Use sentence case for headings in documentation
Bold UI elements in documentation (e.g., Click Settings)
Use code formatting for file names, commands, paths, and code references in documentation

Files:

• cli/installation.mdx
• cli/overview.mdx

🔇 Additional comments (1)

cli/overview.mdx (1)

3-3: LGTM!

[Copilot]

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.