go-todoist

README

📝 Golang ToDoist Client App with Bubble Tea UI 🫧

🚧 This project is a work in progress. 🚧

A delightful terminal-based Todoist client built with Go and the charming Bubble Tea framework.

✨ Features

• 📋 List tasks and manage them from your terminal
• 📅 Browse tasks by date with day-to-day navigation
• ➕ Create new tasks with descriptions, due dates, and priority levels
• ✓ Mark tasks as complete or toggle completion status
• 🔄 Refresh task list to sync with Todoist
• 📆 Assign priority levels (P1-P4) to your tasks
• 🎨 Beautiful terminal UI with intuitive navigation
• ⌨️ Fully keyboard-driven interface

🚀 Installation

go install github.com/shivasurya/go-todoist/cmd/todoist@latest

🎮 Usage

1. Launch the application:

todoist should be available in your $GOPATH/bin directory.

1. Navigate using these keyboard shortcuts:

Task List Navigation

• j/k or ↑/↓: Navigate up and down through tasks
• h/l or ←/→: Navigate between previous/next day's tasks
• t: Jump to today's tasks
• space: Toggle task completion status
• c: Mark task as complete
• n: Create new task
• r: Refresh tasks list from Todoist
• Enter: Select currently highlighted task
• ?: Toggle help menu
• q or Ctrl+C: Quit application

Task Creation

• Tab/Shift+Tab: Navigate between task fields (Title, Description, Due Date, Priority)
• Any key: Cycle through priority levels when the priority field is selected:
  • P1: Normal priority (default)
  • P2: Medium priority
  • P3: High priority
  • P4: Urgent priority
• Enter: Submit and create the task
• Esc: Cancel and return to task list

🛠️ Development

Requirements:

• Go 1.19 or higher
• Todoist API key

Build from source:

# Clone the repository
git clone https://github.com/shivasurya/go-todoist

# Navigate to the project directory
cd go-todoist

# Set your Todoist API token
export TODOIST_TOKEN=your_api_key

# Build the application
go build -o todoist cmd/todoist/main.go

# Run it
./todoist

Ensure you have a valid Todoist API key in your environment variable as TODOIST_TOKEN.

📄 License

MIT License - feel free to use and modify!

🙏 Acknowledgments

• Bubble Tea for the amazing TUI framework