Skip to main content
CLI

Easel CLI

Install and use the Easel CLI to authenticate, link projects, inspect deployments, and stream request logs.

The Easel CLI (easel) lets you authenticate from the terminal, link a local directory or monorepo to project(s), deploy from your working tree, list and inspect deployments, and read request logs. It is published as @easel-sh/cli and is currently in alpha.

Note: This is a preview feature currently under active development. Deploy uploads local source (or --prebuilt output) and builds on the platform. You can still deploy from Git or the dashboard.

Install

Install the CLI globally with npm, or run it with npx without a global install:

npm install -g @easel-sh/cli
npx @easel-sh/cli --help

The package exposes both easel and cli binaries. Examples in this guide use easel.

Check the installed version:

easel -V

Global options

These options apply to platform commands:

OptionDescription
-t, --token tokenAPI token (overrides EASEL_TOKEN and saved credentials)
-W, --workspace slug_or_idWorkspace slug or ID
-F, --format human_or_jsonOutput format (defaults to human in a TTY, json otherwise)
--no-colorDisable ANSI colors

Point the CLI at a different API host with EASEL_API_URL (defaults to https://app.easel.sh).

Next steps

On this page

Edit on GitHub