Skip to content

vzaliva/whatcable-linux-cli

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

WhatCable-Linux

What can this USB cable actually do?

A command-line tool that tells you, in plain English, what each USB device plugged into your Linux machine can actually do.

WhatCable-Linux is a Linux port of WhatCable, a macOS menu bar app by Darryl Morley. This port expands the original USB-C focus to cover all USB devices, while preserving the rich USB-C Power Delivery diagnostics from the original.

This repository is forked from Zetaphor/whatcable-linux.

What it shows

All USB devices

  • Device identity: vendor, product name, serial number
  • Speed: negotiated link speed (1.5 Mbps to 20 Gbps)
  • USB version: 1.1, 2.0, 3.0, 3.1, 3.2
  • Power draw: how much power the device is consuming
  • Device type: HID, Audio, Mass Storage, Hub, etc.
  • Driver: which kernel driver is handling the device
  • Topology: hub hierarchy showing what's plugged into what

USB-C ports (additional detail)

  • Port roles: data role (host/device), power role (source/sink)
  • Cable e-marker info: cable speed capability, current rating (3A/5A), active vs passive, cable vendor
  • Charger PDO list: every voltage/current profile the charger advertises, with the active profile highlighted
  • Charging diagnostics: identifies bottlenecks — cable limiting speed, charger undersized, etc.
  • Partner identity: decoded from PD Discover Identity VDOs

Install

Build from source

Requires C++20, CMake, pkg-config, libudev headers, and a filesystem library (std::filesystem, provided by your toolchain).

# Ubuntu / Debian
sudo apt install build-essential cmake pkg-config libudev-dev

# Fedora
sudo dnf install gcc-c++ cmake pkgconf-pkg-config systemd-devel

# Arch / Manjaro
sudo pacman -S --needed base-devel cmake pkgconf systemd-libs

Build and optionally install:

cmake -B build -DCMAKE_INSTALL_PREFIX=/usr
cmake --build build
sudo cmake --install build   # optional

The whatcable-linux binary is build/src/cli/whatcable-linux if you skip install.

Usage

whatcable-linux              # human-readable summary of every USB device
whatcable-linux --json       # structured JSON output
whatcable-linux --watch      # stream updates as devices come and go
whatcable-linux --raw        # include raw sysfs attributes
whatcable-linux --version
whatcable-linux --help

How it works

WhatCable-Linux reads three areas of the Linux sysfs virtual filesystem. No root access required for basic info:

sysfs path What it gives us
/sys/bus/usb/devices/ All USB devices: vendor, product, speed, power, class, interfaces, topology
/sys/class/typec/ USB-C port state: connection, roles, cable e-marker, partner identity
/sys/class/usb_power_delivery/ PD negotiation: PDO list from charger, active profile, PPS ranges

Hotplug monitoring uses libudev to detect connect/disconnect events in real time.

Cable speed and power decoding follow the USB Power Delivery 3.x spec, ported from the original WhatCable's Swift implementation.

Caveats

  • USB-C/PD data availability varies by hardware. The Type-C connector class and USB PD sysfs interfaces depend on the kernel driver (UCSI, TCPM, platform-specific). Some systems expose full PD negotiation data; others expose only basic port info or nothing at all.
  • Cable e-marker info only appears for cables that carry one. Same as the original — most USB-C cables under 60W are unmarked.
  • WhatCable trusts the e-marker. Counterfeit or mis-flashed cables can lie about their capabilities.
  • Vendor name lookup is not exhaustive. Common vendors are recognized; others show the hex VID.

Credits

Upstream Linux/KDE codebase: Zetaphor/whatcable-linux.

WhatCable-Linux is a port of WhatCable by Darryl Morley. The USB Power Delivery decoding logic, charging diagnostics, vendor database, and plain-English summary approach are derived from the original macOS app.

License

MIT

About

A linux/KDE port of whatcable, a tool to tell you what each USB connected cable can do

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • C++ 98.7%
  • CMake 1.3%