Flanner

CLI Commands Reference

Complete reference for all Flanner CLI commands with examples and options.

Initialization & Setup

flanner init

Initialize Flanner in your project. Creates database, sets up project, and registers MCP server with Claude Code.

flanner init [--project-root PATH] [--plan-dir DIR] [--skip-claude]

Options:

  • --project-root PATH - Specify project root directory
  • --plan-dir DIR - Custom plan directory (default: .plans)
  • --skip-claude - Skip Claude Code integration

Example:

cd my-project flanner init

flanner status

Check Flanner status including database, projects, plan files, and Claude Code integration.

flanner status

Project Management

flanner list

List all projects or plan files for a specific project.

flanner list [--project PROJECT_NAME]

Examples:

# List all projects flanner list # List plan files for a project flanner list --project my-project

flanner config

Configure project settings.

flanner config PROJECT_NAME [OPTIONS]

Options:

  • --project-root PATH - Update project root
  • --plan-dir DIR - Update plan directory
  • --auto-gitignore BOOL - Enable/disable auto .gitignore updates

Example:

flanner config my-project --plan-dir docs/plans

flanner delete

Delete a project and all its plan files.

flanner delete PROJECT_NAME [--force]

Example:

flanner delete old-project --force

Plan File Operations

flanner sync

Sync existing plan files from .plans/ into database.

flanner sync [--project PROJECT_NAME] [--dry-run]

Options:

  • --project PROJECT_NAME - Sync specific project only
  • --dry-run - Preview without making changes

Examples:

# Preview sync for all projects flanner sync --dry-run # Actually sync all projects flanner sync # Sync specific project only flanner sync --project my-project

flanner setup-gitignore

Manually update .gitignore to exclude plan files.

flanner setup-gitignore PROJECT_NAME

Web Interface

flanner web

Launch the web interface for managing plans.

flanner web [--port PORT] [--host HOST] [--open-browser]

Options:

  • --port PORT - Custom port (default: 8080)
  • --host HOST - Custom host (default: 127.0.0.1)
  • --open-browser - Auto-open browser

Examples:

# Launch on default port 8080 flanner web # Launch and auto-open browser flanner web --open-browser # Custom port flanner web --port 3000 # Accessible from network flanner web --host 0.0.0.0 --port 8080

Claude Code Integration

flanner claude-info

Show detailed Claude Code integration status and configuration.

flanner claude-info

flanner register

Register MCP server with Claude Code.

flanner register [--force] [--type TYPE] [--url URL] [--api-key KEY]

Options:

  • --force - Force update configuration
  • --type local|cloud - Server type (default: local)
  • --url URL - Cloud server URL (for future use)
  • --api-key KEY - API key for cloud server

Examples:

# Register local MCP server flanner register # Force update configuration flanner register --force

flanner unregister

Unregister MCP server from Claude Code.

flanner unregister

JIRA Integration

flanner jira config

Configure JIRA settings for a project.

flanner jira config PROJECT_NAME --url URL --project-key KEY

Example:

flanner jira config my-project \ --url https://company.atlassian.net \ --project-key PROJ

Link a plan file to a JIRA issue.

flanner jira link PLAN_NAME --issue ISSUE_KEY [OPTIONS]

Options:

  • --issue ISSUE_KEY - JIRA issue key (e.g., PROJ-123)
  • --type TYPE - Issue type (Epic, Story, Task, etc.)
  • --notes NOTES - Additional notes
  • --project PROJECT - Project name (required)

Example:

flanner jira link architecture \ --issue PROJ-123 \ --type Epic \ --notes "Main architecture epic" \ --project my-project

flanner jira show

Show JIRA links for a plan file.

flanner jira show PLAN_NAME --project PROJECT_NAME

List all JIRA links.

flanner jira links [--project PROJECT_NAME]

Examples:

# List all JIRA links flanner jira links # List for specific project flanner jira links --project my-project

Unlink JIRA issues from a plan file.

flanner jira unlink PLAN_NAME [OPTIONS]

Options:

  • --issue ISSUE_KEY - Specific issue to unlink
  • --all - Unlink all issues
  • --project PROJECT - Project name (required)

Examples:

# Unlink specific issue flanner jira unlink architecture --issue PROJ-123 --project my-project # Unlink all issues flanner jira unlink architecture --all --project my-project

MCP Server

flanner start

Start MCP server (displays connection instructions).

flanner start [--port PORT]

flanner stop

Stop MCP server.

flanner stop

Getting Help

flanner --help

Show general help with list of all commands.

flanner --help

flanner COMMAND --help

Show detailed help for a specific command.

flanner init --help flanner sync --help flanner jira link --help

Quick Reference: Download the CLI Command Cheat Sheet for offline use.