bgt-task
v1.2.0
Published
Smart terminal-based task management with AI-powered task generation and vim integration
Maintainers
Readme
🚀 bgt-task
Smart terminal-based task management with AI-powered task generation.
✨ Features
- 🎯 Quick Task Creation:
bgt tasknamecreates timestamped task files instantly - 🤖 AI-Powered Tasks:
bgt -ai tasknameuses Claude 4 to analyze your terminal history and create intelligent task templates - 📝 Editor Agnostic: Works with any text editor - vim, VS Code, nano, emacs, etc.
- 🧹 Easy Cleanup:
bgt clearsafely removes all task files with confirmation - ⚙️ Smart Setup:
bgt --setupautomatically configures directories, gitignore, and environment
🔠️ Installation
npm install -g bgt-taskThe package will automatically:
- Detect your shell (zsh/bash/fish)
- Navigate to select your project directory (interactive folder tree)
- Install the
bgtfunction to your shell config
🎮 Usage
Basic Commands
bgt taskname # Create a new task file
bgt -ai taskname # Create AI-powered task (requires API key)
bgt --sections-json file.json # Create using sections JSON (requires jq)
bgt --sections-stdin # Read sections JSON from stdin (requires jq)
bgt --no-open # Do not open editor (combine with other cmds)
bgt continue # Continue latest task (set active)
bgt task continue # Continue latest task (set active)
bgt clear # Delete all task files (with confirmation)
bgt --setup # Setup/re-setup environmentExamples
# Create a simple task
bgt fix-login-bug
# Create an AI-powered task that analyzes your terminal history
bgt -ai implement-authentication
# Create a task programmatically (no editor)
cat > sections.json <<'JSON'
{
"Description": "Ignore To-Dos directory in git",
"Progress": [
"Add To-Dos/ to .gitignore",
"Untrack existing To-Dos files"
],
"Notes": "Run: git rm -r --cached -- To-Dos"
}
JSON
bgt --sections-json sections.json git-ignore-To-Dos --no-open
# Clean up completed tasks
bgt clear🤖 AI Features Setup
To enable AI-powered task generation:
- Get your API key from Anthropic Console
- Add to your project's
.envfile:ANTHROPIC_API_KEY=your-key-here - Or export it globally:
export ANTHROPIC_API_KEY='your-key-here'
The AI will analyze your recent terminal commands, git status, and current directory to create contextual, actionable task templates.
📁 File Structure
Tasks are created in a To-Dos/ directory in your project root:
your-project/
├── To-Dos/ # Auto-created, gitignored
│ ├── 2025-08-25_14-30-22_fix-bug.md
│ └── 2025-08-25_15-45-10_add-feature.md
├── .gitignore # Auto-updated
└── .env # For API keys📋 Task Template
Each task file includes:
# Task: your-task-name
Created: Thu Aug 25 14:30:22 PDT 2025
## Description
[AI generates context-aware description or blank for manual entry]
## Progress
- [ ] [AI generates actionable steps based on terminal history]
- [ ]
- [ ]
## Notes
[AI includes relevant file paths, errors, or technical context]🔧 Customization
After installation, you can edit the bgt function in your shell config to customize the project directory or other settings.
🗑️ Uninstalling
npm uninstall -g bgt-taskThen manually remove the bgt function from your shell config file (~/.zshrc, ~/.bashrc, etc.).
🤝 Contributing
- Fork the repository
- Create your feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
📄 License
This project is licensed under the MIT License.
❓ FAQ
Q: Can I use this without AI features?
A: Yes! All basic functionality works without an API key.
Q: What shells are supported?
A: Currently zsh, bash, and fish.
Q: Can I use a different AI provider?
A: Currently supports Anthropic's Claude. OpenAI support planned.
Q: How do I change the project directory after installation?
A: Edit the bgt function in your shell config file and update the project_root variable.
Made with ❤️ for developers who love efficient task management.
