cli-dashboard

A personal dashboard run from the command line, made using Python and Rich.

Features

• To do list
• Calendar
• Live clock
• Current activities
• Upcoming events
• Goals
• ASCII art
• Motivation from Picca

Requirements

• Python (3.10+)
• Rich
• pipx

Installation

1. Clone the repository and navigate to it
2. Install the dashboard using pipx by running pipx install -e .

The dashboard can now be run anywhere in the command line, simply by running the command dashboard.

Editing the dashboard

• Example json files have been provided in the data folder and should be copied or renamed to todo.json, currently.json, events.json, and goals.json before running the dashboard.
• Dashboard data can be updated in data/todo.json, data/currently.json, data/events.json, and data/goals.json. Make sure to follow the formatting of the example files.

Managing the to-do list

Manage tasks from the command line with the todo command, which reads and writes data/todo.json:

Command	Description
todo list	List all tasks (--done for completed only, --pending for pending only)
todo add "task"	Add a new task
todo remove <N>	Remove a task (also rm)
todo edit <N> "new text"	Edit a task's text
todo done <N>	Mark a task as done
todo undo <N>	Unmark a completed task
todo clear	Remove all completed tasks
todo search <query>	Search tasks by keyword

Ctrl+C to close the dashboard.