REPOSITORY OVERVIEW

Live repository statistics

★ 2Stars

⑂ 0Forks

◯ 0Open issues

◉ 2Watchers

README preview

Todu CLI

todu is a minimalist, terminal-based to-do list application written in Kotlin. It's designed to help you manage your tasks efficiently from the command line.

Features

Add new tasks with tags and due dates.
List tasks by status (overdue, today, tomorrow, later).
Mark tasks as done or undone.
Delete all completed tasks with a single command.
Automatically saves tasks to your ~/.todu/tasks.txt file.
Lightweight and fast, ideal for productivity enthusiasts who prefer CLI tools.

Installation

1. Install with Homebrew (macOS)

Homebrew is the easiest way to install todu on macOS.

Tap the Todu formula:
```
brew tap marceloakalopes/todu
```
Install Todu:
```
brew install todu
```
Verify Installation:

After installation, you can verify it by running:
```
todu --help
```

2. Manual Installation (macOS)

If you prefer to manually download and install the binary on macOS, follow these steps:

Download the Latest Release

Go to the Releases page of this repository and download the .tar.gz file for macOS. Example: todu-1.0.0-macos.tar.gz.
Extract the Tarball:

After downloading, extract the file:
```
tar -xvzf todu-1.0.0-macos.tar.gz
```
Move the todu Binary to /usr/local/bin:

To make todu accessible globally, move it to a directory in your system's PATH:
```
sudo mv todu /usr/local/bin/todu
sudo chmod +x /usr/local/bin/todu
```
Verify Installation:

You can verify that the installation was successful by running:
```
todu --help
```

3. Manual Installation (Linux)

Linux users can install Todu manually with the following steps:

Download the Native Image for Linux

Go to the Releases page of this repository and download the .tar.gz file for Linux. Example: todu-1.0.0-linux.tar.gz.
Extract the Tarball:

After downloading, extract the file:
```
tar -xvzf todu-1.0.0-linux.tar.gz
```
Run Todu from the extracted folder:

Navigate to the extracted directory and run Todu:
```
./todu
```
Optional - Move Todu to a Directory in Your PATH:

To make todu globally accessible, move it to /usr/local/bin:
```
sudo mv todu /usr/local/bin/todu
sudo chmod +x /usr/local/bin/todu
```
Verify Installation:

You can verify that the installation was successful by running:
```
todu --help
```

Usage

Once installed, you can start using todu to manage your tasks from the terminal.

Commands

List all tasks:
```
todu list
```
Options:
- todu list -o — List overdue tasks.
- todu list -t — List tasks due today.
- todu list -tm — List tasks due tomorrow.
- todu list -l — List tasks due later.
Add a new task:
```
todu new
```
Delete a task by ID:
```
todu del <task-id>
```
Delete all completed tasks:
```
todu del --checked-all
```
Mark a task as done:
```
todu check <task-id>
```
Unmark a task as done:
```
todu uncheck <task-id>
```
Display Help:
```
todu --help
```

Updating Todu

To check for new versions and update the app:

todu --update

This will check for the latest version on GitHub. The bug related to GitHub API connectivity has been fixed in this release, ensuring smooth updates.

Uninstalling Todu

The todu --uninstall command has been removed. You can now uninstall Todu via the package manager you used for installation. For example:

Homebrew (macOS):
```
brew uninstall todu
```

Contributing

Contributions are welcome! Feel free to open issues or submit pull requests to help improve todu.

Fork this repository.
Create your feature branch: git checkout -b feature/my-feature
Commit your changes: git commit -am 'Add new feature'
Push to the branch: git push origin feature/my-feature
Open a Pull Request.

License

This project is licensed under the MIT License. See the LICENSE file for details.