🖥 Terminal Widgets

This tool lets you design and run dynamic, customizable dashboards directly inside your terminal. It combines modular widgets, real-time data updates, and flexible layout management for a highly interactive CLI experience.

Getting started • Configuration • Adding new widgets • License

---

🚀 1. Getting started

1. Clone this repository
2. Install dependencies: pip install -r requirements.txt
3. Run the dashboard: python main.py

⚠️ Make sure you are using Python Version 3.14+

For full documentation see Setup Guide

---

✨ 2. Configuration

2.1 Changing standard colors and configuration in config/base.yaml

Example:

background_color:
  r: 31  # Red value
  g: 29  # Green value
  b: 67  # Blue value

2.2 Configure your secrets in: config/secrets.env

Example:

WEATHER_API_KEY='your_api_key'
WEATHER_CITY='Berlin,DE'
WEATHER_UNITS='metric'
NEWS_FEED_URL='https://feeds.bbci.co.uk/news/rss.xml?edition=uk'
NEWS_FEED_NAME='BCC'

2.3 Adjust widgets and layouts in: config/widgets/*.yaml

Example:

name: 'clock'
title: ' ⏲ Clock'
enabled: True
interval: 1
height: 5
width: 30
y: 4
x: 87

For full documentation see Configuration Guide

---

⭐ 3. Adding new widgets

See Widget Guide

---

📜 4. License

See License