Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.photon.codes/docs/llms.txt

Use this file to discover all available pages before exploring further.

The photon spectrum commands manage your project’s messaging configuration — the Spectrum profile, users, phone lines, platform toggles, and avatar. All Spectrum commands require an active project. Set $PHOTON_PROJECT_ID or pass --project <id>.

Spectrum profile

View or update the Spectrum profile attached to your project.
# View the current profile
photon spectrum profile show

# Update profile fields
photon spectrum profile update --display-name "Support Bot"
Aliases: spectrum profile edit.

Users

Manage users that can interact through your project’s Spectrum instance.

List users

photon spectrum users ls
photon spectrum users ls --json
Aliases: spectrum users list.

Add a user

photon spectrum users add
Aliases: spectrum users create.

Remove a user

photon spectrum users remove <user-id>
Removing a user is irreversible. The CLI asks for confirmation unless you pass -y.
Aliases: spectrum users rm, spectrum users delete.

Lines

Manage the phone lines assigned to your project.

List lines

photon spectrum lines ls
Aliases: spectrum lines list.

Add a line

photon spectrum lines add
Currently supports iMessage lines only.

Remove a line

photon spectrum lines remove <line-id>

Platforms

View and toggle messaging platforms for your project.

List platforms

photon spectrum platforms ls
Aliases: spectrum platforms list.

Enable a platform

photon spectrum platforms enable <platform-name>

Disable a platform

photon spectrum platforms disable <platform-name>

Avatar

Upload a custom avatar image for your project’s Spectrum profile.
photon spectrum avatar upload photo.png
The CLI requests a presigned upload URL from the API, uploads the file directly, and patches the Spectrum profile to use it.
FlagDescription
--no-update-profileUpload the file but don’t update the Spectrum profile to use it

Common flags

FlagEnv varDescription
-p, --project <id>PHOTON_PROJECT_IDTarget project
--api-host <url>PHOTON_API_HOSTOverride the backend URL
-t, --token <token>PHOTON_TOKENUse this token instead of stored credentials
--jsonOutput as JSON (where supported)