1. Download the file faultycmd-vx.x.x.exe from the releases section of the FaultyCat-TUI repository.

2. Run the installer and follow the Inno Setup wizard. Leave "Add FaultyCat to PATH" checked so faultycmd is callable from any terminal.

3. To confirm the tool is running fine, open a new terminal session and use the command:

faultycmd

System requirements:

• macOS 11 (Big Sur) or newer
• Intel or Apple Silicon Mac

1. Check your architecture first:

uname -m

• arm64 → Apple Silicon installer
• x86_64 → Intel installer

1. Download faultycmd-x.x.x-x86_64.pkg from the releases section.
2. Open a terminal in the download location and run:

sudo installer -allowUntrusted -pkg faultycmd-x.x.x-x86_64.pkg -target /

1. Download faultycmd-x.x.x-arm64.pkg from the releases section.
2. Open a terminal in the download location and run:

sudo installer -allowUntrusted -pkg faultycmd-x.x.x-arm64.pkg -target /

Both .pkg variants install to /usr/local/opt/faultycmd/ and symlink the binary to /usr/local/bin/faultycmd.

faultycmd setup-env

This installs udev-equivalent permissions for the FaultyCat USB CDC interfaces and adds your user to the dialout group where applicable. Log out and back in for group changes to apply.

1. Download faultycmd-x.x.x.deb from the releases section.
2. Open a new terminal session and run the following commands:

sudo dpkg -i faultycmd-x.x.x.deb
sudo apt-get install -f   # resolve any missing dependencies

3. Verify the installation with:

faultycmd --help

1. Download faultycmd-x.x.x.pkg.tar.zst from the releases section.

2. Verify the installation with:

sudo pacman -U faultycmd-x.x.x.pkg.tar.zst

1. Clone the repository:

git clone https://github.com/ElectronicCats/faultycat-TUI.git

2. Enter the directory where the repository was saved:

cd faultycat-TUI

3. Create a virtual environment (recommended):

python3 -m venv venv

4. Activate the virtual environment:

   • Linux and macOS:

   source venv/bin/activate

   • Windows:

   venv\Scripts\activate

5. Install in editable mode:

make install
# equivalent to: pip install -e .

Or build a standalone PyInstaller binary instead:

make compile-install

This runs pyinstaller faultycmd.spec and copies the result to /usr/local/bin/faultycmd (requires sudo).

sudo faultycmd setup-env

This installs /etc/udev/rules.d/99-faultycat.rules for non-root access to VID 1209 / PID FA17, and adds the invoking user ($SUDO_USER) to the dialout group. Log out and back in for the group change to take effect.

faultycmd completion install            # auto-detects bash/zsh/fish

Restart your shell afterwards. Not supported on Windows.

The faultycmd la pulseview command automatically configures the firmware's SUMP/OLS mode and attempts to launch PulseView using shutil.which("pulseview"). For this to work, PulseView must be installed and accessible via your system's PATH. A raw AppImage downloaded directly from the website will fail to launch because its filename contains version and build hashes (e.g., pulseview-NIGHTLY-x86_64-debug_.AppImage), preventing the system from recognizing it by the simple pulseview name.

Follow the instructions below to set up Pulseview.

1. Download the AppImage from the official download page: https://sigrok.org/wiki/Downloads

2. Save the AppImage file (pulseview-NIGHTLY-x86_XX-debug.AppImage) to a directory that is easy to access (e.g. Documents/Apps).

3. Open a terminal session in the path where the AppImage is located.

4. Run the command below to make it executable:

chmod +x ~/Documents/Apps/pulseview-*.AppImage

Place it wherever you save the AppImage, ~/Documents/Apps is just a convention used here.

5. Expose it as pulseview on PATH:

mkdir -p ~/.local/bin

ln -sf ~/Docuemtns/Apps/pulseview-*.AppImage ~/.local/bin/pulseview

6. Verify that the setup has been correctly done:

which pulseview

pulseview --version

1. Go to: Settings > Apps > Installed Apps
2. Search for FaultyCat.
3. Click on the three-dot menu on the right side and click on Uninstall.

Alternatively, you can run the installer and choose "Remove".

1. Open a new terminal session and run the following command:

   • Debian/Ubuntu

     sudo dpkg -r faultycmd

   • Arch

     sudo pacman -R faultycmd

1. Open a new terminal session and run the following commands:

sudo rm -rf /usr/local/opt/faultycmd

sudo rm -f /usr/local/bin/faultycmd

1. Open a new terminal session and run the following commands:

make uninstall