Skip to main content
Photon CLI is a typed command-line client for Photon. Use it to sign in, switch between projects, buy and configure phone numbers and email domains, register for 10DLC, manage API keys and webhooks, and script all of it from CI. It installs with npm, pnpm, Yarn, or Bun, runs on Node.js 22 or newer, and also ships as a standalone binary for macOS, Linux, and Windows.
The current beta talks only to https://api.staging.photon.codes.

​
Start here

Installation

Install the CLI with a package manager or as a standalone binary.

Authentication

Sign in with a device code and manage your stored session.

Service keys

Give CI and automation a non-interactive credential.

Projects

Select an active project and work with its resources.

​
Work with your resources

Platform resources

Buy phone numbers, verify email domains, and route voice calls.

API keys

Issue and revoke project API keys.

Webhooks

Subscribe endpoints to project events.

Organizations

Invite teammates, manage roles, and select an organization.

​
Compliance and automation

10DLC registration

Register brands and campaigns for A2P messaging.

Call Registry

Register numbers with the Photon Call Registry.

JSON output

Machine-readable results, errors, and exit codes.

Recoverable operations

Replay a mutation whose result you never saw.