CLI
Overview
The @monolayer/cli includes the monolayer command-line interface (CLI), which helps you manage your projects and deployments seamlessly.
Available commands
The Monolayer CLI currently supports the following commands:
| Command | Description | Output |
|---|---|---|
projects:list | Lists your projects using cursor-based pagination. | JSON |
deployments:deploy | Triggers a branch deployment and monitors its progress. | Logs and status |
Quick reference
To get started quickly, you can run these commands directly from your terminal.
List your projects
MONOLAYER_BASE_URL="https://control-plane-domain" \
MONOLAYER_AUTH_TOKEN="token_xxx" \
npx mnlyr projects:list --limit 5Trigger a deployment
MONOLAYER_BASE_URL="https://control-plane-domain" \
MONOLAYER_DEPLOYMENT_TOKEN="deploy_token_xxx" \
npx mnlyr deployments:deploy --project-id proj-1 --branch-name mainLearn more
Explore the following topics to get the most out of the Monolayer CLI:
- Installation: Set up the CLI package in your environment.
- Authentication and Configuration: Securely connect to your control plane.
- CLI Reference: Detailed guides for each command.