Skip to main content

Installation

The CLI ships as @unlayer/cli on npm. The binary is unlayer.

Requirements​

RequirementVersion
Node.js>= 20

The CLI is published as ESM. Older Node versions aren't supported.

Install Globally​

npm install -g @unlayer/cli
# or
pnpm add -g @unlayer/cli
# or
yarn global add @unlayer/cli

After install, the unlayer binary is on your PATH:

unlayer --version
# 0.1.0

Run Without Installing​

For a one-off invocation, use npx:

npx @unlayer/cli login
npx @unlayer/cli template list

This pulls the latest published version each time.

Verify the Install​

unlayer --version
# 0.1.0

unlayer status

unlayer status reports authentication state, API reachability and latency, the active workspace and project IDs, and the path to your config file. It works without authentication, which makes it useful as the first command to run when something is off.

Update Notifications​

The CLI checks for a newer version in the background once per day and prints a notification on exit when an update is available:

Update available 0.1.0 → 0.2.0
Run npm i -g @unlayer/cli to update

What's Next​