Skip to main content

Memfault Command

memfault

The root command for the Memfault CLI.

Description

The root command for the Memfault CLI. All subcommands are grouped underneath this command. This command provides common options to each of the subcommands.

Options

OptionShortRequiredDefaultDescription
--emailNoneFalseNone

Account email to authenticate with

--passwordNoneFalseNone

Account password or user API key to authenticate with

--project-keyNoneFalseNone

Memfault Project Key

--org-tokenNoneFalseNone

Organization Auth Token

--orgNoneFalseNone

Organization slug

--projectNoneFalseNone

Project slug

--urlNoneFalseNone

None

--verboseNoneFalseFalse

Log verbosely

--versionNoneFalseFalse

Show the version and exit.

--helpNoneFalseFalse

Show this message and exit.

Subcommands

SubcommandDescription
completion

Generate shell completion script for memfault.

console

Open a serial terminal and automatically post chunks to Memfault

deploy-release

Publish a Release to a Cohort.

post-chunk

Sends data generated by the memfault-firmware-sdk ("chunks") to the Memfault cloud.

upload-android-app-symbols

Upload symbols & R8/ProGuard mapping for an Android app build.

upload-aosp-symbols

Upload symbols for an Android OS/AOSP build.

upload-bugreport

Upload an Android Bug Report for analysis by Memfault.

upload-coredump

Upload an MCU coredump for analysis.

upload-custom-data-recording

Upload a custom data recording (read: any file that might help you with debugging).

upload-elf-coredump

Upload a Linux ELF coredump for analysis by Memfault.

upload-elf-symbols

Upload symbols from a tarball of binaries

upload-mar

Upload a Memfault Archive File (mar) file for analysis.

upload-mcu-symbols

Upload symbols for an MCU build.

upload-ota-payload

Upload a binary to be used for an OTA update.

upload-software-version-sbom

Upload an SBOM (Software Bill of Materials) in JSON, XML, or YAML format.

upload-symbols

[DEPRECATED] Upload symbols for an MCU or Android build.

upload-xed

Upload an .xed or .xcd file for analysis.

upload-yocto-symbols

Upload symbols for a Linux Yocto build.