Interactive planning session manager with SQLite persistence and artifact export
Project description
planner-auto
Automated planning session manager that produces milestone plans through interactive conversation with Claude, reviewed by GPT for quality. Plans are persisted in SQLite and exported as markdown artifacts ready for orchestrator-auto to implement.
How It Works
You describe a feature
→ Claude asks clarifying questions
→ Claude generates a milestone plan
→ GPT reviews and critiques
→ Claude revises based on feedback
→ Repeat until GPT says GO
→ Plan exported for orchestrator-auto
Each session follows a strict lifecycle: SETUP → CONTEXT → DISCUSSION → PLANNING → REVIEW → COMPLETE. All state lives in SQLite. File artifacts (plans, reviews, chat logs) are exported views, not source of truth.
Installation
cd planner-auto/
pip install -e . # Production
pip install -e ".[dev]" # With pytest
pip install -e ".[tui]" # With TUI dashboard (textual)
# Required
export ANTHROPIC_API_KEY="your-key" # For Claude (planner)
# OR
export CLAUDE_CODE_OAUTH_TOKEN="token" # Claude Pro/Max subscription
# Required for Plan 2 (reviewer)
export OPENAI_API_KEY="your-key" # For GPT-5.4 (reviewer)
Quick Start
# Start a session
planner-auto start --project my-api
# Add context files
planner-auto add-context <session-id> --file src/app.py
planner-auto add-context <session-id> --file src/models.py
planner-auto add-context <session-id> --note "Uses PostgreSQL, deployed on AWS"
# Discuss the feature (interactive mode)
planner-auto discuss <session-id> --interactive
# Type your feature description, Claude asks questions
# Type /done when ready to move to planning
# Or one-shot discuss with auto-advance
planner-auto discuss <session-id> "Add user registration with email validation" --done
# Generate the plan
planner-auto generate <session-id>
planner-auto generate <session-id> --model claude-opus-4-6 # Override model
# Export artifacts
planner-auto export <session-id>
planner-auto export <session-id> --output-dir ./my-plans/
# Complete the session
planner-auto complete <session-id>
CLI Reference
Session Commands (Plan 1)
| Command | Description |
|---|---|
start --project <name> |
Create a new planning session |
add-context <id> --file <path> |
Add a file to session context |
add-context <id> --note "text" |
Add a text note to session context |
discuss <id> "message" |
Send a single discussion message |
discuss <id> --interactive |
Enter interactive discussion mode (type /done to advance) |
discuss <id> "message" --done |
Send message and advance to PLANNING |
generate <id> |
Generate milestone plan from context + conversation |
generate <id> --model <model> |
Generate with a specific Claude model |
list |
List all sessions |
list --status active |
Filter sessions by status |
status <id> |
Show session details (phase, counts, blockers) |
resume <id> |
Resume a paused session (answer open blockers) |
export <id> |
Export session artifacts to disk |
export <id> --output-dir <path> |
Export to custom directory |
complete <id> |
Complete session (checks blockers, auto-exports) |
Global Flags
| Flag | Description |
|---|---|
--db-path <path> |
Override database path (default: ~/.planner-auto/planner.db) |
--verbose |
Print detailed output |
--debug |
Print debug-level output + stack traces |
Review Commands (Plan 2)
| Command | Description |
|---|---|
review <id> |
Run automated GPT review loop on current plan |
review <id> --fast |
Fast mode: 4 rounds, no history, basic prompt |
review <id> --max-rounds <n> |
Override round cap |
review <id> --no-review-history |
Disable review history context |
review <id> --reviewer-model <model> |
Override GPT model (default: gpt-5.4) |
review <id> --reviewer-reasoning <level> |
Reasoning effort (default: high) |
review <id> --complexity standard|complex |
Override complexity detection |
review <id> --repo-root <path> |
Override repo root for .kafra handoff |
review <id> --tui |
Launch live TUI dashboard (requires pip install planner-auto[tui]) |
Review loop features:
- GPT-5.4 reviews with
resolution_guidance+target_sectionper issue keep/trimsections: GPT tells Claude what to preserve and what to simplifyvalidate feedback: Claude assesses each issue as ACCEPT / DEFER / REJECT- Severity filtering: only
critical+majorissues reach Claude - Review history: GPT sees previous plan + cumulative DEFER decisions across all rounds
- Complexity detection: auto-adjusts round cap (standard=8, complex=12)
- Convergence: GPT GO, or cap with zero criticals = accepted
- Cap with criticals = session paused for human review
- Final plan copied to
<repo>/.kafra/a-01-plans/ - Review metadata persisted: model, cost, tokens, raw response per round
- TUI mode (
--tui): Live dashboard with round progress, convergence sparkline, disposition drill-down. Requirespip install planner-auto[tui].
Session Lifecycle
SETUP ──► CONTEXT ──► DISCUSSION ──► PLANNING ──► REVIEW ──► COMPLETE
│ │ ▲
│ └──────────┘
│ (revise & re-review)
└───────────────────────┘
(skip review — direct complete)
Any phase can transition to PAUSED via blockers.
PAUSED only allows: resume, status, export.
| Phase | What Happens | Allowed Commands |
|---|---|---|
| SETUP | Session created, config saved | start, add-context, status, export |
| CONTEXT | Files and notes loaded | add-context, status, export |
| DISCUSSION | User describes feature, Claude asks questions | discuss, status, export |
| PLANNING | Context synthesized, plan generated | generate, review, complete, status, export |
| REVIEW | GPT review loop running | review, complete, status, export |
| COMPLETE | Session finished, artifacts exported | status, export |
Database Schema
All state lives in SQLite at ~/.planner-auto/planner.db. 7 tables:
| Table | Purpose |
|---|---|
sessions |
Session metadata: project, phase, status, timestamps |
messages |
Append-only conversation log (user + assistant turns) |
context_entries |
Loaded files, notes, and synthesized context |
plan_drafts |
Versioned plan content with draft number |
reviews |
Reviewer responses with verdict and issues (Plan 2) |
blockers |
Pause/resume lifecycle with source, question, answer |
session_config |
Config snapshot per session (models, prompt hashes) |
Transaction Contract
CRUD functions do NOT auto-commit. Callers manage transactions:
from planner_auto.db import transaction, add_message
# Single operation — explicit commit
add_message(conn, session_id, "user", "hello")
conn.commit()
# Atomic multi-operation — transaction context manager
with transaction(conn):
add_message(conn, session_id, "user", user_input)
add_message(conn, session_id, "assistant", response)
# Both committed together, or both rolled back on error
Artifact Export
Artifacts are generated from the DB on demand. They are NOT read back by the tool.
~/.planner-auto/sessions/<session-id>/
├── chat.csv # Full conversation (id, timestamp, role, content)
├── context-summary.md # Context entries grouped by type
├── plan-draft-1.md # First plan draft
├── plan-draft-2.md # Revised draft (after review, Plan 2)
├── ...
└── plan-draft-N.md # Latest draft
With Plan 2 (reviewer), additional files:
├── a-01-plan.md # Draft 1
├── a-02-review.md # Review 1
├── a-03-plan.md # Draft 2 (revised)
├── a-04-review.md # Review 2
├── ...
└── a-<N>-plan-final.md # GPT-approved final plan
Architecture (For Agents & Devs)
planner_auto/
├── cli.py # Click CLI — all user-facing commands
├── db.py # SQLite schema (v2), CRUD, transaction(), schema migration
├── session.py # SessionManager — phase transitions, pause/resume
├── state.py # Phase/Status enums, transition rules, command permissions
├── agents.py # discuss(), synthesize_context(), generate_plan()
├── sdk_wrapper.py # Claude SDK wrapper — retry, timeout, effort/thinking
├── review_workflow.py # Shared review orchestration (prepare/run/finalize)
├── prompts.py # System prompts with version hashing
├── export.py # Artifact export — plans, reviews, .kafra handoff
├── validation.py # Plan format validation (milestone headers, checkboxes)
├── errors.py # Custom exceptions (SDK, reviewer, session errors)
├── git_utils.py # Repo root discovery (git rev-parse + --repo-root)
├── logging.py # Session-scoped log file setup
├── inspect.py # DB inspection queries for debugging
├── reviewer/
│ ├── contract.py # ReviewerContract ABC, ReviewerResponse, ReviewIssue
│ ├── direct_api.py # DirectAPIAdapter — GPT-5.4 via OpenAI SDK
│ ├── parser.py # Response parser (JSON/XML/free-form fallback)
│ └── prompts.py # Reviewer system prompts (basic, guidance, keep_trim)
├── loop/
│ ├── engine.py # ReviewLoopEngine — review → revise → repeat
│ ├── feedback.py # Validate feedback (ACCEPT/DEFER/REJECT per issue)
│ ├── history.py # Review context builder (cumulative deferred)
│ └── convergence.py # Complexity detection, caps, fast mode
└── tui/ # TUI Review Dashboard (optional: pip install planner-auto[tui])
├── review_app.py # ReviewTUI — main Textual app
├── adapter.py # Thread-safe engine → TUI bridge
├── messages.py # 8 Textual message types
├── bindings.py # Keybinding definitions
├── widgets/ # SessionPanel, ConvergencePanel, RoundList, etc.
├── screens/ # DispositionScreen, PlanScreen, RawResponseScreen, HelpScreen
└── styles/ # theme.tcss — dark theme, 3 responsive breakpoints
Key Design Decisions
| Decision | Rationale |
|---|---|
| SQLite as canonical state | Files drift from tool state. DB is authoritative, files are exports. |
| Callers manage commits | Enables atomic multi-operation transactions without CRUD-level coupling. |
| Phase-gated commands | Prevents out-of-order operations (e.g., generate before discuss). |
| PLANNING→COMPLETE or PLANNING→REVIEW→COMPLETE | Direct complete skips review; review command runs the GPT loop. |
asyncio.wait_for on SDK calls |
Prevents hung SDK subprocess from blocking forever. |
| Prompt version hashing | Config snapshot per session enables reproducibility and regression detection. |
For Agents
When working with planner-auto code:
- All DB access goes through
db.pyfunctions — never raw SQL in other modules - All phase transitions go through
SessionManager— never direct DB updates - SDK calls go through
sdk_wrapper.py— handles retry, timeout, error mapping - Tests use in-memory SQLite (
:memory:) with explicit commits - Tests mock all SDK calls — no real API calls in test suite
Development
# Setup
cd planner-auto/
pip install -e ".[dev]"
# Run tests
pytest tests/ -v # All tests
pytest tests/test_db.py -v # Single file
pytest tests/test_session.py::TestCheckCommand -v # Single class
pytest -k "complete" -v # Filter by name
# Current test count: 464 passing
Config Versioning
Every session captures its configuration at creation time in session_config:
{
"project": "my-api",
"model_default": "claude-sonnet-4-6",
"prompt_hashes": {
"planner": "sha256:abc123...",
"synthesis": "sha256:def456..."
}
}
Plan 2 extends this with reviewer settings:
{
"project": "my-api",
"model_default": "claude-opus-4-6",
"repo_root": "/Users/me/my-api",
"reviewer_model": "gpt-5.4",
"reasoning_effort": "high",
"prompt_mode": "keep_trim",
"review_history": true,
"validate_feedback": true,
"filter_severity": ["critical", "major"],
"fast_mode": false,
"complexity": "standard",
"max_rounds": 8
}
Known Issues
Claude Agent SDK Subprocess (when using --claude-backend sdk)
The SDK backend (--claude-backend sdk) spawns a claude CLI subprocess which shares rate-limit quota with active Claude Code sessions. This is not an issue with the default direct backend.
If you need to use the SDK backend (e.g., OAuth-only auth), be aware:
- Rate limiting when other Claude Code sessions are active
- anyio cancel scope tracebacks on error paths (cosmetic, not harmful)
- Opus + thinking can consume turns on tool calls, returning empty results
Recommendation: Use the default direct backend with ANTHROPIC_API_KEY whenever possible.
Roadmap
- Plan 1: Session Core — CLI, DB, lifecycle, context, plan generation, export
- Plan 2: Reviewer Adapter — GPT review loop, convergence, .kafra handoff
- Direct API backend — Bypass SDK subprocess, works alongside Claude Code sessions
- Stress testing (Level 2) — First end-to-end success: 3-round convergence, $0.12, GPT GO
- TUI mode — Review dashboard with live round progress, convergence sparkline, drill-down
- Telegram notifications — Notify on plan approval or blocker
- Homebrew formula —
brew install planner-auto
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file planner_auto-0.5.0.tar.gz.
File metadata
- Download URL: planner_auto-0.5.0.tar.gz
- Upload date:
- Size: 140.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d769b89704246f3608631192bf564ce77d7f8bf6a19b8eed12a5cf57a1b49f28
|
|
| MD5 |
adddc564142c54ae1168b960a80677c5
|
|
| BLAKE2b-256 |
32070800b7648a3136e56bfb94b8f62093b0545a0ef952bd2d64432a99d04403
|
File details
Details for the file planner_auto-0.5.0-py3-none-any.whl.
File metadata
- Download URL: planner_auto-0.5.0-py3-none-any.whl
- Upload date:
- Size: 100.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
cb9699125a55df5e6260f5e49e57a161e4f179134fe8e20b42eed31a3464fc07
|
|
| MD5 |
c1a3520f797893b4fd8021e5d15a6537
|
|
| BLAKE2b-256 |
8908ef048bf375070f552b52ed09c3d0c1f5873b94ad049635c38128da470c3a
|