Skip to main content

CLI setup

info

The CLI ships on Pro and Pro+. On Free, publish from the web app.

Get a site live from the command line.

The CLI is optional. Everything it does is also available in the web app, and the two operate on the same projects and builds. For the browser flow, see the Web App Quickstart.

Install via Homebrew (macOS / Linux)​

brew tap micropage-sh/tap
brew install micropage

No additional dependencies required — Homebrew manages everything.

Install via npm​

Requires Node.js 18 or later.

npm install -g @micropage-sh/cli

Verify installation​

micropage whoami

If you are not logged in yet, the CLI will ask you to authenticate. Once logged in, whoami also shows your current Micropage plan tier and any active subscription.

A Free account cannot publish through the CLI. The plan check happens at login: micropage login refuses a Free account and prints an upgrade link, so there is no session to publish with. Upgrade to Pro, or use the browser.

Login​

micropage login

This opens a browser window for authentication. Use micropage logout to clear the stored session.

Create a project​

micropage projects create mysite

This command:

  • creates the project remotely
  • creates a local mysite/ folder with a .micropage/ configuration directory
  • writes a starter landing.page at the project root
  • copies the full set of starter templates into examples/ for reference
  • adds assets/logo.svg and assets/favicon.svg, uploaded on your first push
  • creates an empty posts/ folder for post Markdown files
  • adds PROJECT_AGENT.md describing the layout for editors and local agents, including a link to the full docs at https://docs.micropage.sh

Edit your page​

landing.page is the entrypoint. Additional *.page files in the folder are merged in alphabetical order after it.

For markup syntax, sections, and images, see Your First Page, Images, and Components & Aliases.

Publish​

micropage publish

micropage push only saves a draft build. publish is the one that makes the markup live.

Open your site​

micropage preview

Opens the live site in your browser.

Next steps​