docs: clarify install paths now that unpinned npx works#13
Conversation
Restructure the README's top half around the three actually-supported install paths so first-time readers can pick the right one without hunting: 1. one-off via npx / bunx — no install (unpinned now works as of 0.1.1) 2. global install via bun add -g — daily use 3. standalone binary downloaded from a GitHub Release — no runtime Also lifts the pho-alias note into its own subsection under Quickstart with the explicit caveat that npx/bunx ephemeral runs don't get pho (it's only created when running through an installed photon binary). The previous version led with `bun add -g` and buried npx as an afterthought in the Quickstart, which understated what the CLI now supports. Co-authored-by: Orca <help@stably.ai>
|
Caution Review failedPull request was closed or merged during review 📝 WalkthroughWalkthroughREADME.md is reorganized to document three distinct installation workflows: one-off execution via Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Warning Review ran into problems🔥 ProblemsThese MCP integrations need to be re-authenticated in the Integrations settings: Linear Review rate limit: 4/5 reviews remaining, refill in 12 minutes. Comment |
There was a problem hiding this comment.
Pull request overview
Restructures the README’s onboarding flow so new users can quickly choose among the three supported installation approaches (one-off via npx/bunx, global via bun add -g, or standalone binaries), with clearer guidance on runtime expectations and the pho alias behavior.
Changes:
- Adds a top-level “Install” section that presents three supported install paths in increasing commitment.
- Updates the hero/quickstart content to reflect the new install guidance and renumbers quickstart steps.
- Promotes
photo its own Quickstart subsection and clarifies when it is created.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| Each invocation pulls the latest release on demand. Good for scripts, throwaway machines, or trying the CLI before committing. Requires Bun on `PATH` (the bundle has a `#!/usr/bin/env bun` shebang) — install it once with: | ||
|
|
||
| ```sh | ||
| curl -fsSL https://bun.sh/install | bash | ||
| ``` |
There was a problem hiding this comment.
The runtime requirements here are a bit incomplete: npx itself requires a Node/npm installation (even if the CLI then needs Bun to execute due to the #!/usr/bin/env bun shebang). Consider explicitly calling out that npx users need Node + Bun, while bunx users only need Bun, to avoid confusion for first-time readers.
| # pick your platform from https://github.com/photon-hq/cli/releases/latest | ||
| curl -L -o /usr/local/bin/photon \ | ||
| https://github.com/photon-hq/cli/releases/latest/download/photon-darwin-arm64 | ||
| chmod +x /usr/local/bin/photon |
There was a problem hiding this comment.
Writing to /usr/local/bin/photon will fail on many systems without elevated permissions. Consider using sudo for the curl/chmod steps or switching the example to a user-writable bin dir (e.g., $HOME/.local/bin) and noting that it must be on PATH.
Restructures the top of the README around the three actually-supported install paths, so first-time readers can pick the right one without hunting.
Before / after
Before: hero block led with a single
bun add -gline; `npx`/`bunx` was buried as a footnote in Quickstart; standalone binaries were a one-line aside in the Bun-required callout.After: hero shows two snappy options (npx try, bun add -g daily). New `## Install` section presents three paths in increasing commitment:
Each path explicitly states its runtime requirement so users don't get bitten by the `#!/usr/bin/env bun` shebang silently failing.
The pho alias
Promoted to its own subsection under Quickstart with the explicit caveat that `npx` / `bunx` ephemeral runs don't get `pho` (the runtime symlink only fires for installed binaries — see
src/lib/pho-alias.ts).Test plan
Docs-only change. Visual review via the PR diff.
🤖 Generated with Claude Code
Made with Orca 🐋
Summary by CodeRabbit
phoalias works and when it's created.