Skip to main content

A terminal UI for monitoring and managing local listening ports

Project description

porTUI

A terminal UI application for monitoring local listening ports and managing the processes that own them.

Features

  • Real-time display of listening TCP/UDP ports with process information
  • Configurable columns (Port, IP, Protocol, Process, PID, User, State, Command)
  • Sortable by Port, IP, Protocol, Process, PID, User, State, or Command (numerical IP sorting)
  • Sort order maintained during auto-refresh
  • Inline tree view with real process hierarchy (toggle with t) — parent processes are resolved from the OS even when they don't hold ports (e.g. Chrome → Chrome Helper)
  • Protocol filter to show TCP only, UDP only, or both (cycle with h)
  • Real-time text filtering across all fields
  • Port detail overlay with full untruncated command line (press Enter, Escape to close)
  • Auto-refresh with configurable interval (pauses during interaction)
  • Prominent visual indicator when auto-refresh is paused
  • Kill processes with choice of graceful (SIGTERM) or force (SIGKILL), with PID recycling guard
  • Configuration persistence (~/.config/portui/config.json)
  • Cross-platform (macOS, Linux, Windows)

Installation & Usage

Run without installing (recommended)

uvx portui

Install globally

uv tool install portui
portui

Install with pip

pip install portui
portui

Run from source

git clone https://github.com/lowtrak/PorTUI
cd PorTUI
uv sync
uv run portui

Run as a module

uv run python -m portui

Keyboard Shortcuts

Key Action
↑/↓ or j/k Navigate rows
Enter Show full port/process details
/ Focus filter input (Escape to clear and exit)
h Cycle protocol filter (Both → TCP → UDP)
c Toggle column configuration
s Cycle sort column (Port → IP → Proto → Process → PID → User → State → Command)
t Toggle tree view (htop-style process hierarchy)
x Kill selected process
r Manual refresh
p Pause/resume auto-refresh
i Set refresh interval
? Show help
q Quit

Requirements

  • Python 3.9+
  • uv (for uvx usage)

Development

git clone https://github.com/lowtrak/PorTUI
cd PorTUI
uv sync --group dev
uv run pytest

Project structure

portui/
├── __init__.py      # Public exports
├── __main__.py      # python -m portui entry point
├── app.py           # PortUIApp (main TUI application)
├── collector.py     # PortDataCollector (psutil, kill logic)
├── config.py        # ConfigManager (load/save/validate)
├── models.py        # PortInfo dataclass
├── screens.py       # All Screen subclasses
├── sort.py          # SortController
└── tree.py          # ProcessTreeBuilder (htop-style tree)

tests/
├── test_config.py   # ConfigManager validation (15 tests)
├── test_filter.py   # Filter mode UI (8 tests)
├── test_kill.py     # Kill + PID recycling guard (9 tests)
├── test_sort.py     # Sort all columns (21 tests)
└── test_tree.py     # Tree view (7 tests)

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

portui-0.1.6.tar.gz (13.8 kB view details)

Uploaded Source

Built Distribution

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

portui-0.1.6-py3-none-any.whl (17.3 kB view details)

Uploaded Python 3

File details

Details for the file portui-0.1.6.tar.gz.

File metadata

  • Download URL: portui-0.1.6.tar.gz
  • Upload date:
  • Size: 13.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for portui-0.1.6.tar.gz
Algorithm Hash digest
SHA256 d3ff2640e22e705133b1a2fa7ab8cf856b253c61d7cb630f3bbfe8ebd295738b
MD5 bebce5afc9b9b5a0488ac08e9b818f1d
BLAKE2b-256 a099a1207fab5a8b010441fcd0b9bd4c7a1ea6d83c5a5371ae4a890cabd5b84f

See more details on using hashes here.

Provenance

The following attestation bundles were made for portui-0.1.6.tar.gz:

Publisher: publish.yml on lowtrak/PorTUI

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file portui-0.1.6-py3-none-any.whl.

File metadata

  • Download URL: portui-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 17.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for portui-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 d8d5f0589fccc72c3f84325616f397b5b5a2a8e8d51d48d5ea27d20889bd9b09
MD5 103aa5630338979218772d96ae016b53
BLAKE2b-256 f72bc27927d20454f60883c087664fdc3aa83c9c8071da73e6d62f117785b705

See more details on using hashes here.

Provenance

The following attestation bundles were made for portui-0.1.6-py3-none-any.whl:

Publisher: publish.yml on lowtrak/PorTUI

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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