Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Introduction

Welcome to the Flow Book - the official documentation for Flow, a developer-first note-taking tool.

Thoughts captured. Focus unbroken.

What is Flow?

Flow is an outliner-first note-taking application with object-based notes designed for developers. It stays out of your way, letting you capture thoughts without breaking your concentration.

# Capture a thought without leaving your terminal
flow capture "Research CRDT sync options for offline-first #idea"

# Done. Back to work.

Philosophy

Flow is built on principles that put you in control:

  1. Local-First - Your data belongs to you, stored on your machine
  2. Plain Text - Markdown files you can read in any editor
  3. No Lock-In - Your notes are just files, take them anywhere
  4. Outliner-First - Organize thoughts hierarchically, add prose when needed
  5. Developer-Friendly - Built for terminal workflows and automation
  6. Progressive Enhancement - Start simple, add complexity as needed

Components

Flow is modular - use what you need:

ComponentDescription
CLIQuick capture and search from your terminal
TUIFull-featured terminal interface for browsing and editing
GUINative desktop application for longer sessions
ServerSelf-hosted sync server for multi-device access

Project Status

⚠️ Flow is in early development. The core architecture is being built, and features are being actively developed. This documentation will evolve alongside the project.

Getting Started

Ready to dive in? Head to the Installation guide to get started.