tofupilot units

Last updated on May 21, 2026

The units command manages Units, which are the units under test.

ls

The ls subcommand lists and filters units. The full filter list is: --search-query, --ids, --serial-numbers, --part-numbers, --revision-numbers, --batch-numbers, --procedure-ids, --outcomes, --started-after, --started-before, --latest-only, --run-count-min, --run-count-max, --created-after, --created-before, --created-by-user-ids, --created-by-station-ids, --exclude-units-with-parent, --samples, --limit, --cursor, --sort-by, --sort-order, --metadata, and --include-metadata.

list units
tofupilot units ls --part-numbers PCB01 --latest-only true

get

The get subcommand fetches one unit by serial number.

get unit
tofupilot units get --serial-number SN-0001

create

The create subcommand creates a unit. Required flags are --serial-number, --part-number, and --revision-number. Optional flags are --sample (golden or failing) and --metadata (JSON).

create unit
tofupilot units create --serial-number SN-0001 --part-number PCB01 --revision-number A

update

The update subcommand updates a unit by serial number, and optional flags are --new-serial-number, --part-number, --revision-number, --batch-number, --attachments, --sample, and --metadata.

update unit
tofupilot units update --serial-number SN-0001 --batch-number BATCH-2026-05

add-child

The add-child subcommand links a sub-unit under a parent unit.

add sub-unit
tofupilot units add-child --serial-number SN-PARENT --child-serial-number SN-CHILD

remove-child

The remove-child subcommand unlinks a sub-unit from its parent.

remove sub-unit
tofupilot units remove-child --serial-number SN-PARENT --child-serial-number SN-CHILD

create-attachment

The create-attachment subcommand initializes a file attachment on a unit.

attach to unit
tofupilot units create-attachment --serial-number SN-0001 --name calibration.pdf

delete-attachment

The delete-attachment subcommand deletes one or more attachments from a unit.

delete attachment
tofupilot units delete-attachment --serial-number SN-0001 --ids att_1 att_2

rm

The rm subcommand deletes one or more units by serial number.

delete units
tofupilot units rm --serial-numbers SN-0001 SN-0002

How is this guide?

On this page