Usage#

circman#

Manager for CircuitPython project deployment.

circman [OPTIONS] COMMAND [ARGS]...

Options

--version#

Show the version and exit.

deploy#

Copy the source directory to the device directory.

circman deploy [OPTIONS]

Options

-d, --device <device>#

Required CIRCUITPY path. If not provided, autodiscovery is attempted.

-s, --source <source>#

Required Directory to deploy. Defaults to “src”.

list#

List backups that can be restored.

circman list [OPTIONS]

restore#

Restore a backup.

circman restore [OPTIONS]

Options

-d, --device <device>#

Required CIRCUITPY path. If not provided, autodiscovery is attempted.

-a, --archive <archive>#

Number of backup to restore. Use the list command to find the backup number. Defaults to restoring the most recent backup.

sync#

Copy the device directory to the source directory.

This will overwrite files in dest without prompting and without backup so use with caution.

circman sync [OPTIONS]

Options

-d, --device <device>#

Required CIRCUITPY path. If not provided, autodiscovery is attempted.

-D, --dest <dest>#

Required Destination directory. Defaults to “src”.