Command Line Interface

Create, extract and inspect LittleFS filesystem images. Use one of the commands listed below, the ‘-h’ / ‘–help’ option can be used on each command to learn more about the usage.

usage: littlefs-python [-h] [--version] {create,unpack,list} ...

Named Arguments

--version

show program’s version number and exit

Available Commands

command

Possible choices: create, unpack, list

Sub-commands

create

Create LittleFS image from directory content

littlefs-python create [-h] [-v] --block-size BLOCK_SIZE [--name-max NAME_MAX]
                       (--block-count BLOCK_COUNT | --fs-size FS_SIZE) --image
                       IMAGE
                       source

Positional Arguments

source

Source Directory

Named Arguments

-v, --verbose

Default: 0

--block-size

LittleFS block size

--name-max

LittleFS max file path length.

Default: 255

--block-count

LittleFS block count

--fs-size

LittleFS filesystem size

--image

LittleFS filesystem image

unpack

Unpack LittleFS image to directory

littlefs-python unpack [-h] [-v] --block-size BLOCK_SIZE [--name-max NAME_MAX]
                       (--block-count BLOCK_COUNT | --fs-size FS_SIZE) --image
                       IMAGE
                       destination

Positional Arguments

destination

Destination Directory

Named Arguments

-v, --verbose

Default: 0

--block-size

LittleFS block size

--name-max

LittleFS max file path length.

Default: 255

--block-count

LittleFS block count

--fs-size

LittleFS filesystem size

--image

LittleFS filesystem image

list

List LittleFS image content

littlefs-python list [-h] [-v] --block-size BLOCK_SIZE [--name-max NAME_MAX]
                     (--block-count BLOCK_COUNT | --fs-size FS_SIZE) --image
                     IMAGE

Named Arguments

-v, --verbose

Default: 0

--block-size

LittleFS block size

--name-max

LittleFS max file path length.

Default: 255

--block-count

LittleFS block count

--fs-size

LittleFS filesystem size

--image

LittleFS filesystem image