Skip to content
GetmeDocs
Sign inCreate account

Getting started

  • Getme developer documentation

API Reference

  • Introduction
  • Authentication
  • Errors
  • Idempotent requests
  • Metadata
  • Pagination
  • Request IDs
  • Versioning
  • Webhooks
  • Event Catalog
  • SDKs and CLI

Core Resources

  • Auth
  • Events

Site Resources

  • Forms
  • Sites

Commerce Resources

  • Brands
  • Categories
  • Products
  • Services

Crm Resources

  • Customers

Other Resources

  • Media

Dev Tools

  • CLIBeta
  • Website source with the CLIBeta
  • Webhooks with the CLIBeta
  • SDKsBeta
  • Node SDKBeta
  • Python SDKBeta

Guides

  • Guides
  • Quickstart
  • Website source workflow
  • Webhook handler

Changelog

  • Changelog
  • June 10, 2026 - Developer platform docs beta
  • July 15, 2026 - Install token lifecycle safety
  • July 15, 2026 - Source-first site development
  • July 15, 2026 - Site source navigation warnings
Loading documentation...
HomeCLIWebsite source with the CLI

Website source with the CLI

Beta

Pull, validate, push, preview, and request publication for website source from the Getme CLI.

Use the CLI when you want a local development workflow for website source. The workflow is intentionally staged: local changes are validated and saved to a development session before any live publish can happen.

Create from custom source

Use this path when there is no existing live site or when you do not want to select a Getme base theme:

bash
getme sites init --name "Custom storefront"
getme sites create --name "Custom storefront" --message "Initial source"

sites create submits the selected local files as a complete source archive. The server validates the archive before creating a standalone draft and writes its site, session, revision, and manifest state to .getme/. Existing theme validation rules still apply. Run sites deploy afterward to refresh the preview and open the owner-gated publish request.

Pull source

bash
getme sites pull --site site_...

To work on a subset of source files:

bash
getme sites pull --site site_... --only templates/,sections/

.getmeignore, --only, and --ignore control local source selection. The API still validates the submitted bundle on push.

Validate and compare

bash
getme sites check
getme sites diff
getme sites status --site site_...

Use sites check before a push or deploy. It validates local files against the same source contract used by the API.

The CLI prints server validation warnings to stderr and continues when valid=true. Navigation targets that do not resolve to an enabled page are one such warning. Errors still stop create, push, dev, package, and deploy; warnings do not require an interactive confirmation, so CI remains non-blocking and deterministic.

Save staged changes

bash
getme sites push
getme sites pages content write --page wpag_... --locale en --data '{"title":"Updated docs"}'

sites push saves local source changes to a development session. sites pages content write stages one page locale content file in the same session. Neither command publishes live source. This keeps developer tokens safe for automation while leaving final publication under workspace approval.

To remove a staged page locale overlay:

bash
getme sites pages content delete --page wpag_... --locale en

Preview and share

bash
getme sites preview
getme sites share

Preview URLs show the staged session. They are the right way to review changes before requesting publication.

Request publication

bash
getme sites publish-request --message "Ready for review"

The publish request records the session, revision, and message. An owner or authorized admin approves and applies the request in Getme.

One-command guarded deploy

bash
getme sites deploy --message "Homepage update"

sites deploy runs validation, syncs source, refreshes the preview, and creates a publish request. It still does not bypass owner-gated live publication.

On this page

  • Create from custom source
  • Pull source
  • Validate and compare
  • Save staged changes
  • Preview and share
  • Request publication
  • One-command guarded deploy