# Cfait
> Take control of your TODO list
**Cfait** is a powerful, simple, elegant, and lightweight CalDAV task manager, written in Rust.
It features both an efficient **TUI (Terminal UI)** and a modern **GUI (Graphical UI)** for desktop integration.
.png)
> The Graphical Interface in v0.2.2
.png)
> The Terminal Interface in v0.2.1
## Features
* **Dual Interface:** Run it in your terminal (`cfait`) or as a windowed app (`cfait-gui`).
* **Smart Input:** Add tasks naturally: `Buy cat food !1 @tomorrow ~15m` sets Priority, Due Date, and Duration automatically.
* **GTD Workflow:** Mark tasks as **In Process** (`>`), **Cancelled** (`x`), or **Done**.
* **Duration Estimation:** Estimate time (`~2h`) and filter tasks by duration (`~<30m`).
* **Syncs Everywhere:** Fully compatible with standard CalDAV servers (Radicale, Nextcloud, iCloud, etc.).
* **Tag Support:** Organize tasks across all calendars using tags (e.g., `#woodworking`, `#project_potato`).
* **Tag Aliases:** Define shortcuts (e.g., `#groceries`) that automatically expand into multiple tags (e.g., `#groceries`, `#shopping`, `#home`).
* **Dependencies:** Link tasks using RFC 9253 (Blocked By) logic.
* **Hierarchy Support:** Create sub-tasks and organize nested lists easily.
* **Multiple Calendars:** Seamlessly switch between "Work", "Personal", and other lists, or move tasks between them.
* **Offline & Local First:** Optimistic UI updates mean you never wait for the server. Possibility to use the app immediately without a server; a persistent "Local" calendar stores its tasks on disk.
* **Easy Migration:** When ready, export all tasks from the Local calendar to a CalDAV server with a single click (or keypress).
* **Sane sorting:** Tasks are sorted by due date, then undated tasks are ordered by priority.
## Installation
### A. Pre-built Packages
You can find pre-compiled binaries for Linux and Windows on the [**GitHub Releases page**](https://github.com/trougnouf/cfait/releases).
* **Arch Linux:** Install from the AUR using your favorite helper (e.g., `yay`, `paru`).
```bash
yay -S cfait
yay -S cfait-git
```
* **Debian / Ubuntu:** Download the `.deb` file from the [releases page](https://github.com/trougnouf/cfait/releases) and install it:
```bash
sudo dpkg -i /path/to/downloaded/cfait_*.deb
```
* **Windows:** Download the `.zip` archive from the [releases page](https://github.com/trougnouf/cfait/releases), extract it, and run `cfait.exe` (TUI) or `cfait-gui.exe` (GUI).
* **Other Linux:** Download the generic `cfait-linux-*.tar.gz` archive, extract it, and place the binaries (`cfait`, `cfait-gui`) in your `$PATH` (e.g., `~/.local/bin/` or `/usr/local/bin/`).
### B. From Crates.io (via Cargo)
If you have Rust installed, you can install Cfait directly from crates.io.
```bash
# Install both TUI and GUI
cargo install cfait --features gui
# Or, install only the TUI
cargo install cfait
```
### C. For Development
If you want to contribute to Cfait, clone the repository and build it locally:
```bash
git clone https://github.com/trougnouf/cfait.git
cd cfait
# Run the TUI
cargo run
# Run the GUI
cargo run --bin gui --no-default-features --features gui
```
### Run
```bash
# Run TUI
cfait
# Run GUI
cfait-gui
```
## Configuration
The GUI includes a configuration dialog which writes to the config file below.
The TUI has on onboarding dialog but it is only used to populate the `url`, `username`, and `password` fields.
Create a config file at:
* **Linux:** `~/.config/cfait/config.toml`
* **Mac:** `~/Library/Application Support/com.cfait.cfait/config.toml`
```toml
url = "https://localhost:5232/trougnouf/"
username = "myuser"
password = "mypassword"
# Security: Allow self-signed certificates
# Default: false
allow_insecure_certs = true
default_calendar = "Personal" # Optional: Auto-selects this list on startup
# Optional: Hide calendars you don't want to see (e.g., those without VTASKS capability).
# Use the full calendar href, not the display name.
#hidden_calendars = [
# "/trougnouf/1355814b-9f29-792d-6dba-f6c671304517/",
# "/trougnouf/36df9c8c-98e8-a920-7866-7b9d39bd8a24/",
#]
# Hide completed tasks in all views
hide_completed = false
# Hide tags from the sidebar if they contain NO active tasks
# When true, tags that have only completed tasks will be hidden from the Tags view
hide_fully_completed_tags = true
# Sorting: Tasks due more than X months away are sorted by priority only (not date)
# Default: 6
sort_cutoff_months = 6
# Tag Aliases: Automatically expand one tag into multiple
[tag_aliases]
groceries = ["shopping", "home"] # Typing #groceries will add #groceries, #shopping and #home
cfait = ["dev", "rust"] # Typing #cfait will add #cfait, #dev and #rust
```
## TUI Keybindings
| **Global** | `Tab` | Switch focus (Tasks ↔ Sidebar) |
| | `q` | Quit |
| **Task List** | `j` / `k` | Move Down / Up |
| | `Space` | **Toggle** Completion |
| | `s` | **Start / Pause** (Mark In-Process) |
| | `x` | **Cancel** Task |
| | `a` | **Add** Task (Type name, press Enter) |
| | `e` | **Edit** Task Title |
| | `E` | **Edit** Task Description (Shift+e) |
| | `d` | **Delete** Task |
| | `M` | **Move** Task to another calendar (Shift+m) |
| | `y` | **Yank** (Copy ID for linking) |
| | `b` | **Block** (Mark current task as blocked by Yanked task) |
| | `c` | **Child** (Mark current task as child of Yanked task) |
| | `r` | **Refresh** (Force sync) |
| | `X` | **Export** (Migrate all tasks from Local to remote, Shift+x) |
| | `H` | Toggle **Hide Completed** tasks |
| | `/` | **Search** / Filter Tasks |
| | `+` / `-` | Increase / Decrease **Priority** |
| | `>` / `<` | **Indent** / **Outdent** (Visual Sub-tasks depth) |
| **Sidebar** | `Enter` | Select Calendar / Toggle Tag |
| | `1` | Switch to **Calendars** View |
| | `2` | Switch to **Tags** View |
| | `m` | Toggle Tag Match Mode (AND / OR) |
## Input Syntax
When adding (`a`) or editing (`e`) a task, you can use shortcuts directly in the text:
* `!1` to `!9`: Sets Priority (1 is High, 9 is Low).
* `@tomorrow`, `@today`, `@next week`, `@next month`, `@next year`: Sets Due Date relative to now.
* `@2025-12-31`: Sets specific Due Date (YYYY-MM-DD).
* `~30m`, `~1h`, `~2d`: Sets **Estimated Duration**.
* `@daily`, `@weekly`, `@monthly`, `@yearly`, `@every 4 days`, `@every 2 weeks`, etc: Sets Recurrence.
* `#tag` (e.g. `#Gardening`) to set a tag / category.
* **Aliases:** If you have configured aliases (e.g., `groceries = ["home"]`), typing `#groceries` will automatically apply `#groceries` AND `#home`.
## Advanced Search
The search bar (in both GUI and TUI) supports powerful filtering syntax:
* `text`: Matches title or description.
* `#tag`: Filters by tag (e.g. `#work`).
* `~<30m`: Duration less than 30 mins.
* `~>=1h`: Duration greater or equal to 1 hour.
* `!<3`: Priority higher than 3 (1 or 2).
* `!>=5`: Priority 5 or lower.
* `@<2025-01-01`: Due before specific date.
* `@<1w`: Due within 1 week from today.
* `@>=2d`: Due at least 2 days from today.
* `is:done`: Show only completed/cancelled tasks.
* `is:ongoing`: Show only ongoing (started) tasks.
* `is:active`: Show only active (not completed/cancelled) tasks.
**Example:** `~<20m !<4 #gardening` finds quick, high-priority, gardening tasks.
## License
GPL3