4. FaultyCMD Installation

Installation instructions

Windows

1. Download the file faultycmd_vx.x.x.x.exe from the releases section of the FaultyCat repository.

2. Go to the directory where the faultycmd_vx.x.x.x.exe was saved and open a new terminal.

3. To confirm the tool is running fine, use the command:

.\faultycmd_vx.x.x.x.exe info

Note

From the directory the .exe lives in (PowerShell or cmd.exe), the .\ prefix is required so the shell runs the local file instead of searching PATH: .\faultycmd_vX.Y.Z.W.exe info. If you want a shorter command, rename the file (e.g. to faultycmd.exe); invocations then become .\faultycmd.exe info. And if you move that renamed file into a folder that is already on your PATH, the .\ can be dropped too and you can simply type faultycmd info from anywhere.

If FaultyCat is installed using the latest firmware, you will see an output showing the board's ports:

faultycmd vx.x.x.x (host)
   FaultyCat CDC interfaces
┏━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━┓
┃   IF ┃ role        ┃ device ┃
┡━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━┩
│ 0x00 │ emfi        │ COM12  │
│ 0x02 │ crowbar     │ COM14  │
│ 0x04 │ scanner     │ COM13  │
│ 0x06 │ target-uart │ COM15  │
└──────┴─────────────┴────────┘
firmware: vx.x.x.x  (match)

Example:

Linux / macOS / Windows-with-Python

Requirements:

• Python
• pip

1. Download the Host CLI/TUI wheel (Linux / macOS / Windows pip) (faultycmd-x.x.x.x-py3-none-any.whl) or the Host source distribution file (faultycmd-x.x.x.x.tar.gz) from the releases section of the FaultyCat repository.

2. Go to the directory where the *faultycmd-x.x.x.x-py3-none-any.whl or faultycmd-x.x.x.x.tar.gz was saved and open a new terminal.

3. Create a Python virtual environment by using the commands:

python -m venv venv 

4. Activate the virtual environment:

• Linux and macOS:

source venv/bin/activate

• Windows:

.\venv\Scripts\Activate.ps1
# or, from the CMD
venv\Scripts\activate.bat

4. Once the virtual environment is activated, run the command:

pip install faultycmd-x.x.x.x-py3-none-any.whl
# or, from the source tarball:
pip install faultycmd-x.x.x.x.tar.gz

5. To confirm the tool is running fine, use the command:

faultycmd info

If FaultyCat is installed using the latest firmware, you will see an output showing the board's ports:

faultycmd vx.x.x.x (host)
   FaultyCat CDC interfaces
┏━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━┓
┃   IF ┃ role        ┃ device ┃
┡━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━┩
│ 0x00 │ emfi        │ COM12  │
│ 0x02 │ crowbar     │ COM14  │
│ 0x04 │ scanner     │ COM13  │
│ 0x06 │ target-uart │ COM15  │
└──────┴─────────────┴────────┘
firmware: vx.x.x.x  (match)

Example:

Linux.faultycmd-x.x.x.x.tar.gz.installation.workflow.webm