Commands

Commands

This page lists the commands of the firestarter CLI in release 3.1.0. Each command accepts --help.

firestarter [OPTIONS] COMMAND [ARGS]

Global options

Put these options before the command, for example firestarter -p /dev/ttyACM0 read AM27C256.

Option	What it does
-p, --port	Use this serial port for this command.
-v, --verbose	Show more output.
--version	Show the CLI version.

Chip commands

Command	What it does	Page
search	Finds chips in the database by part number.	Reading Chips
list	Lists all chips in the database.	Reading Chips
info	Shows the database data, the pin layout and the jumper settings of a chip.	Reading Chips
id	Reads the manufacturer and device ID of the chip.	Reading Chips
read	Reads a chip to a file.	Reading Chips
blank	Tells you if a chip is blank.	Writing and Verifying
write	Writes a binary file to a chip.	Writing and Verifying
verify	Compares a chip with a file.	Writing and Verifying
erase	Erases a chip, if the chip family has an erase command.	Writing and Verifying

Board commands

Command	What it does	Page
fw	Shows the firmware version. -i installs the firmware.	Install
hw	Shows the hardware revision of the shield.	Shield Revisions
vpp, vpe	Show the voltage of the VPP and VPE rails while you set the potentiometer.	Shield Revisions
config	Shows or sets the revision override and the resistor values on the board.	Shield Revisions

Diagnostic commands

Command	What it does	Page
dev test	Tests a chip on your hardware and makes a report.	Testing Chips
dev read	Reads a chip and shows the data on the screen.	Reading Chips

A pre-release has more dev commands. Refer to Beta Channel.

Files

The CLI keeps its files in ~/.firestarter. If you set the environment variable FIRESTARTER_CONFIG_DIR, it uses that directory.

File	Contents
config.json	The serial port and the avrdude path that the CLI found last. The CLI writes it. You do not edit it.
database.json	Your own chip entries. They have priority over the shipped database. Refer to Chip Database Fields.
pin-maps.json	Your own pin maps. They have priority over the shipped pin maps.

To get tab completion for these commands, refer to Shell Completion.