All guides
Using Frontpage 2 min read

How to use the Frontpage CLI

Install the Frontpage CLI, connect it to a site, and review a file change on staging before you publish.

Install and sign in

With Node.js and npm installed, run npm i -g frontpage-host. The command is frontpage. Run frontpage help to see what is available. In your Frontpage profile menu, open Developers to create an API key if your account allows it. Run frontpage login and follow the prompt. Treat the key like a password and keep your API key out of source control.

Frontpage developer documentation showing how to push a local change and review the diff
The Frontpage Developer Quickstart shows how to review the diff and push changes to staging. Open full size

Link and pull a site

  • Run frontpage whoami to check the signed-in account.
  • Run frontpage sites to find the site's subdomain. Use that short name rather than its custom domain.
  • Open a clean project folder. Run frontpage use your-subdomain, then frontpage pull.

The pull downloads the files Frontpage supports for editing. See which files the CLI can sync before changing the project layout.

Review, then publish

Make a small edit. Run frontpage diff --json to check your files, then frontpage push --message "Update the contact page" --wait. Open the staging site and test the change. If the CLI reports that the site changed since your pull, stop and reconcile your edits against a fresh copy before retrying.

Use frontpage publish only when you are ready for the staged site to go live. Check the whole staged build because publishing includes any other changes already on staging. Review how staging and production differ, and use the command reference for other tasks.

Frequently asked questions

What is the Frontpage CLI package called?

Install the frontpage-host npm package. It provides the frontpage command.

Can I use the Frontpage CLI on Free?

Yes. Site commands support Free. Your account and site role still determine what you can do.

Does frontpage push publish to my live website?

No. It sends changes to staging. Review the staged site before you run frontpage publish.

What should I do if someone else changes the site while I edit it?

Keep a copy of your work, pull the latest files, and reconcile the changes before pushing again. Check the diff and staging preview afterward.

Ready to try it on your website?

Open your workspace and continue with your site.