Documentation

Everything you need to get started with Flanner - the AI-powered plan file management system

Installation

Get up and running

Quick Start

Initialize your first project

CLI Commands

Command reference

Installation

Prerequisites

Python 3.8 or higher
Git installed and initialized in your project
Claude Code installed (optional, for MCP integration)

Step 1: Clone or Download

git clone https://github.com/yourusername/flanner.git
cd flanner

Step 2: Install Dependencies

Windows:

python -m venv venv
venv\Scripts\activate
pip install -r requirements.txt

Linux/Mac:

python -m venv venv
source venv/bin/activate
pip install -r requirements.txt

Step 3: Install Flanner Command

Install Flanner globally to use the flanner command from anywhere:

pip install -e .

Quick Start

Navigate to Your Project

Make sure you're in a git repository:

cd your-project
git init  # if not already initialized

Initialize Flanner

Run the init command to set up everything:

flanner init

This command will:

Create the database at ~/.flanners/data.db
Detect your git repository root
Create .plans/ directory for plan files
Update .gitignore to exclude plan files
Automatically register with Claude Code

Verify Installation

Check that everything is working:

flanner status

Start Using with Claude

Restart Claude Code and ask Claude to manage your plan files:

"Claude, create a new architecture plan for our project"

"Claude, show me the history of the architecture plan"

"Claude, list all plan files"

CLI Commands

Core Commands

flanner init

Initialize Flanner in your project

flanner status

Check server status and project information

flanner list

List all projects

flanner list --project PROJECT_NAME

List plan files for a specific project

Plan File Management

flanner sync

Sync existing plan files into database

flanner sync --dry-run

Preview sync without making changes

flanner sync --project PROJECT_NAME

Sync specific project only

Web Interface

flanner web

Launch web UI on default port (8080)

flanner web --open-browser

Launch and auto-open browser

flanner web --port 3000

Launch on custom port

Claude Code Integration

flanner claude-info

Show integration status

flanner register

flanner register --force

Force update configuration

flanner unregister

Unregister from Claude Code

Project Configuration

flanner config PROJECT_NAME --plan-dir DIR

Configure project settings

flanner setup-gitignore PROJECT_NAME

Update .gitignore manually

Plan File Format

All plan files managed by Flanner include YAML frontmatter with metadata:

---
mcp_plan_file: true
plan_manager_version: '1.0'
project_id: 3d816ecd-489a-4fa0-abe2-15ec93f60d5a
project_name: my-app
plan_file_id: 59c34f9c-8471-47fc-97f2-8dcfefa15434
plan_name: architecture
version: 2
created_at: 2025-01-15T10:30:00Z
created_by: claude
---

# Architecture Plan

Your plan content here...

Web Interface

Launch the Web UI

flanner web --open-browser

Access at: http://localhost:8080

Features

Dashboard

Overview of all projects with statistics

Project Management

Create and manage projects

Markdown Preview

Beautiful rendering with syntax highlighting

Version History

Timeline view of all changes

Plan Editor

Edit plans with live preview

Responsive Design

Works on all devices

Claude Code Integration

Automatic Registration

Flanner automatically registers with Claude Code during initialization. No manual configuration needed!

flanner claude-info # Check integration status

Manual Registration

If needed, you can manually register or update:

flanner register

flanner register --force # Force update

flanner unregister # Unregister

Ready to get started?

Install Flanner and start managing your plan files with AI assistance