Skip to content

Latest commit

 

History

History
87 lines (60 loc) · 2.56 KB

File metadata and controls

87 lines (60 loc) · 2.56 KB

Frequently Asked Questions

Why not use GitHub Issues?

AI agents need a fast, local, Markdown-native way to manage tasks. GitHub Issues adds complexity and overhead that slows down task management.

Key differences:

Feature ai-todo GitHub Issues
Speed Instant, local operations API calls, network latency
Authentication None required OAuth/PAT tokens needed
Rate Limits None API rate limits apply
Offline Support Full functionality Requires network
Format Plain Markdown Proprietary API format
Version Control Native Git integration Separate from codebase

When to use each:

  • ai-todo: Day-to-day task tracking during development, AI agent workflows, quick task management
  • GitHub Issues: Bug reports from users, feature requests, cross-repository coordination, public discussion

Integration: You can reference GitHub Issues in ai-todo tasks:

Create a task for fixing #123
Add subtask: Address PR #456 feedback

This keeps ai-todo fast and simple while maintaining links to your GitHub workflow.

How do I migrate from the shell script to Python?

See the Python Migration Guide for step-by-step instructions. The short version:

  1. Install: uv tool install ai-todo
  2. Replace ./todo.ai with ai-todo in your workflow
  3. No data migration needed - same file formats

Can I use ai-todo without an MCP-enabled IDE?

Yes. The CLI works standalone:

# Install
uv tool install ai-todo

# Use directly
ai-todo add "My task"
ai-todo list
ai-todo complete 1

How do I set up Cursor integration?

Add this to your project's .cursor/mcp.json:

{
  "mcpServers": {
    "ai-todo": {
      "command": "uvx",
      "args": ["ai-todo", "serve", "--root", "${workspaceFolder}"]
    }
  }
}

See the MCP Setup Guide for detailed instructions.

Where is my data stored?

  • Tasks: TODO.md in your project root
  • Configuration: .ai-todo/config.yaml
  • State: .ai-todo/ directory (serial numbers, checksums, logs)

All files are plain text and safe to commit to Git.

Can multiple people work on the same TODO.md?

Yes. Since TODO.md is a plain text file tracked in Git, standard Git workflows apply:

  • Each developer works on their branch
  • Merge conflicts are resolved like any other file
  • Task IDs are unique within the file

For real-time collaboration, consider using GitHub Issues for shared tasks and ai-todo for personal/branch-specific work.