Skip to main content

CLI setup

Get a site live from the command line.

The CLI is optional. If you only use the web app, you do not need to install anything. For a browser-based flow, see the Web App Quickstart.

Install via Homebrew (macOS / Linux)​

brew install micropage-sh/micropage/micropage

No additional dependencies required — Homebrew manages everything.

Install via npm​

Requires Node.js 18 or later.

npm install -g micropage

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.

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
  • initializes a local project folder
  • creates the .micropage configuration directory
  • scaffolds an examples/ folder with starter .page files
  • adds default logo.svg and favicon.svg at the project root
  • 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​

Open the generated page file (for example landing.page) and add content. For markup syntax, sections, and images, see Your First Page, Images, and Components & Aliases.

Publish​

micropage publish

Your site is deployed to Cloudflare Pages.

Open your site​

micropage preview

Opens the live site in your browser.

Next steps​