Skip to Content
dFlow

From install to a URL

Install dflow, create an account, and open the application hostname.

You start with a machine and no account. You finish when the application has a hostname.

Install

The installer checks SHA-256 and writes ~/.local/bin/dflow.

curl -fsSL https://github.com/dflow-sh/dflow/releases/latest/download/install.sh | sh

See what you installed

Run dflow version. Then run dflow upgrade --check. --check prints the current and latest versions and does not download.

Open an account

Run dflow auth:register --email EMAIL. The password is 12 to 128 characters and is typed at the prompt. The CLI prints a password must be 12 to 128 characters, then Password: and Re-enter password:.

Signup creates one personal workspace. The personal workspace is private and nobody else can join it.

Invite someone

Create another workspace first with dflow workspaces:create. An invite into the personal workspace is refused with a personal workspace is private. A personal workspace can still hold a project.

Choose where the app lives

Create a project with dflow projects:create in the workspace you intend to use.

Create an environment with dflow environments:create in that project.

Select that pair with dflow context:use --project PROJECT --environment ENVIRONMENT. Later commands use that pair.

Deploy

Create the application with dflow apps:create, then deploy an image with dflow apps:deploy --image IMAGE. Read status from --output json and stop on failed.

Ask for the hostname

Request the platform hostname with dflow apps:route:set and no --host. Leave the host off unless you already have a domain of your own.

Read a failure

Text errors are error: code: message. --output json is how an agent reads the result. An agent reads request_id from that JSON. Text mode does not print a request id unless DFLOW_DEBUG=1.

How is this guide?

Last updated on

On this page