Getting Started

Prerequisites

Make sure the following are installed on your development server:

• Git (2.20+) — with worktree support
• Rust toolchain — to build from source (or download a prebuilt binary)

Installation

From source

git clone https://github.com/fab-uleuh/NomadFlowCode.git
cd NomadFlowCode/nomadflow-rs
cargo build --release

The binary is at target/release/nomadflow. Copy it somewhere in your $PATH:

cp target/release/nomadflow ~/.local/bin/

Quick start

1. Initialize

nomadflow

On first run, NomadFlowCode launches a setup wizard (TUI) that creates ~/.nomadflowcode/config.toml. The wizard walks you through:

• Choosing or generating an auth password (secures your server)
• Optionally enabling a public tunnel with a stable subdomain

If a config already exists, it goes straight to the TUI home screen.

2. Link a project

nomadflow link /path/to/my-project

This creates a symlink in ~/.nomadflowcode/repos/ pointing to your existing repository. You can link as many projects as you want. Alternatively, use clone-repo via the API to clone a new repository.

3. Start the server

nomadflow serve

A QR code is displayed in the terminal along with your server URL and auth secret. For remote access from anywhere, use the public tunnel:

nomadflow serve --public

This creates a secure tunnel at https://<subdomain>.tunnel.nomadflowcode.dev — no VPN or port forwarding needed.

4. Connect from your phone

Scan the QR code from the NomadFlowCode app. That's it — you're connected.

The QR code encodes a deep link (nomadflowcode://add-server?url=...&secret=...) that the app handles automatically, so there's nothing to type.

You can also add a server manually: tap Add Server, enter the URL and auth secret, and save.

What's next?

• Concepts — understand the architecture
• Server Configuration — full config reference
• CLI Reference — all command-line options