hwlib
| Crates.io | hwlib |
| lib.rs | hwlib |
| version | 0.11.0 |
| created_at | 2025-06-23 07:32:48.801765+00 |
| updated_at | 2025-12-17 14:56:25.413728+00 |
| description | Tool for checking Ubuntu hardware certification status |
| homepage | https://github.com/canonical/hardware-api/ |
| repository | https://github.com/canonical/hardware-api/ |
| max_upload_size | |
| id | 1722562 |
| size | 122,578 |
Nadzeya Hutsko (nadzyah)
documentation
README
Hardware API Client
The Hardware API Client is the tool to check the certification status of hardware configurations.
It consists of both the hwlib library and hwctl CLI tool.
hwlib: Rust library for communicating with the API server.hwctl: CLI tool leveraging thehwliblibrary.
Basic Usage
To check the machine certification status, simply run hwctl with
root1 privileges:
sudo hwctl
To send the request to a different server than the default,
specify the HW_API_URL environment variable:
sudo HW_API_URL=https://your.server.url hwctl
Installation
hwctl is available on all major Linux distributions.
On snap-ready systems, you can install it on the command-line with:
sudo snap install hwctl
On Questing Quokka (25.10), you can also install it using apt:
sudo apt-get install hwctl
Community and Support
You can report any issues, bugs, or feature requests on the project's GitHub repository.
Contribute to the Hardware API Client
The Hardware API Client is open source. Contributions are welcome.
If you're interested, start with the client contribution guide.
License and Copyright
The Hardware API Client is released under the LGPL-3.0 license
© 2025 Canonical Ltd.
Footnotes
-
The client requires root access since we collect the hardware information using SMBIOS data. ↩