Developers Command reference

Developers

Command reference

Every shipped Frontpage CLI command: auth, sync, agent, content, history, and utilities.

Install

npm i -g frontpage-host
frontpage help
# or
npx frontpage-host help

Package name is frontpage-host. Binary is frontpage. Do not install the unrelated npm package named frontpage. Node.js ≥ 20.

Email workflows

See Emails for combined template/series saves, saved campaign recipients, directory filters, Off enrollment and resume timing, settings resets, suppressions and Sent history. CLI 0.2.11 keeps the same command and API namespace.

frontpage mail save --file save.json --site YOUR_SITE --json
frontpage mail people --sort newest --page 1 --site YOUR_SITE --json
frontpage mail sends list --q alex --type series --status delivered --page 1 --site YOUR_SITE --json
frontpage mail settings set --file settings.json --site YOUR_SITE --json

Global flags

See Flags & machine I/O for --json, --quiet, --site, --yes, and the JSON envelope.

Auth & session

Command Usage
login frontpage login [api-key]
logout frontpage logout
whoami frontpage whoami [--json]
doctor frontpage doctor [--json]
sites frontpage sites [--json]
use / link frontpage use <subdomain>
completion frontpage completion bash|zsh|fish

File sync

Command Usage
pull frontpage pull [--site <slug>] [--json]
push frontpage push [--site <slug>] [--message …] [--wait] [--json]
diff frontpage diff [--site <slug>] [--json]. Local vs remote via git blobSha; JSON includes dirty + tipDrift
ls frontpage ls [prefix] [--site <slug>] [--json]
cat frontpage cat <path> [--site <slug>]
search frontpage search <pattern> [path|--path <path>] [--regex] [--case-sensitive] [--whole-word] [--files-only] [--context-lines N] [--max-results N] [--site <slug>]
fonts frontpage fonts [list|search] [--slot …] [--query …] [--variable-only] [--limit N] [--json]
tokens frontpage tokens set --group <…> --key <…> --value <…> [--site <slug>]
status frontpage status [--site <slug>] [--json]
open frontpage open [/path|--path /path] [--site <slug>]

Agent, deploy, publish

Command Usage
prompt frontpage prompt "…" [--path /] [--attach …] [--site <slug>] [--json]
runs frontpage runs [list|current|wait|cancel|retry|get] [runId] [--json]
deploy wait frontpage deploy wait [--site <slug>] [--json]. Agent idle + tip compile ready, not publish
publish frontpage publish [--site <slug>] [--wait] [--json]. Promote the ready compile (409 if the tip is not built)
unpublish frontpage unpublish [--yes] [--site <slug>] [--json]
usage frontpage usage [--site <slug>]
analytics frontpage analytics [dashboard|summary|query|funnel|timeseries|compare|sql] … [--site <slug>]
pages frontpage pages [--site <slug>] [--json]

Content & config

Command Usage
seo frontpage seo get [/path|--path /path] | seo set --path / […]
redirects frontpage redirects list | set --from /old --to /new [--status 301|308] | rm --from /old. Instant HTTP 301/308; not a file; revert does not undo
articles frontpage articles list|content|create-section|…
media frontpage media list|upload <file>
inbox frontpage inbox [leads|subscribers|orders|google_reviews|…] [--mark-read] [--csv]
people frontpage people list|get|add|set|note|rm-note|follow-up|hide|unhide. Site-scoped person graph. --site is the subdomain slug. Identity is email or phone (see phone/email formats on the People page). Viewer list/get; editor mutate. Full flag tables: People CRM
routines frontpage routines list|get|add|set|pause|resume|rm|run|runs. --site is the subdomain slug, not name.frontpage.host. One routine holds several hours and days: 8am,12pm,4pm and tue,thu,fri store [8, 12, 16] and [2, 4, 5]. set patches and recomputes the next run. pause keeps it. run fires once and does not unpause. The command is Scale+. The site menu row is Growth+. Full guide: Routines
shop frontpage store items|variants|categories|settings|orders|import. Frontpage Store for products, cart and fulfillment. Standalone pay buttons require saved Payments Offerings. Integer minor units ($49.99 is 4999). Stock --add / --remove are signed delta. Viewer list/get; editor catalog writes. Stripe setup uses Payments and an admin browser handoff. Not Square. Full guide: Store
modules frontpage modules [list|docs|request-setup|enable|disable|archive|config] <key> or frontpage modules <key> [action]. Modules, Google reviews, payments, ordering
extensions frontpage extensions [list|docs|enable|disable|config] <key>
customer-inbox frontpage customer-inbox get|put|post RESOURCE. Admin setup uses setup and setup/complete; settings control AI replies and website chat separately. Support reference.
settings frontpage settings get|set […]
edit frontpage edit --path / --old "…" --new "…"

Observe

Full examples: Analytics & usage. Rate classes: Rate limits.

Command Usage
analytics frontpage analytics …. Dashboard or summary/query/funnel/timeseries/compare/sql
usage frontpage usage [--site <slug>]. Plan + AI/bandwidth/storage meters
pages frontpage pages [--site <slug>] [--json]. Path + title list

History

Command Usage
history frontpage history [--limit N] [--page N] [--site <slug>] [--json]
revert frontpage revert <40-char-sha> [--yes] [--site <slug>] [--json]

Shell completion

frontpage completion bash
frontpage completion zsh
frontpage completion fish

# zsh example:
frontpage completion zsh > ~/.zsh/completions/_frontpage
# then ensure fpath includes that directory and run compinit

Completions cover subcommands and help topics. Re-run after upgrading frontpage-host.

Help topics

frontpage help
frontpage help --json
frontpage help quickstart
frontpage help auth
frontpage help sync
frontpage help agent
frontpage help content
frontpage help history
frontpage help isolation
frontpage help exit-codes
frontpage help push

Package docs: AGENTS.md, llms.txt, and README.md inside frontpage-host.

Payments and invoices

Use frontpage payments status|connect|availability|activity|tax|buttons|invoices|recurring|customers. See Payments for exact commands, roles, reviewed sends, stable retry keys, customer authorization and REST paths. Store stays cart-only. Currency is read-only.

Page screenshots

frontpage screenshots capture and frontpage screenshots get inspect built staging pages. See capture modes, private-site access and result handling.