https://github.com/easydevv/uplan
πuPlan - AI-powered development planning automation tool that generates structured project documents and to-do lists. Streamlines your planning workflow with template-based questions, Supports multiple AI models and offers customizable templates for development planning.
https://github.com/easydevv/uplan
ai anthropic cli deepseek developer-tools llm ollama openai planning-tool productivity project-documentation project-management todo-list workflow
Last synced: 2 months ago
JSON representation
πuPlan - AI-powered development planning automation tool that generates structured project documents and to-do lists. Streamlines your planning workflow with template-based questions, Supports multiple AI models and offers customizable templates for development planning.
- Host: GitHub
- URL: https://github.com/easydevv/uplan
- Owner: EasyDevv
- License: mit
- Created: 2025-03-15T08:03:14.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2025-03-15T09:25:34.000Z (2 months ago)
- Last Synced: 2025-03-15T10:25:48.603Z (2 months ago)
- Topics: ai, anthropic, cli, deepseek, developer-tools, llm, ollama, openai, planning-tool, productivity, project-documentation, project-management, todo-list, workflow
- Language: Python
- Homepage:
- Size: 123 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# πuPlan
`uPlan` is a Python package that utilizes AI to generate structured development plans and to-do lists.
[](https://pypi.org/project/uplan/)
[](https://pypi.org/project/uplan/)
#### English | [νκ΅μ΄](docs/README_KR.md)
## π Introduction
uPlan automates the development planning process to generate consistent and structured project documentation.
**Problems with existing AI chat-based planning:**
- Questions and methods vary with each session
- Performance degradation due to increased context as conversations accumulate
- Lack of repeatable workflow
**uPlan's Solution:**
- Template-based structured questions
- Efficient resource usage by calling AI only when necessary
- Compatibility ensured through structured TOML format output
## β¨ Key Features
- π― Automatic development plan generation using AI
- β
Detailed to-do list creation based on plans
- π Structured output in TOML format
- π Interactive template customization
- π οΈ Support for various AI models (OpenAI, Anthropic, Gemini, Deepseek, Ollama, etc.)
## π How It Works
uPlan operates through the following workflow:
1. **Structured Question Generation** (Code): Creates questions based on user-provided templates
2. **Question Response** (User): Provides answers to structured questions
3. **Plan Generation** (AI): Creates development plans based on user responses
4. **Plan Verification** (User): Reviews and approves the generated plan
5. **To-Do List Generation** (AI): Creates detailed to-do lists based on the approved plan
6. **Final Verification** (User): Final review and approval of the to-do list
This process yields optimal development plans through efficient interaction between code (automation), user (decision-making), and AI (generation).
## π Quick Start
### Installation
```bash
pip install uplan
```
### Run with Default Settings
```bash
uplan
```
> The default model is ollama/qwq.
### Specify a Particular Model
```bash
uplan --model gemini/gemini-2.0-flash-thinking-exp
```
> Add the `GEMINI_API_KEY` key-value pair to your `.env` file. You can get a free key [here](https://gemini.ai/pricing).
## π€ Supported Models
For more details, refer to [MODELS.md](docs/MODELS.md).
## π Detailed Usage
uPlan supports the following command structure:
```
uplan [global options] [command] [command options]
```
### Global Options
| Option | Description | Default |
|------|------|--------|
| `--model` | LLM model to use | `"ollama/qwq"` |
| `--retry` | Maximum retry count for LLM requests | `5` |
| `--category` | Template type | `"dev"` |
| `--input` | Input template folder path | `"./input"` |
| `--output` | Output file save folder | `"./output"` |
| `--debug` | Enable debug mode | `false` |
### Output Files
The following files are generated as a result of execution:
- `plan.toml`: Development plan document
- `todo.toml`: To-do list
- `todo.md`: To-do list in markdown format
- `todo.json`: To-do list in checklist format (including completion status)
### Commands
#### Basic Execution (Plan Creation)
Running without a command operates in plan generation mode:
```bash
uplan [global options]
```
Examples:
```bash
# Run with default model and dev category
uplan
# Specify model and category
uplan --model "ollama/qwq" --category "custom"
# Change input/output paths
uplan --input "./my-templates" --output "./my-plans"
```
> **Note**: If templates don't exist in the specified `--input/[category]` path, they will be automatically initialized.
#### init - Template Initialization
Creates template files:
```bash
uplan init [template] [--force]
```
**Options:**
- `template`: Template name to initialize (default: "dev")
- `--force`: Force overwrite of existing files
Examples:
```bash
# Initialize default dev template
uplan init
# Initialize custom template
uplan init dev_en
# Force overwrite existing template
uplan init dev --force
```
## π οΈ Template Customization
### plan.toml
A template that includes prompts and Q&A structure for basic planning.
```toml
[prompt]
role = "You are a good code architect and have a good understanding of the development process."
goal = "Create a plan for development."
preferred_language = "English"
instructions = [
"Review what's already entered in .",
" can contain multiple contents.",
"Fill in the parts to create the final deliverable."
]
output_structure = [
"Write it in JSON format inside a ```json ``` codeblock.",
"Key values use lowercase"
]
```
**Template Question Structure:**
```toml
[template.project_basics.overview]
ask = "Please describe the overview of the project"
description = "What you are making (app, service, etc.), target platform (web, mobile, desktop, etc.), main users, etc."
required = true
```
| Property | Description |
|------|------|
| `ask` | Basic question |
| `description` | Additional explanation (AI auto-generates if answer not provided) |
| `required` | Whether to present the question (default: false) |
### todo.toml
A template for generating detailed to-do lists based on the plan.
```toml
[template.frontend]
framework = [" (e.g., react, vue, angular)"]
tasks = [
" (e.g., design login page UI, design sign up page UI, implement user input validation logic)",
]
```
| Property | Description |
| --- | --- |
| `frameworks` | AI specifies based on the content of `output/dev/plan.toml` |
| `tasks` | AI generates specific to-do list based on the content of `output/dev/plan.toml` |
## π¨βπ» Contributing
Issues and pull requests are welcome!
## π License
See the [LICENSE](LICENSE) file for more details.
---
Made with β€οΈ by [EasyDev](https://github.com/easydevv)