o
      o   /---o
     /---/---o
o---/
     \---\---o
      o   \---o
            o

Cyme

List system USB buses and devices; a modern lsusb that attempts to maintain compatibility with, but also add new features. Includes a macOS system_profiler SPUSBDataType parser module and libusb profiler for non-macOS systems/gathering more verbose information.

The project started as a quick replacement for the barely working lsusb script and is my yearly Rust project to keep up to date! Like most fun projects, it quickly experienced feature creep as I developed it into a cross-platform replacement for lsusb. As a developer of embedded devices, I use a USB list tool on a frequent basis and developed this to cater what I believe at the short comings of lsusb; verbose dump is too verbose, tree doesn't contain useful data on the whole, it barely works on non-Linux platforms and modern terminals support features that make glancing through the data easier.

It's not perfect as it started out as a Rust refresher but I had a lot of fun developing it and hope others will find it useful and can contribute. Reading around the lsusb source code, USB-IF and general USB information was also a good knowledge builder.

The name comes from the technical term for the type of blossom on a Apple tree: cyme - it is Apple related and also looks like a USB device tree 😃🌸.

Features

• Compatible with lsusb using --lsusb argument. Supports all arguments including --verbose output using libusb. Output is identical for use with no args (list), almost matching for tree (driver port number not included) and near match for verbose.
• Filters like lsusb but that also work when printing --tree. Adds --filter_name, --filter_serial and option to hide empty --hide-buses/--hide-hubs.
• Improved --tree mode; shows device, configurations, interfaces and endpoints as tree depending on level of --verbose.
• Modern terminal features with coloured output, utf-8 characters and icons. Can be turned off and customised.
• Can be used as a library too with system_profiler parsing module, lsusb module using libusb and display module for printing amongst others.
• --json output that honours filters and --tree.
• Targets for Linux, macOS, perhaps Windows...

Planned Features for 1.0.0 Release

• Controllable block data like lsd --blocks
• Modern drawing of device tree with utf-8 boxes.
• Nerd font icon look up and icon theming like lsd --icon.
• libusb optional to get more USB data and support other OS with switch from system_profiler.
• Group by in list mode.
• udev support on Linux to get device driver etc.
• Interface and Device Descriptor icon look up.
• Drawing of headers.
• Tree support of all device interfaces and endpoints.
• --device devpath arg to dump single device.
• Merge of macOS system_profiler output with libusb output to keep non-user Apple buses.
• Integration tests for lsusb output.
• User defined icon map and colour import.
• XDG_CONFIG_HOME default read config and merge with Args - non-Option merge would be nice.
• Integration tests for internal bin operation.

Feature Ideas

• Fully decode device class based base class on tables at USB-IF.
• Support 'auto', 'always', 'never' or icon, colours, utf-8 etc.
• Print format for width constrained devices? Can remove blocks with args but maybe there is a different format to consider.

Install

For pre-compiled binaries, see the releases.

From crates.io with a Rust tool-chain installed: cargo install cyme. To do it from within a local clone: cargo install --path ..

If wishing to use only macOS system_profiler and not obtain more verbose information, remove the 'libusb' feature with cargo install --no-default-features cyme

I also have a Homebrew tap, which will also install a man page and completions:

brew tap tuna-f1sh/taps
brew install cyme

Linux udev

To obtain device and interface drivers being used on Linux like lsusb, one must install 'libudev-dev' via a package manager and the --features udev feature when building. Only supported on Linux targets.

Alias lsusb

If one wishes to create a macOS version of lsusb or just use this instead, create an alias one's environment with the --lsusb compatibility flag:

alias lsusb='cyme --lsusb'

Usage

Will cover this more as it develops. Use cyme --help for basic usage or man ./doc/cyme.1.

For usage as a library, the crate is 100% documented so look at docs.rs

Config

cyme will check for a 'cyme.json' config file in:

• Linux: "$XDG_CONFIG_HOME or $HOME/.config"
• macOS: "$HOME/Library/Application Support"
• Windows: "{FOLDERID_RoamingAppData}"

One can also be supplied with --config. Copy or refer to './doc/cyme_example_config.json' for configurables. Supplied args will override these. Use --debug to see where it is looking or if it's not loading.

Custom Icons and Colours

See './doc/cyme_example_config.json' for an example of how icons can be defined and also the docs. The config can exclude the "user"/"colours" keys if one wishes not to define any new icons/colours.

Icons are looked up in an order of User -> Default. For devices: VidPid -> VidPidMsb -> Vid -> UnknownVendor -> get_default_vidpid_icon, classes: ClassifierSubProtocol -> Classifier -> UndefinedClassifier -> get_default_classifier_icon. User supplied colours override all internal; if a key is missing, it will be None.