User Interface

Manage workflows, artifacts, shells, and the agent from the dxflow web console

The console is the engine's web interface: the same workflows, files, shells, and agent sessions the CLI and API reach, in a browser.

Prerequisites

The engine must be running with the console served. --console serves it and auto-enables HTTP:

sudo dxflow boot up --console
The console listens on port 80 by default, and ports below 1024 are privileged — hence sudo. To run unprivileged, set a higher port (dxflow config set http-port 8080). See Port Binding.

The Console section of the boot report names the address to open:

Engine successfully booted (use 'CTRL+C' to stop)
● Server
  Socket       ~/.dxflow/unix.sock
  HTTP         http://127.0.0.1:80  (bound to 0.0.0.0)
● Console
  Address      http://127.0.0.1:80  (open in a browser)

Interface overview

The dxflow interface is organized into three explorer sections — Workflows, Artifacts, and Shells — plus an Agent panel, each providing specialized functionality:

Workflows

Create workflows from a YAML definition or the hub

  • Execution diagram with per-step status
  • Live logs and resource usage
  • Start, stop, and remove from the node menu

Artifacts

A file manager for the engine volume

  • Upload, download, and organize directories
  • Edit text files in the browser
  • Zip and unzip archives

Shells

A terminal on the engine host

  • Multiple concurrent sessions
  • The host's default shell
  • Or a shell inside a running workflow step

Agent

A conversation that builds and runs workflows

  • Plain-language prompts
  • Live view of the actions it takes
  • Sessions that keep their history

Getting started

Start the engine

sudo dxflow boot up --console

Open the console

  • Local: http://localhost
  • Remote: http://<your-server-ip>

Sign in

Choose a method in the sign-in dialog:

  • Private key — pick a session duration (1 hour or 24 hours) and select your .pem or .key file. The key stays on your device, so the next sign-in is a single click, and Sign out & forget key clears it.
  • Pairing code — run dxflow engine pair on the engine host, enter the code it prints, and approve the request on that terminal. Nothing is kept in the browser, so each session repeats the flow.

The menu bar shows when the session expires; once it does, the sign-in dialog returns.

Access control

  • Key-based authentication: sign in with an RSA key pair; multiple authorized keys can be registered on one engine
  • Pairing codes: sign a browser in from the engine host with a single use code, scoped by dxflow engine pair --permissions
  • Per-key permissions: grant any of SHELL, ARTIFACT, RUNTIME, WORKFLOW, AGENT
  • Read-only mode: restrict a key to non-mutating operations
  • Master permission: full administrative access, including key management and engine restart

The interface is built around a top menu bar, a collapsible explorer sidebar, a tabbed pane workspace, a right-hand agent panel, and a status bar along the bottom:

Three dropdown menus across the top of the window:

  • dxflow — Engine Monitor, Engine License, and a Documentation link
  • View — switch between Light/Dark theme and set the Interface Scale
  • Resources — New workflow, New Artifact, and New shell

The right side of the bar shows when your session expires, with a button to sign out.

Quick actions

Engine Monitor

Monitor System Health (dxflow → Engine Monitor)

  • Host information and engine status
  • CPU, Memory, Disk, and Network stat cards with sparklines and peak values
  • The Network card headlines the download rate and labels the upload rate below it

Create Workflow

Run a Workflow (Resources → New workflow)

  • Upload a YAML (Docker Compose-style) definition, or deploy a hub template
  • Inspect the diagram and live logs
  • Start, stop, and remove from the node menu

Manage Artifacts

Handle Files

  • Upload and download files
  • Organize with directories
  • Zip / unzip and edit in the browser

Interface customization

Theme options

The View menu offers a single theme toggle that switches between Light Theme and Dark Theme (the system preference is used as the initial default). The palette is fixed — iris primary, azure secondary, zinc neutral.

Interface scale

The View → Interface Scale submenu sets the overall UI scale, with a check marking the active option. Your choice persists across reloads:

  • Small · 100%
  • Medium · 125%
  • Large · 150%

Keyboard shortcuts

ShortcutWhereAction
EnterRename fieldCommit the new name
EscRename fieldCancel the rename
Ctrl / Cmd + SArtifact editorSave the file
TabArtifact editorInsert 4 spaces
EnterAgent promptSend the message
Shift + EnterAgent promptStart a new line

Small screens

Below 768px the console focuses on browsing workflows and artifacts:

  • The sidebar covers the window and closes as soon as you open an item
  • The Workflows and Artifacts sections stay available, and diagrams and files fill the main pane
  • Workflow logs, shells, the agent panel, and the Interface Scale submenu run on wider screens

Browser compatibility

Works in any modern browser with WebSocket and ES6 support — Chrome/Edge 80+, Firefox 75+, Safari 13+, and their mobile equivalents.

Troubleshooting

ProblemCheck
Console won't loadIs the engine running (dxflow ping)? Does the firewall allow the port? Is the address right?
Stuck on the sign-in dialogEvery HTTP connection authenticates. Pairing codes are single-use and expire after 30 seconds — run dxflow engine pair again.
Sign-in rejects the keyThe .pem you selected must be the private half of a key authorized on the engine. Check with dxflow key list, and see Authorized Key.
API answers but nothing rendersHard-refresh the browser (Ctrl / Cmd + Shift + R).
Logs or shells never connectThose views use WebSockets — check that a proxy in front of the engine forwards upgrade requests.
Session expired mid-useThe menu bar shows the expiry. Sign in again, or register a key for a renewable session.

For more, see Troubleshooting.