Story is a CLI tool that helps developers manage their tasks by generating actionable steps from user stories using AI (provider independent). It maintains project context and tracks progress through user stories and tasks.
- 🧠 AI-powered task generation from user stories
- 📝 Maintains project context (language, framework, role, description)
- ✅ Tracks task completion status
- 💾 Persistent storage of project data per repository
- 🎯 Focus on the next actionable task
-
Clone the repository:
git clone https://github.com/baswilson/story.git
-
Install dependencies:
go mod download
-
Create a
.env
file with your OpenAI (or different provider's key) API key:AI_API_KEY=your-api-key-here
-
Build the project:
go build -o story cmd/tool/main.go
-
Run the tool:
./story
-
(Optional) Add to your shell profile: Add an alias and
AI_API_KEY
to your shell profile for global access:nano ~/.zshrc
Add these lines:
export AI_API_KEY=your-key alias story="/Path/To/Your/Executable/story"
Command | Description |
---|---|
set-context |
Set project context (language, framework, role, description) |
new-story |
Add a new user story and generate tasks |
next-task |
Show the next incomplete task for the active story |
complete-task [idx] |
Mark the current or specific task as complete (optional task index) |
status |
Show the current user story and next task |
help |
Show the help menu |
-
Set your project context:
story set-context
-
Add a new user story:
story new-story
-
Check your next task:
story next-task
-
View current task/story:
story
-
Complete current task:
story complete-task
-
Complete a specific task:
story complete-task 2
-
Check progress:
story status
You can use different OpenAI API-compatible AI models by setting environment variables:
Variable | Description | Default Value |
---|---|---|
AI_API_BASE |
API endpoint URL | https://api.openai.com/v1 |
AI_MODEL |
Model name | gpt-4o-2024-11-20 |
Provider | AI_API_BASE |
---|---|
Deepseek | https://api.deepseek.com/v1 |
OpenAI | https://api.openai.com/v1 |
All project data is stored in memory.json
in the current working directory. This includes:
- Project context
- User stories
- Task status
- Next story ID
This allows easy inclusion of stories in source control.
- Go 1.22.2 or higher
- OpenAI API key (GPT-4 access recommended)
Contributions are welcome! Please open an issue or submit a pull request.
MIT License