@monolayer/cli
v1.0.4
Published
monolayer CLI
Readme
Monolayer CLI
Command-line interface for Monolayer control plane operations.
Documentation: https://monolayer.dev/docs/cli/overview
Current command surface:
projects:listdeployments:deploy
Install
npm install -g @monolayer/cliOr run without global install:
npx @monolayer/cli@latest --helpQuick 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 10Trigger a deployment:
export MONOLAYER_DEPLOYMENT_TOKEN="deploy_token_xxx"
mnlyr deployments:deploy --project-id proj-1 --branch-name mainConfiguration
Base URL:
--base-urlMONOLAYER_BASE_URL
Auth token (projects:list):
--auth-tokenMONOLAYER_AUTH_TOKEN
Deployment token (deployments:deploy):
--auth-tokenMONOLAYER_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 10deployments: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/orbranch/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 mainHelp
mnlyr --help
mnlyr projects:list --help
mnlyr deployments:deploy --helpContributing
For maintainer and development workflow details, see DEVELOPMENT_GUIDE.md.
License
MIT
