Monolayer CLI

Command-line interface for Monolayer control plane operations.

Documentation: https://monolayer.dev/docs/cli/overview

Current command surface:

• projects:list
• projects:branch-tracking:get
• projects:branch-tracking:set
• projects:branch-tracking:delete
• deployments:deploy
• env:list
• env:set
• env:delete

Install

npm install -g @monolayer/cli

Or run without global install:

npx @monolayer/cli@latest --help

Quick Start

Set your control plane URL:

export MONOLAYER_BASE_URL="https://control-plane-domain"

List projects:

export MONOLAYER_AUTH_TOKEN="token_xxx"
mnlyr projects:list --limit 10

Trigger a deployment:

export MONOLAYER_DEPLOYMENT_TOKEN="deploy_token_xxx"
mnlyr deployments:deploy --project-id proj-1 --branch-name main

Configuration

Base URL:

• --base-url
• MONOLAYER_BASE_URL

Auth token (projects:list):

• --auth-token
• MONOLAYER_AUTH_TOKEN

Deployment token (deployments:deploy):

• --auth-token
• MONOLAYER_DEPLOYMENT_TOKEN
• must start with deploy_token_

Commands

projects:list

Lists projects with cursor-based pagination.

Flags:

• --base-url <url>
• --auth-token <token>
• --cursor <cursor>
• --limit <n> (default: 50)

Output:

• JSON to stdout

Example:

mnlyr projects:list --base-url https://control-plane-domain --auth-token token_xxx --limit 10

projects:branch-tracking:get

Gets branch tracking rules for a project.

Flags:

• --base-url <url>
• --auth-token <deploy_token_...>
• --project-id <id> (required)

Output:

• JSON to stdout

Example:

mnlyr projects:branch-tracking:get --base-url https://control-plane-domain --auth-token deploy_token_xxx --project-id proj-1

projects:branch-tracking:set

Creates or updates a branch tracking rule for the project.

Flags:

• --base-url <url>
• --auth-token <deploy_token_...>
• --project-id <id> (required)
• --branch <branch> (required; e.g. production, preview, or a custom branch)
• --enabled / --no-enabled (required)

Output:

• JSON to stdout

Example:

mnlyr projects:branch-tracking:set --base-url https://control-plane-domain --auth-token deploy_token_xxx --project-id proj-1 --branch production --enabled

projects:branch-tracking:delete

Deletes a custom branch tracking rule from the project. Deleting production or preview rules has no effect.

Flags:

• --base-url <url>
• --auth-token <deploy_token_...>
• --project-id <id> (required)
• --branch <branch> (required; key of the custom rule to delete)

Output:

• JSON to stdout

Example:

mnlyr projects:branch-tracking:delete --base-url https://control-plane-domain --auth-token deploy_token_xxx --project-id proj-1 --branch feature-test

deployments:deploy

Triggers a deployment and streams status/log updates.

Flags:

• --base-url <url>
• --auth-token <deploy_token_...>
• --project-id <id> (required)
• --branch-name <name> (optional; defaults to current git branch)
• --poll-interval-ms <n> (default: 2000)

Behavior:

• rejects branch names with refs/heads/ or branch/ prefixes
• uses incremental polling (x-next-since)
• suppresses blank log lines
• exits non-zero when deployment reaches Failed

Example:

mnlyr deployments:deploy \
  --base-url https://control-plane-domain \
  --auth-token deploy_token_xxx \
  --project-id proj-1 \
  --branch-name main

env:list

Lists project environment variables.

Flags:

• --base-url <url>
• --auth-token <deploy_token_...>
• --project-id <id> (required)

Output:

• JSON to stdout

Example:

mnlyr env:list --base-url https://control-plane-domain --auth-token deploy_token_xxx --project-id proj-1

env:set

Creates or updates an environment variable for the project.

Flags:

• --base-url <url>
• --auth-token <deploy_token_...>
• --project-id <id> (required)
• --key <name> (required)
• --value <val> (required)
• --environment <env> (required; e.g. production, preview, all)

Output:

• JSON to stdout

Example:

mnlyr env:set --base-url https://control-plane-domain --auth-token deploy_token_xxx --project-id proj-1 --key API_KEY --value secret --environment production

env:delete

Deletes an environment variable from the project.

Flags:

• --base-url <url>
• --auth-token <deploy_token_...>
• --project-id <id> (required)
• --name <name> (required; key of the environment variable)
• --environment <env> (required)

Output:

• JSON to stdout

Example:

mnlyr env:delete --base-url https://control-plane-domain --auth-token deploy_token_xxx --project-id proj-1 --name API_KEY --environment production

Help

mnlyr --help
mnlyr projects:list --help
mnlyr projects:branch-tracking:get --help
mnlyr projects:branch-tracking:set --help
mnlyr projects:branch-tracking:delete --help
mnlyr deployments:deploy --help
mnlyr env:list --help
mnlyr env:set --help
mnlyr env:delete --help

Contributing

For maintainer and development workflow details, see DEVELOPMENT_GUIDE.md.

License

MIT