Flanner

Installation

Get Flanner up and running on your system in minutes.

Prerequisites

  • Python 3.8 or higher
  • pip (Python package manager)
  • Git (for repository integration)
  • Claude Code (optional, for MCP integration)

Quick Installation

Option 1: Install with pip (Recommended)

This allows you to run flanner from anywhere:

cd flanner pip install -e .

After installation, verify it works:

flanner --help

Option 2: Run without installation

You can run Flanner directly without installation:

# Windows cd path\to\flanner python -m src.cli --help # Linux/Mac cd path/to/flanner python -m src.cli --help

Platform-Specific Setup

Windows

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

Linux/Mac

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

Post-Installation

1. Initialize Flanner

Navigate to your project directory and initialize Flanner:

cd your-project flanner init

This will:

  • Create ~/.flanner/ directory for database
  • Detect your git repository root
  • Create .plans/ directory in your project
  • Update .gitignore to exclude plan files
  • Initialize SQLite database at ~/.flanner/data.db
  • Automatically register MCP server with Claude Code
  • Prompt you to create a project

2. Verify Installation

flanner status

You should see:

============================================================ MCP PLAN MANAGER STATUS ============================================================ Server Status: Stopped Database: C:\Users\YourName\.flanner\data.db Projects: 1 Total Plan Files: 0 ------------------------------------------------------------ CLAUDE CODE INTEGRATION ------------------------------------------------------------ Config Path: C:\Users\...\Claude\claude_desktop_config.json MCP Server: Registered & Valid

Claude Code Integration

The MCP server is automatically registered with Claude Code during flanner init!

Check Integration Status

flanner claude-info

Manual Registration (if needed)

# Register MCP server flanner register # Force update configuration flanner register --force # Unregister flanner unregister

Restart Claude Code

After registration, restart Claude Code to load the MCP server.

Database Location

The database is stored at:

  • Windows: C:\Users\YourName\.flanner\data.db
  • Linux/Mac: ~/.flanner/data.db

Plan Files Location

Plan files are stored in your project repository:

your-project/ ├── .git/ ├── .gitignore          # Auto-updated to exclude .plans/ ├── .plans/             # Your plan files (git-ignored) │   ├── architecture_v1.md │   ├── architecture_v2.md │   └── api-design_v1.md ├── src/ └── ...

Troubleshooting

Command not found

# Use Python module instead python -m src.cli --help # Or install properly pip install -e .

Database not initialized

flanner init

MCP server not registered

flanner register # Then restart Claude Code

Upgrading

If you installed with pip:

cd flanner git pull  # if using git pip install -e . --upgrade

Uninstallation

Remove Package

pip uninstall flanner

Remove Data

# Windows rmdir /s %USERPROFILE%\.flanner # Linux/Mac rm -rf ~/.flanner

Next: Check out the Quick Start Guide to create your first plan file.