Skip to content

viitorohit/sitrep

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

sitrep

AI-native project management. Two markdown files. Nine slash commands. Zero dependencies.

You don't need Jira to build with AI. You need a system that your AI assistant can read, update, and commit — automatically.


The Problem

AI coding tools start every session blank. No memory. No context. No idea what happened yesterday. You waste 15-20 minutes every session rebuilding context. Nobody knows what it cost.

The Fix

sitrep lives inside your repo. Your AI reads it at session start, updates it at session end. Git tracks everything. A visual dashboard gives you the MIS view. Costs are logged per session.

npx getsitrep init

That's the entire setup.


What You Get

sitrep/
├── MANIFEST.md              ← framework version and rules
├── PROJECT_PLAN.md          ← what to build (phases, decisions, risks)
├── STATUS_REPORT.md         ← where you are (tasks, progress, sessions)
├── .sitrep-data.json        ← cost + token + user tracking data
├── HANDOFF.md               ← context package (auto-generated)
├── dashboard.html           ← visual MIS report (auto-generated)
└── history/
    ├── sessions/            ← per-session detail logs
    ├── handoffs/            ← archived handoff snapshots
    └── dashboards/          ← archived dashboard snapshots

Daily Workflow

/session-start  →  know where you left off
      ↓
   you build
      ↓
/session-end    →  progress, costs, tokens, decisions — logged and committed

Two commands minimum. Everything else is optional but compounds in value.


Commands

Command When What it does
/session-start Start of session Reads status, prints orientation with cost summary
/session-end End of session Updates tasks, progress, costs, tokens, session log. Commits.
/sitrep Anytime Quick read-only status check
/capture New work surfaces /capture fix auth bug --phase 3 → adds to both files
/plan-update Scope changes Add features, decisions, risks to the plan
/selfheal Things feel off Health check + auto-fix. /selfheal deep for codebase audit.
/handoff Switching context Context package. /handoff human or /handoff ai
/dashboard Visual report Generates full MIS dashboard as HTML
/pulse Mid-session Shows which commands ran, suggests what to do next

The Dashboard

/dashboard generates a self-contained HTML report you open in any browser:

  • Summary — progress, total cost, sessions, blockers at a glance
  • Progress — visual bars per phase with cost attribution
  • Sprint — active tasks with status badges
  • Sessions — timeline of who did what, when, at what cost
  • Costs — token usage over time, cost by phase, projections
  • Users — team activity and contribution tracking
  • Decisions — architecture decision log
  • Risks — blockers and risk register
  • Documents — full plan and status rendered inline
  • History — archived handoffs, dashboards, git log

Dark mode. Print-friendly. Mobile-responsive. No server needed.


Cost Tracking

Every /session-end logs:

  • Tokens used (input + output)
  • Cost in USD (based on model pricing)
  • Model used (Claude Sonnet, Opus, GPT-4, etc.)
  • Session duration
  • Who did the session

Know exactly what each feature costs before your budget surprises you.


Quick Start

cd your-project
npx getsitrep init

Customize sitrep/PROJECT_PLAN.md with your phases. Open Claude Code:

/session-start

You're tracking.


Use Cases

Situation What to do
Starting a new project npx getsitrep init → customize plan → /session-start
Resuming after a break /session-start — zero context rebuilding
New task mid-session /capture [description] --phase N
Handing off to a person /handoff human — 5-minute onboarding doc
Switching AI sessions /handoff ai — structured context for next session
Checking costs /dashboard — visual cost breakdown
Something feels wrong /selfheal or /selfheal deep
Stakeholder update /dashboard → open HTML → Cmd+P to print
End of day /session-end — always, no exceptions
Forgot what I ran /pulse — see session command history

Full usage guide: docs/USAGE_GUIDE.md


What's New in v0.2

  • /capture — structured task creation mid-session
  • /selfheal — health check + auto-fix with deep codebase audit
  • /handoff — context packages with auto-archiving
  • /dashboard — visual MIS with 10 sections
  • /pulse — session awareness, shows what ran and suggests next
  • MANIFEST.md — self-documenting framework reference
  • .sitrep-data.json — machine-readable cost and session data
  • history/ — structured archives (sessions, handoffs, dashboards)
  • Cost tracking — per-session token and cost logging
  • User tracking — who did what, when

Roadmap

  • Core commands (session-start, session-end, sitrep, plan-update)
  • npm package (npx getsitrep init)
  • Task capture (/capture)
  • Context handoffs (/handoff)
  • Visual MIS dashboard (/dashboard)
  • Cost and token tracking
  • User tracking
  • Session history archives
  • Session awareness (/pulse)
  • Self-healing (/selfheal)
  • getsitrep.dev landing page
  • HTML intake form for project onboarding
  • GitHub Actions integration
  • Multi-project unified view

Built In Public

sitrep was born while building an AI product using only AI tools. Read the story:

📝 I Replaced My Entire Dev Team With 3 AI Tools. Here's What Broke First.


Compatibility

Built for Claude Code slash commands. The markdown format works with any AI tool that can read and write files.

License

MIT


Star this repo if sitrep helps you ship faster.

About

AI-native project management. Two markdown files. Five slash commands. Zero dependencies.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages