User guide
Install dflow and open a hostname.
The command line for this product. The API is https://k8s.dflow.sh. The CLI does not read a kubeconfig.
Installation
The installer checks SHA-256 and writes ~/.local/bin/dflow.
Install the binary:
curl -fsSL https://github.com/dflow-sh/dflow/releases/latest/download/install.sh | shCheck the binary
dflow version prints the build. dflow upgrade --check prints the current and latest versions and does not download.
Account
Create an account
dflow auth:register --email EMAIL. The password is 12 to 128 characters and is typed at the prompt. Signup creates one personal workspace. The personal workspace is private and nobody else can join it.
Invite someone only after dflow workspaces:create.
Project and environment
dflow projects:create, then dflow environments:create, then dflow context:use --project PROJECT --environment ENVIRONMENT. Later commands use that pair.
Deploy
dflow apps:create, then dflow apps:deploy --image IMAGE. Read status from --output json and stop on failed.
Hostname
dflow apps:route:set with no --host asks for the platform hostname. dflow apps:route:show prints host.
The full session, in order, is From install to a URL.
Commands
| Section | What it covers |
|---|---|
| Install | The installer, version, and upgrade |
| Account | Sign in, sign out, and recover a password |
| Workspace | List, switch, and invite |
| Project | Projects, environments, and context |
| Applications | Build, logs, routes, variables, and secrets |
| Data | PostgreSQL, disks, tasks, and templates |
| Access | Workspace tokens and operations |
| API | The HTTP routes |
| MCP | The editor server and the skills |
Text errors are error: code: message. --output json is how an agent reads the result. The codes are on Exit codes. Names that are specified and not in the binary are on Not in this CLI yet.
How is this guide?
Last updated on