Developers Authentication

Developers

Authentication

Create Frontpage API keys, store them safely, and authenticate the CLI in interactive and CI environments.

Create a key

  1. Open app.frontpage.host and sign in.
  2. Profile menu → Developers.
  3. Create key, then copy fp_live_… immediately.

Only site owners can create keys. Keys work for all sites that owner can access.

Interactive login

frontpage login
# paste the key when prompted

frontpage whoami
frontpage doctor

On macOS the CLI prefers the OS keychain (service frontpage-cli). Otherwise it stores the key in ~/.config/frontpage/api-key with mode 0600.

Non-interactive / CI

export FRONTPAGE_API_KEY=fp_live_…
frontpage doctor --json
frontpage sites --json

FRONTPAGE_API_KEY always wins over the keychain for that process. Optional:

export FRONTPAGE_API_BASE=https://app.frontpage.host

Default API base is production https://app.frontpage.host.

Pass the key once on the command line

frontpage login "$FRONTPAGE_API_KEY"

Logout

frontpage logout

List sites

frontpage sites --json

Human output reminds you to use the subdomain with frontpage use. JSON includes subdomain, role, name, and customDomain (display only).

Link a working folder

cd ~/sites/acme
frontpage use acme
cat .frontpage/state.json
# { "slug": "acme" }

Switching sites with use clears baseCommitSha. Run pull again before push.