CLI
The edge CLI lets you manage all Simplifyd Cloud resources from your terminal.
The edge CLI is the command-line interface for Simplifyd Cloud. It mirrors every operation available in the web dashboard and is designed for both interactive development and automated CI/CD pipelines.
Installation
brew install simplifyd-systems/tap/edgeMacOS and Linux
Run the following command in your terminal to install the Simplifyd CLI application:
curl https://simplifyd.com/install.sh | shYou can view what actions the script takes here.
- Download the latest Edge CLI executable file here. Make sure to choose the version that applies to your system architecture.
- Extract the zip archive.
- Move
edge.exeto a folder in your systemPATH, or run it with the full path, such asc:\path\to\cli\edge.exe.
Authentication
Log in interactively:
edge auth loginYou will be prompted for your email and password. Your session token is stored in ~/.simplifyd/config.json.
Token-based authentication
For non-interactive environments (CI/CD, scripts), use a token instead:
| Priority | Source | How to set |
|---|---|---|
| 1 (highest) | --token flag | edge --token <token> workspace list |
| 2 | CLOUD_TOKEN env var | export CLOUD_TOKEN=<token> |
| 3 | ~/.simplifyd/config.json | Set by edge auth login |
The CLI picks the first token it finds in this order. This lets you override the stored token on a per-command basis without touching your config file.
Context resolution
Most commands need a workspace, project, and environment to know what to operate on. The CLI resolves context in this order:
- Explicit flags —
--workspace/-w,--project/-p,--env/-e .edge.jsonlink file — created byedge linkin your project directory (walks up the directory tree)- Global config —
active_workspace,active_project,active_envset byedge workspace use,edge project use,edge env use
If required context is missing, the CLI prints an actionable error:
no workspace set — use --workspace/-w, run `edge link`, or `edge workspace use <slug>`Global flags
These flags are available on every command:
| Flag | Short | Description |
|---|---|---|
--workspace | -w | Workspace slug |
--project | -p | Project slug |
--env | -e | Environment slug |
--json | Output as JSON (machine-readable) | |
--token | API token (overrides config and CLOUD_TOKEN) | |
--api-url | Override the default API base URL |
Available commands
Authentication
| Command | Description |
|---|---|
edge auth login | Log in to Simplifyd Cloud |
edge auth logout | Remove stored credentials |
edge auth whoami | Print the authenticated user |
Workspace management
| Command | Description |
|---|---|
edge workspace list | List all workspaces |
edge workspace create | Create a workspace |
edge workspace use | Set the active workspace |
edge workspace usage | Show resource usage |
edge workspace members | Manage workspace members |
Project management
| Command | Description |
|---|---|
edge project list | List projects in the active workspace |
edge project create | Create a project |
edge project use | Set the active project |
Environments
| Command | Description |
|---|---|
edge env list | List environments in the active project |
edge env create | Create an environment |
edge env use | Set the active environment |
Services
| Command | Description |
|---|---|
edge service list | List services |
edge service create | Create a service |
edge service get | Get service details |
edge service update | Update a service |
edge service changeset | Review, approve, or discard staged service changes |
edge service delete | Delete a service |
edge service ingress add | Add an ingress rule |
edge service ingress delete | Remove an ingress rule |
edge service shell | Open a shell in a running Docker service |
edge service config | Manage config file mounts |
Deployments
| Command | Description |
|---|---|
edge deploy up | Deploy or redeploy a service |
edge deploy down | Stop a running service |
edge deploy list | List deployments for a service |
edge deploy logs | Stream live deployment logs |
Variables
| Command | Description |
|---|---|
edge variables list | List variables |
edge variables set | Set one or more variables |
edge variables delete | Delete a variable |
Tokens
| Command | Description |
|---|---|
edge token list | List API tokens |
edge token create | Create an API token |
edge token delete | Delete an API token |
Registry
| Command | Description |
|---|---|
edge registry push | Push a Docker image to the workspace registry |
Videos
| Command | Description |
|---|---|
edge video upload | Upload a video to a video library |
edge video list | List the videos in a library |
edge video get | Show one video in full |
edge video embed | Print the snippet to put a video on a page |
edge video stats | Show how a video is being watched |
edge video captions | Add or remove caption tracks |
edge video poster | Choose the frame shown before playback |
edge video reprocess | Prepare a video again from the original |
edge video rm | Delete a video and everything made from it |
Context & utilities
| Command | Description |
|---|---|
edge link | Pin a directory to a workspace/project/env |
edge status | Show resolved context and auth state |