https://github.com/murapadev/ztodo
A powerful, SQLite-based task management plugin for Oh-My-Zsh that provides persistent storage, priority levels, categories, deadlines, and efficient search capabilities. Designed for developers who live in the terminal and want a seamless, integrated todo management experience.
https://github.com/murapadev/ztodo
cli oh-my-zsh oh-my-zsh-custom oh-my-zsh-plugin productivity shell task-management terminal todo zsh zsh-plugin ztodo
Last synced: 3 months ago
JSON representation
A powerful, SQLite-based task management plugin for Oh-My-Zsh that provides persistent storage, priority levels, categories, deadlines, and efficient search capabilities. Designed for developers who live in the terminal and want a seamless, integrated todo management experience.
- Host: GitHub
- URL: https://github.com/murapadev/ztodo
- Owner: murapadev
- License: apache-2.0
- Created: 2025-03-03T19:09:05.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-03-03T19:40:05.000Z (4 months ago)
- Last Synced: 2025-03-20T14:42:40.136Z (3 months ago)
- Topics: cli, oh-my-zsh, oh-my-zsh-custom, oh-my-zsh-plugin, productivity, shell, task-management, terminal, todo, zsh, zsh-plugin, ztodo
- Language: Shell
- Homepage:
- Size: 22.5 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# ZTodo - Oh-My-Zsh Todo Plugin
A SQLite-based todo plugin for Oh-My-Zsh, providing persistent storage and efficient task management.
## Requirements
- Oh-My-Zsh
- SQLite3
- Zsh
## Installation
1. Install sqlite3 if not already installed:
```bash
# Ubuntu/Debian
sudo apt install sqlite3
# CentOS/RHEL
sudo yum install sqlite
# Arch
sudo pacman -Sy sqlite
# macOS
brew install sqlite
```
2. Clone this repository into your Oh-My-Zsh custom plugins directory:
```bash
git clone https://github.com/murapa96/ztodo ${ZSH_CUSTOM:-~/.oh-my-zsh/custom}/plugins/ztodo
```
3. Add `ztodo` to your plugins array in `~/.zshrc`:
```bash
plugins=(... ztodo)
```
4. Reload your shell:
```bash
source ~/.zshrc
```
## Usage
- `ztodo add` - Add a new todo item
- `ztodo list` - List all active todo items
- `ztodo remove ` - Remove a specific todo item
- `ztodo complete ` - Mark a todo item as complete
- `ztodo clear` - Remove expired and completed tasks
- `ztodo search ` - Search tasks by keyword
- `ztodo help` - Show help message
## Features
- SQLite-based persistent storage
- Color-coded priority levels
- Task categorization
- Deadline tracking
- Task completion tracking
- Efficient search capabilities
- Automatic cleanup of expired tasks
## Configuration
### Option 1: Using the configuration file (default)
The plugin will automatically create a configuration file at `~/.ztodo.conf` if it doesn't exist. You can customize the following settings:
```bash
# Database location
ZTODO_DB_PATH="$HOME/.ztodo.db"
# Default task settings
ZTODO_DEFAULT_CATEGORY="general"
ZTODO_DEFAULT_PRIORITY=2 # 1=high, 2=medium, 3=low
# Notification settings
ZTODO_SHOW_UPCOMING_DEADLINES="true" # Show upcoming deadlines when opening a terminal
ZTODO_UPCOMING_DAYS=7 # Number of days to look ahead for deadlines
# Display settings
ZTODO_COLOR_ENABLED="true" # Enable colored output
```
See [Configuration File](ztodo.conf.template) for an example.
### Option 2: Using .zshrc directly
If you prefer to manage all configuration in your `.zshrc` file, you can disable the configuration file:
```bash
# Disable the configuration file
ZTODO_USE_CONFIG_FILE="false"
# Then set your configuration options
ZTODO_DB_PATH="$HOME/my-tasks.db"
ZTODO_DEFAULT_CATEGORY="work"
ZTODO_DEFAULT_PRIORITY=1
ZTODO_SHOW_UPCOMING_DEADLINES="true"
ZTODO_UPCOMING_DAYS=5
ZTODO_COLOR_ENABLED="true"
# These must be set before Oh-My-Zsh loads the plugin
plugins=(... ztodo)
source $ZSH/oh-my-zsh.sh
```
### Overriding the configuration file location
You can also change the location of the configuration file:
```bash
# Set custom config path before loading oh-my-zsh
ZTODO_CONFIG_PATH="$HOME/Documents/ztodo-config.conf"
# Then load oh-my-zsh
source $ZSH/oh-my-zsh.sh
```
## Roadmap
These are features we're planning to implement in the future:
### Third-party Integrations
- [ ] **ClickUp Integration**: Sync tasks with your ClickUp workspaces, push local tasks to ClickUp, and pull assigned tasks to your local environment.
- [ ] **Notion Integration**: Seamlessly sync with Notion databases, enabling bidirectional updates between ZTodo and your Notion workspace.
- [ ] **GitHub Issues**: Convert GitHub issues to local tasks and vice versa, ideal for developers managing project tasks.
- [ ] **Jira Integration**: For enterprise users, sync with Jira tickets and track work across platforms.
- [ ] **Google Calendar**: Sync tasks with Google Calendar for deadline management.
- [ ] **Slack Integration**: Receive task reminders and updates directly in your Slack channels.
- [ ] **More database options**: Support for PostgreSQL, MySQL, and MongoDB.
### Enhanced Features
- [ ] **Recurring Tasks**: Set up tasks that repeat on daily, weekly, monthly, or custom schedules.
- [ ] **Time Tracking**: Track how long you spend on each task.
- [ ] **Subtasks Support**: Break down complex tasks into manageable subtasks.
- [ ] **Calendar View**: Visual representation of your deadlines in calendar format.
- [ ] **Data Export/Import**: Export your tasks as CSV/JSON and import from various formats.
- [ ] **Task Templates**: Create templates for common task types with predefined attributes.
- [ ] **Team Sharing**: Share tasks with team members (requires server component).
- [ ] **Per Task History**: Configure your ZSH history to log task-related commands.
### UI Improvements
- [ ] **Interactive TUI**: A full terminal user interface for easier task management.
- [ ] **Custom Theming**: Define your own color schemes and styling.
- [ ] **Dashboard View**: Overview of task statistics and upcoming deadlines.
- [ ] **Notifications**: Desktop notifications for upcoming deadlines and reminders.
- [ ] **Mobile App**: Companion app for managing tasks on the go.
- [ ] **Web Interface**: A web-based dashboard for managing tasks from any device.
If you'd like to contribute to any of these features, please check out our [Contributing Guide](CONTRIBUTING.md).
## License
Apache License 2.0