Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🚀 bgt-task

Smart terminal-based task management with AI-powered task generation.

✨ Features

  • 🎯 Quick Task Creation: bgt taskname creates timestamped task files instantly
  • 🤖 AI-Powered Tasks: bgt -ai taskname uses 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 clear safely removes all task files with confirmation
  • ⚙️ Smart Setup: bgt --setup automatically configures directories, gitignore, and environment

🔠️ Installation

npm install -g bgt-task

The package will automatically:

  1. Detect your shell (zsh/bash/fish)
  2. Navigate to select your project directory (interactive folder tree)
  3. Install the bgt function 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 environment

Examples

# 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:

  1. Get your API key from Anthropic Console
  2. Add to your project's .env file:
    ANTHROPIC_API_KEY=your-key-here
    
  3. 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-task

Then manually remove the bgt function from your shell config file (~/.zshrc, ~/.bashrc, etc.).

🤝 Contributing

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. 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.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages