CLI

The Getme CLI is the official terminal tool for developer workflows. Use it to authenticate, inspect API resources, sync website source, validate local changes, create previews, and request owner-gated publishes.

Installation

npm install -g @getme-tech/cli

The CLI requires Node.js 20 or newer.

Source code: github.com/getme-tech/getme-cli

First commands

getme auth login --browser
getme auth status
getme products list
getme sites list

For CI or server automation, authenticate with an app-install access token:

getme auth login --api-key gmat_test_...

Keep gmat_* tokens on trusted machines only. Do not commit them, print them in CI logs, or place them in browser-visible code.

Website source workflow

The CLI is designed for safe website development:

getme sites init --name "Custom storefront"
getme sites create --name "Custom storefront"
# Or begin from an existing site:
getme sites pull --site site_...
getme sites check
getme sites push
getme sites preview
getme sites publish-request --message "Ready for review"

sites push saves changes to a development session. It does not publish the live site. sites preview creates a preview for staged changes. sites publish-request creates a request that must be approved and applied in Getme.

For the full guarded flow:

getme sites deploy --message "Homepage update"

sites deploy validates local files, syncs the development session, refreshes a preview, and creates the publish request. Final live publish remains owner-gated.

sites create is the source-first path. It creates a validated standalone draft without requiring a prior live site or base-theme selection.

Common commands

Authentication:

getme auth login --browser
getme auth login --api-key gmat_test_...
getme auth status
getme auth logout
getme auth profiles
getme auth profiles use --profile staging

Commerce:

getme products list
getme products get --product prod_...
getme products create --data '{"name":"Coffee","sku":"COF-001"}'
getme products update --product prod_... --data '{"status":"active"}'
getme products archive --product prod_...
getme categories list --type product
getme brands list
getme services list

Webhooks:

getme webhooks events
getme webhooks trigger --forward-to http://localhost:3000/webhooks --event website.published
getme webhooks listen --forward-to http://localhost:3000/webhooks --port 4242 --secret whsec_...

Utilities:

getme completion bash
getme open --browser
getme config list
getme update check

Global flags

--help, -h
--version, -v
--json
--quiet, -q
--no-color

Use --json for scripts and CI. Use --quiet to reduce non-essential output. The CLI respects NO_COLOR=1.

Configuration precedence

Flags take precedence over environment variables, which take precedence over saved config and defaults.

GETME_API_KEY=...
GETME_API_BASE_URL=https://api.getmeonline.io/v1
GETME_PROFILE=default
GETME_CONFIG_DIR=/custom/config/dir
GETME_DEVELOPER_PORTAL_URL=https://developers.getmeonline.io
NO_COLOR=1

Local project files

After sites pull, the CLI stores project metadata locally:

.getme/
  project.json
  manifest.json
.getmeignore

Project files contain public site, session, revision, and source selection metadata. Raw auth tokens are not stored in project files.