Skip to main content

A plugin-driven developer CLI with a live Textual dashboard.

Project description

DevCLI

DevCLI is a plugin-driven command line toolkit with a live Textual dashboard for developers and sysadmins.

It combines system metrics, task status, and dynamic plugins into a single terminal UI, making it easy to extend with custom monitoring, git status, and tooling panels.

Features

  • Plugin-based dashboard architecture
  • Live updates for system stats, git status, ping, and quotes
  • Textual-powered terminal UI with left/right layout
  • Easy plugin registration via register(tui_app) hooks
  • CLI entrypoint via devcli

Installation

Install from PyPI once published:

pip install devcli

For local development:

python3 -m pip install -e .

Usage

Run the dashboard from the repository or installed package:

python3 -m devcli.main start

or if the package is installed:

devcli start

Plugin System

The dashboard is built around plugins located in devcli/plugins/.

Each plugin should expose a register(tui_app) function that appends a widget to tui_app.tui_panels.

Example plugin characteristics:

  • cpu_temp.py — CPU temperature and frequency
  • git_status.py — current git repo status
  • ping_monitor.py — ping latency reporting
  • fun_quotes.py — rotating motivational quotes

Creating a plugin

  1. Add a new file under devcli/plugins/.
  2. Define a Static-based widget.
  3. Implement register(tui_app) and append the widget to tui_app.tui_panels.

Notes

  • Requires Python 3.11+
  • Depends on textual for the TUI
  • python-dotenv is included for environment configuration support

Contribution

Contributions are welcome. Add new plugins, improve dashboard styling, or extend the CLI commands.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

devcli_dashboard-0.1.1.tar.gz (9.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

devcli_dashboard-0.1.1-py3-none-any.whl (13.5 kB view details)

Uploaded Python 3

File details

Details for the file devcli_dashboard-0.1.1.tar.gz.

File metadata

  • Download URL: devcli_dashboard-0.1.1.tar.gz
  • Upload date:
  • Size: 9.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.2

File hashes

Hashes for devcli_dashboard-0.1.1.tar.gz
Algorithm Hash digest
SHA256 40a86c6bfc41ea7b6d03c0b2fab0111cb53a2a9689f560cae715616b39c3194d
MD5 59b8f3c117f44e7c8aad018493330469
BLAKE2b-256 85940341eea5eaa9cd4b8d9031a3a12b6ce402d606c63c71b385b095859ed336

See more details on using hashes here.

File details

Details for the file devcli_dashboard-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for devcli_dashboard-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 00d64a788e76c9405bf0a964e1f4cbf0ec0ba76a233eb3e38f1cbec5c0852351
MD5 52d37ea01a802d18f8126532caf70bd5
BLAKE2b-256 80b1d559d6c95848be722e960f6e7b9c5bb6987848155de761d4d05d11757e3d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page