CLI Interface¶

Here’s a description of all the commands and options not-my-board supports.

Commands¶

hub [-h|--help]: Start the board farm Hub. There should be only one hub in the entire network.
export [-h|--help] [--cacert cacert] hub_url export_description: Make connected boards and equipment available in the board farm.
agent [-h|--help] [--cacert] hub_url: Start an Agent.
reserve [-h|--help] [-v|--verbose] [-n|--with-name name] import_description: Reserve a Place.
return [-h|--help] [-v|--verbose] name: Return a reserved Place.
attach [-h|--help] [-v|--verbose] [-k|--keep-others] name|import_description: Attach a reserved Place. As a convenience this will also implicitly reserve the Place, if it’s not reserved, yet.
detach [-h|--help] [-v|--verbose] [-k|--keep] name: Detach an attached Place. By default this will also return the reservation: Use --keep to keep the reservation.
list [-h|--help] [-v|--verbose] [-n|--no-header]: List reserved Places.
status [-h|--help] [-v|--verbose] [-n|--no-header]: Show status of attached places and its interfaces.
uevent [-h|--help] [-v|--verbose] devpath: Handle Kernel uevent for USB devices. This should be called by the device manager, e.g. udev(7).

--cacert cacert¶: Load additional CA certificates to trust when using TLS. cacert is a path to a file of concatenated CA certificates in PEM format. Can be used multiple times to load more than one file. System default CA certificates are always trusted.

import_description¶: Path to an import description file or name of an import description. If a name is given, then the file is searched for in ./.not-my-board/<name>.toml of the current working directory and every parent up to either $HOME or /. If it’s not found, then it falls back to $XDG_CONFIG_HOME/not-my-board/<name>.toml or ~/.config/not-my-board/<name>.toml if $XDG_CONFIG_HOME is not set.