From 5107bfa480e5311a24b5c24df65cab207facf76e Mon Sep 17 00:00:00 2001 From: invisicat Date: Sat, 20 Jun 2026 14:54:31 -0700 Subject: [PATCH 1/3] docs: fix CLI flag inconsistencies in cli pages --- cli/authentication.mdx | 2 +- cli/profile-and-utilities.mdx | 10 +++++++--- cli/projects.mdx | 10 ++++++---- cli/spectrum.mdx | 2 +- 4 files changed, 15 insertions(+), 9 deletions(-) diff --git a/cli/authentication.mdx b/cli/authentication.mdx index 95a31f3..7834af0 100644 --- a/cli/authentication.mdx +++ b/cli/authentication.mdx @@ -25,7 +25,7 @@ photon login --no-browser photon whoami ``` -Prints your user ID, email, and name. If the session has expired, you'll see a hint to re-run `photon login`. +Prints your name, email, and the backend you're signed in to. If the session has expired, you'll see a hint to re-run `photon login`. ## Log out diff --git a/cli/profile-and-utilities.mdx b/cli/profile-and-utilities.mdx index 29ef3ff..34a21de 100644 --- a/cli/profile-and-utilities.mdx +++ b/cli/profile-and-utilities.mdx @@ -26,10 +26,14 @@ Walks you through an interactive prompt to create a developer or organization pr ### Update your profile ```sh -photon profile update --display-name "Jane Doe" +# Developer profile +photon profile update --languages typescript,python + +# Organization profile +photon profile update --company-name "Acme Inc" --role "Engineering" ``` -Updates specific fields on your existing profile. The available flags differ based on whether you have a developer or organization profile. +Updates specific fields on your existing profile. The available flags differ based on whether you have a developer or organization profile — run `photon profile update --help` for the full list. Aliases: `profile edit`. @@ -73,7 +77,7 @@ Show the authenticated user for the current backend: photon whoami ``` -Prints your user ID, email, and name. Returns an error with a login hint if your session has expired. +Prints your name, email, and the backend you're signed in to. Returns an error with a login hint if your session has expired. ### auth status diff --git a/cli/projects.mdx b/cli/projects.mdx index 1d28f52..cb57b9a 100644 --- a/cli/projects.mdx +++ b/cli/projects.mdx @@ -32,14 +32,16 @@ photon projects create Without flags, the CLI walks you through an interactive prompt. You can also pass flags directly: ```sh -photon projects create --name "My Project" --location us-east --spectrum +photon projects create --name "My Project" --location "United States" --spectrum ``` | Flag | Description | |------|-------------| -| `--name ` | Project name | -| `--location ` | Deployment region | -| `--spectrum` | Enable Spectrum for the project | +| `-n, --name ` | Project name | +| `-l, --location ` | Location (default: `United States`) | +| `--spectrum` / `--no-spectrum` | Enable / disable Spectrum | +| `--template` | Use the project as a template | +| `--observability` | Enable observability | Aliases: `projects new`. diff --git a/cli/spectrum.mdx b/cli/spectrum.mdx index f036903..cf5105c 100644 --- a/cli/spectrum.mdx +++ b/cli/spectrum.mdx @@ -16,7 +16,7 @@ View or update the Spectrum profile attached to your project. photon spectrum profile show # Update profile fields -photon spectrum profile update --display-name "Support Bot" +photon spectrum profile update --first-name "Support" --last-name "Bot" ``` Aliases: `spectrum profile edit`. From 6a1fbb106421aa184a4d7c50705d714b6794a954 Mon Sep 17 00:00:00 2001 From: invisicat Date: Sat, 20 Jun 2026 15:02:51 -0700 Subject: [PATCH 2/3] docs: remove Homebrew install section --- cli/installation.mdx | 11 ----------- 1 file changed, 11 deletions(-) diff --git a/cli/installation.mdx b/cli/installation.mdx index 0d8f1ce..a3f1b2d 100644 --- a/cli/installation.mdx +++ b/cli/installation.mdx @@ -3,17 +3,6 @@ title: Installation description: Install the Photon CLI via npm, or as a standalone binary --- -{/* ## Homebrew (macOS / Linux) - -If you're on macOS or Linux, Homebrew is the easiest option. You get a self-contained binary with no runtime dependencies. - -```sh -brew install photon-hq/photon/photon -photon login -``` - -Updates automatically with `brew upgrade photon`. */} - ## One-off — no install You can run any CLI command on demand without a global install: From 6568be668a4ff1d58bceee01c6af94a24ec29dd9 Mon Sep 17 00:00:00 2001 From: invisicat Date: Sat, 20 Jun 2026 18:14:39 -0700 Subject: [PATCH 3/3] docs: add screenshots and demo videos to CLI pages --- .gitignore | 1 + cli/authentication.mdx | 13 ++++++++++++ cli/billing.mdx | 12 +++++++++++ cli/overview.mdx | 4 ++++ cli/projects.mdx | 20 ++++++++++++++++++ cli/spectrum.mdx | 4 ++++ images/cli/authentication/login-cli.avif | Bin 0 -> 59284 bytes images/cli/authentication/login-web.avif | Bin 0 -> 42648 bytes images/cli/authentication/whoami-cli.avif | Bin 0 -> 35354 bytes images/cli/billing/demo-billing.webm | Bin 0 -> 219946 bytes .../cli/billing/demo-regenerate-secret.webm | Bin 0 -> 110170 bytes images/cli/billing/demo-upgrade.webm | Bin 0 -> 214340 bytes images/cli/billing/free.avif | Bin 0 -> 27730 bytes images/cli/billing/paid.avif | Bin 0 -> 23102 bytes images/cli/overview/demo-overview.webm | Bin 0 -> 197634 bytes images/cli/projects/demo-create.webm | Bin 0 -> 129998 bytes images/cli/projects/projects-ls.avif | Bin 0 -> 28260 bytes images/cli/projects/projects-show.avif | Bin 0 -> 28188 bytes images/cli/spectrum/spectrum-lines.avif | Bin 0 -> 13127 bytes 19 files changed, 54 insertions(+) create mode 100644 images/cli/authentication/login-cli.avif create mode 100644 images/cli/authentication/login-web.avif create mode 100644 images/cli/authentication/whoami-cli.avif create mode 100644 images/cli/billing/demo-billing.webm create mode 100644 images/cli/billing/demo-regenerate-secret.webm create mode 100644 images/cli/billing/demo-upgrade.webm create mode 100644 images/cli/billing/free.avif create mode 100644 images/cli/billing/paid.avif create mode 100644 images/cli/overview/demo-overview.webm create mode 100644 images/cli/projects/demo-create.webm create mode 100644 images/cli/projects/projects-ls.avif create mode 100644 images/cli/projects/projects-show.avif create mode 100644 images/cli/spectrum/spectrum-lines.avif diff --git a/.gitignore b/.gitignore index 2fd2fd4..360a6a5 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,6 @@ node_modules .typecheck-output +.DS_Store .pnpm-store diff --git a/cli/authentication.mdx b/cli/authentication.mdx index 7834af0..13d87f9 100644 --- a/cli/authentication.mdx +++ b/cli/authentication.mdx @@ -13,6 +13,14 @@ photon login This opens your default browser to the Photon approval page. Once you approve, the CLI stores your access token locally and you're ready to go. + +Terminal running photon login, showing the device code and approval URL + + + +Photon browser approval page for the device login flow + + If you're on a headless machine (SSH session, container), pass `--no-browser` to get a URL you can open elsewhere: ```sh @@ -27,6 +35,11 @@ photon whoami Prints your name, email, and the backend you're signed in to. If the session has expired, you'll see a hint to re-run `photon login`. + +Terminal output of photon whoami showing name, email, and backend + + + ## Log out ```sh diff --git a/cli/billing.mdx b/cli/billing.mdx index 14a38e8..78ac34b 100644 --- a/cli/billing.mdx +++ b/cli/billing.mdx @@ -24,6 +24,14 @@ photon billing show --json Displays the active subscription for the current project, including plan details and status. + +Terminal output of photon billing show for a project on the free tier + + + +Terminal output of photon billing show for a project on a paid plan + + ## Start a checkout ```sh @@ -40,6 +48,10 @@ photon billing checkout --plan price_xxx When you run this command, the CLI creates a Stripe Checkout session and opens it in your browser. If you don't pass any arguments, you get an interactive picker listing the available plans. Pass a `[tier]` positional or `--plan ` to skip the picker. + +