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.

Packaging for PyPI

This project is configured with pyproject.toml and uses setuptools for packaging.

Build and publish

python3 -m pip install build twine
python3 -m build
python3 -m twine upload dist/*

Development dependencies

Install development tooling:

python3 -m pip install -e .[dev]

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.0.tar.gz (10.2 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.0-py3-none-any.whl (13.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: devcli_dashboard-0.1.0.tar.gz
  • Upload date:
  • Size: 10.2 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.0.tar.gz
Algorithm Hash digest
SHA256 23c7387c1954e2d4af960905844ddf61a9e129e582d95ae057e4b4b566bb0327
MD5 0ac2d9e49114c297dbb579c293f5ccf7
BLAKE2b-256 8a5f4509598ced6be2d9c573601f22a937894b8ea00c9e012b0e897c3d3207a5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for devcli_dashboard-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 94c88ec9434f3c26389292aad719a4b0f5075d32e2de900f6470f4490d815408
MD5 538eaf80c313b6d60e2ba3b7dcdc7b62
BLAKE2b-256 37a542ec11fa6393203628f2ebcf950f5e016a5c46fe6a8940127db7e941e9c9

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