Flow documentation

Install Flow with confidence.

Choose Mac, Android preview, or CLI launch paths with clear prerequisites.

ZoneGaze Flow runs as a direct app on Mac, an Android preview path, or through the CLI for package users and contributors. The first job after install is simple: prove the local runtime is reachable before any agent work starts.

Install Readiness

Before installing or launching, confirm the environment can support a local Flow runtime:

  • The project you plan to open is a local repository or workspace you can review safely.
  • Git is installed for branch, diff, worktree, and review features.
  • Node.js 22 or newer is available when using the CLI/runtime path.
  • At least one supported coding agent is installed or configured.
  • Android installs have a compatible Termux build and Run Command permission available.
  • You know which local URL, app launchpad, or WebView should prove the runtime started.

Mac App

The Mac app is the primary desktop path. It provides a native launchpad for starting, attaching to, and inspecting the local runtime.

Mac launchpad showing runtime status

Watch the Mac launchpad clip

Typical Mac flow:

  1. Install and open ZoneGaze Flow.
  2. Use the launchpad to start or attach to the runtime.
  3. Open the web control surface from the launchpad.
  4. Add or select a project.
  5. Configure an agent if prompted.

Mac launch is ready when the launchpad shows the runtime as reachable and the board opens without recovery prompts.

Android App

The Android app provides a native setup dashboard and uses compatible Termux for the local runtime path.

Android home dashboard showing the next setup action

Typical Android flow:

  1. Install the ZoneGaze Flow APK.
  2. Install a compatible Termux build.
  3. Grant Run Command permission when prompted.
  4. Run the setup/update flow.
  5. Open the ZoneGaze Flow WebView after the runtime is ready.

The Android setup requires the native permission step before Termux can run the app-guided commands.

Android Run Command permission prompt

Current Android media shows the native Home, Permissions, Termux, Ports, setup-complete, runtime-running, and WebView board states.

Android Termux setup complete

Watch the Android setup and runtime workflow

Android runtime running

Android WebView board

CLI

The CLI path is useful for package users, contributors, and automation environments.

npx zonegaze-flow

or:

npm install -g zonegaze-flow
zonegaze-flow

After launch, open the local URL shown by the command or by the desktop launchpad.

Requirements

  • Node.js 22 or newer for the CLI/runtime path.
  • Git for worktree, branch, diff, and review features.
  • At least one supported coding agent installed or configured.
  • For Android, a compatible Termux installation with Run Command permission.

Platform Evidence

The current website media supports these install and launch paths:

PlatformEvidenceWhat It Proves
Maclaunchpad screenshot and runtime videoThe desktop shell can show runtime status and open the local board.
AndroidHome, permission, Termux, setup-complete, runtime-running, and WebView screenshotsThe Android 16 emulator path can complete setup, start the runtime on port 3484, and load the board.
CLIcommand examples and shared runtime requirementsPackage users and contributors can start from the terminal when runtime dependencies are present.

For the full evidence inventory, read Media status.

Launch Verification

After installation, verify launch before starting agent work:

  1. Open the board from the Mac launchpad, Android WebView, or CLI URL.
  2. Confirm the selected project is the intended local workspace.
  3. Check that runtime status is reachable and not stuck in a disconnected state.
  4. Open Settings and confirm the agent you plan to use is configured.
  5. Create only a small first task, then use Getting started for the first reviewed loop.

If launch, setup, Termux, project, agent, or Git state does not look right, use Troubleshooting before continuing.

Install Routes

  • Platform notes for Mac, Android, web, and CLI behavior.
  • Troubleshooting for blocked launch, runtime, Termux, terminal, and Git states.
  • Media status for what the current screenshots and videos prove.
  • Support for install, setup, runtime, or Android preview questions.

After Install

Continue with Getting started.

Leave with a concrete next action.

Each doc page should end with a command, route, verification step, screenshot, or support packet users can act on.

Do not strand the reader.

Link to the next workflow page, install guide, troubleshooting, demos, downloads, or support depending on the page topic.