Quick start
Go from zero to a running deployment in five minutes.
This guide walks you through installing the edge CLI, logging in, and deploying your first service.
1. Install the CLI
brew install simplifyd-systems/tap/edgeMacOS and Linux
Run the following command in your terminal to install the Simplifyd CLI application:
curl https://raw.githubusercontent.com/simplifyd-systems/cli/master/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.
- Copy the executable file
edge.exepreferably to a folder in your system's $PATH variable. This ensures you can simply runedge.exein terminal from any directory. If you don't copy the executable to a folder or directory that's in your system's $PATH variable, then remember to always use the full path to the executable whenever you run it, for example:c:\path\to\cli\edge.exeassuming the executable was copied to thec:\path\to\clidirectory.
Verify the installation:
edge version2. Log in
edge auth loginYou will be prompted for your email and password. The token is saved to ~/.simplifyd/config.json and reused automatically for every subsequent command.
For CI/CD pipelines, skip interactive login and pass a token via an environment variable instead:
export CLOUD_TOKEN=<your-token>3. Set your context
Select the workspace, project, and environment you want to work with:
edge workspace use my-workspace
edge project use my-project
edge env use productionOr, if you work from a specific directory, run edge link once to pin the context to that directory tree:
cd ~/code/my-app
edge linkFrom that point on, every edge command run inside ~/code/my-app (or any subdirectory) will automatically target the linked workspace, project, and environment.
4. Deploy a service
Create a service and deploy it:
# Create a Docker service
edge service create --name api --type docker --image nginx --tag latest
# Deploy it
edge deploy up apiWatch the live logs:
edge deploy logs api --follow5. Add environment variables
edge variables set DATABASE_URL=postgres://... API_KEY=secret123
