faultycmd is the host-side tool for the FaultyCat v3 board: a
click+Rich CLI and Textual TUI for driving electromagnetic fault injection
(EMFI), voltage-glitch (crowbar) attacks, SWD/JTAG target scanning, I2C bus
probing, target-UART passthrough, and automated parameter sweeps
(campaigns) over FaultyCat's USB CDC composite interface. Built and
maintained by Electronic Cats / PWNLab.
Warning
FaultyCat is a fault-injection tool intended solely for authorized security research and testing on hardware you own or have explicit permission to test. Electronic Cats/PWNLab holds no responsibility for unauthorized use or resulting damage.
Packaged installers (.deb, .pkg.tar.zst, macOS .pkg, Windows .exe)
are published on the releases page.
To install from source:
git clone https://github.com/ElectronicCats/faultycat-TUI.git
cd faultycat-TUI
python3 -m venv venv && source venv/bin/activate
make install # equivalent to: pip install -e .See docs/01-Installation.md for full per-OS
instructions, including PyInstaller binary builds and post-install setup
(faultycmd setup-env).
faultycmd devices # list detected FaultyCat CDC interfaces
faultycmd verify # smoke-test EMFI, crowbar, scanner, and UART
faultycmd tui # launch the interactive Textual dashboardSee docs/03-Quick-Reference.md for the full command table and docs/02-Usage-Guide.md for step-by-step workflows.
| Doc | What's in it |
|---|---|
| 00-Overview.md | Project snapshot and stack |
| 01-Installation.md | Per-OS install steps, prerequisites, uninstall |
| 02-Usage-Guide.md | Step-by-step workflows: devices/verify, EMFI, crowbar, campaign, scanner, I2C, UART, logic analyzer, TUI |
| 03-Quick-Reference.md | Full command table + exit codes |
| 04-Troubleshooting.md | Common failure modes and fixes |
| PULSEVIEW_SETUP.md | Wiring PulseView to la pulseview |
| WINDOWS_SUMP_DTR_ISSUE.md | Windows DTR root-cause analysis |
FaultyCat Firmware lives in a separate repository for better version control and issue tracking:
https://github.com/ElectronicCats/faultycat-firmware
faultycmd update fetches and flashes the firmware build matching this
host tool's version.
All FaultyCat Hardware is tracked in its own repository:
https://github.com/ElectronicCats/FaultyCat
Contributions are welcome!
Please read the document Contribution Manual which will show you how to contribute your changes to the project.
✨ Thanks to all our contributors! ✨
See Electronic Cats CLA for more information.
See the community code of conduct for a vision of the community we want to build and what we expect from it.