mirror of
https://codeberg.org/Kankys/doxa.git
synced 2026-11-11 06:44:36 +01:00
42 lines
1.5 KiB
Markdown
42 lines
1.5 KiB
Markdown
# DOXA Habit User Manual 🎯
|
|
|
|
This manual describes how to navigate and manage habits in the DOXA Habit tracker.
|
|
|
|
## Getting Started
|
|
|
|
Start the application by running:
|
|
```bash
|
|
doxa-habit
|
|
```
|
|
Press `Enter` on the splash screen to enter the main interface.
|
|
|
|
## Interface States
|
|
|
|
1. **MAIN VIEW**: A list showing all your habits, their current streaks (e.g., `🔥3` for 3 consecutive days, or `❄️0`), and a mini calendar heatmap showing the last 7 days (`▓` for completed, `░` for missed).
|
|
2. **DETAIL MODAL**: Displays description, frequency, stats for last 7/30 days, and a detailed heatmap.
|
|
3. **STATS VIEW**: Table summarizing all your habits' statistics.
|
|
4. **ADD / EDIT FORM**: Text inputs to add or modify habits.
|
|
|
|
## Controls
|
|
|
|
### Main Screen
|
|
- `1`: Add a new habit.
|
|
- `2`: Edit the selected habit.
|
|
- `3`: Export completion history to `~/.doxa-habit/export/<habit_name>_history.csv`.
|
|
- `4`: Delete selected habit.
|
|
- `t`: Toggle today's status (Completed ✅ vs Not Completed ⬜).
|
|
- `s`: Show statistics of all habits.
|
|
- `l`: Switch UI language (English/Czech).
|
|
- `/`: Filter habits by search term.
|
|
- `Enter`: Open details modal.
|
|
- `q` / `Esc`: Exit the program.
|
|
|
|
### Form Fields (Add/Edit)
|
|
- `Tab`: Jump between the "Name" and "Description" fields.
|
|
- `f`: Toggle habit frequency between "Daily" and "Weekly".
|
|
- `Enter`: Save and create/modify the habit.
|
|
- `q` / `Esc`: Go back to the main list without saving.
|
|
|
|
### Modal & Stats Views
|
|
- `q` / `Esc`: Return to the main list view.
|