https://github.com/instructa/planr
Simple Project Planning with AI
https://github.com/instructa/planr
Last synced: about 2 months ago
JSON representation
Simple Project Planning with AI
- Host: GitHub
- URL: https://github.com/instructa/planr
- Owner: instructa
- Created: 2025-03-26T21:09:56.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-02T23:10:50.000Z (about 1 year ago)
- Last Synced: 2025-05-15T13:13:10.954Z (11 months ago)
- Size: 80.1 KB
- Stars: 7
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Planr
A project planning and management tool for software development projects.
## Overview
Planr is an AI-powered planning tool that helps teams manage product requirements, create user stories, and track development progress through a structured workflow.
## Project Structure
- `.planr/` - Core directory containing project planning artifacts
- `stories/` - User stories and requirements
- `roadmap.json` - Project roadmap defining tasks and milestones
- `prd.md` - Product Requirements Document
## Modes
Planr supports different operational modes:
- **Planning Mode** - Create and manage stories, specifications, and project plans
- `init` - Initialize project with stories and roadmap from PRD
- `add` - Add new stories to the project
- **Implementation Mode** - Execute on the planned stories using the defined roadmap
## Getting Started
1. Set up your project structure with the `.planr` directory
2. Create your Product Requirements Document in `.planr/prd.md`
3. Use Planning Mode to generate stories and roadmap
4. Implement stories following the roadmap
## Usage
Follow the structured workflow:
1. Define product requirements in `prd.md`
2. Generate stories and roadmap
3. Track progress by updating story status and roadmap
## Links
- X/Twitter: [@kregenrek](https://x.com/kregenrek)
- Bluesky: [@kevinkern.dev](https://bsky.app/profile/kevinkern.dev)
## Courses
- Learn Cursor AI: [Ultimate Cursor Course](https://www.instructa.ai/en/cursor-ai)
- Learn to build software with AI: [instructa.ai](https://www.instructa.ai)
## See my other projects:
* [AI Prompts](https://github.com/instructa/ai-prompts/blob/main/README.md) - Curated AI Prompts for Cursor AI, Cline, Windsurf and Github Copilot
* [codefetch](https://github.com/regenrek/codefetch) - Turn code into Markdown for LLMs with one simple terminal command
* [aidex](https://github.com/regenrek/aidex) A CLI tool that provides detailed information about AI language models, helping developers choose the right model for their needs.
* [codetie](https://github.com/codetie-ai/codetie) - XCode CLI