CLI
CLI Overview
Use the Enclavely CLI to manage projects, releases, and operations.
The Enclavely CLI covers the full user workflow: project setup, deploys, release inspection, routing, usage, and audit checks.
Install
Install the CLI globally via npm:
npm install -g enclavelyVerify the installation:
enclavely --versionAuthenticate
Log in to your Enclavely instance:
enclavely auth login --token <your-api-key> --api-url https://your-enclavely-instance.comIf you omit the flags, the CLI will prompt you interactively for your API key and instance URL.
Credentials are stored locally in ~/.config/enclavely/config.json. All subsequent commands read this file automatically. Keep it secure and do not commit it to version control.
Key concepts
- Single binary -- one tool for project, environment, deploy, and ops tasks.
- Role and scope aware -- org role + API key permissions are enforced on every command.
- JSON-first automation -- operational commands support
--jsonfor CI. - Local auth config -- saved to
~/.config/enclavely/config.json.
Typical workflow
A standard workflow looks like this:
# 1. Create a project and environment
enclavely project create payments-service
enclavely env create payments-service development
# 2. Initialize your service directory
enclavely init --name payments-service
# 3. Validate config
enclavely build
# 4. Deploy
enclavely deploy --project payments-service --env development --image-digest sha256:<...> --wait
# 5. Check status
enclavely status --project payments-service --env developmentNext steps
- Command Reference -- complete reference for every CLI command and flag
- Deploy Workflow -- end-to-end walkthrough of what happens when you run
enclavely deploy