Getting Started

FlowForge is a desktop Git client built with Tauri. It provides a visual interface for everyday Git operations with first-class Gitflow support.

Download

Grab the latest release for your platform from the Download page. Pre-built binaries are available for macOS, Windows, and Linux.

Building from Source

Prerequisites

• Node.js 22 or later
• Rust (stable toolchain)
• Git installed and available on your PATH
• A platform supported by Tauri (macOS, Windows, or Linux)

Installation

Clone the repository and install dependencies:

git clone https://github.com/Atypical-Consulting/FlowForge.git
cd FlowForge
npm install

Running in Development

Start the Tauri development server:

npm run tauri dev

This launches both the Vite frontend dev server and the Tauri native window. Changes to React components are hot-reloaded automatically.

Building for Production

Create a release build:

npm run tauri build

The output binary is placed in src-tauri/target/release/.

Opening Your First Repository

1. Launch FlowForge.
2. Press Cmd/Ctrl+O or click Open Repository on the welcome screen.
3. Select a folder containing a Git repository.
4. FlowForge loads the repository status, branches, and commit history.

If you select a folder that is not yet a Git repository, FlowForge offers to initialize one for you — complete with .gitignore template selection and an optional first commit.

If the repository has not been initialized with Gitflow, navigate to the Gitflow panel and click Initialize Gitflow to set up the standard branch structure.

Next Steps

• Learn about Gitflow workflows for managing features, releases, and hotfixes.
• Explore staging and commits for day-to-day changes.
• Set up a new project with Repository Initialization.
• Read about GitFlow, Conventional Commits, and Blade Navigation concepts.
• See all available keyboard shortcuts for fast navigation.