Skip to main content

Memfault CLI tool

Project description

Memfault CLI tool

This package contains the memfault CLI tool.

The purpose of the tool is to make integration with Memfault from other systems, like continuous integration servers, as easy as possible.

Install the tool and run memfault --help for more info!

Changes

[1.8.0] - 2026-03-06

  • Add the --org-token option for authenticating with an Organization Auth Token (OAT). This is now the recommended way to pass OATs to the CLI. Previously, the documented approach was to pass the OAT via --password:

    memfault --password "$ORGANIZATION_AUTH_TOKEN" ...
    

    This should now be updated to use --org-token:

    memfault --org-token "$ORGANIZATION_AUTH_TOKEN" ...
    

    Passing an OAT via --password is deprecated and will be removed in a future release.

  • Update virtualenv dependency to >=20.36.1 to address this security disclosure.

[1.7.2] - 2026-02-05

  • Fix a bug where upload-yocto-symbols and upload-elf-symbols would fail on Python 3.14 with tarfile.AbsoluteLinkError when extracting tarballs that contain absolute symlinks (e.g. Yocto's /etc/localtime).

[1.7.1] - 2026-01-13

[1.7.0] - 2025-12-15

[1.6.0] - 2025-04-23

  • Add support for uploading ELF files without DWARF debug info.

[1.5.0] - 2024-11-14

  • Add support for Python 3.13: remove unnecessary version constraints on the chardet + lxml dependencies.

[1.4.0] - 2024-11-12

  • Populate a User-Agent string in the headers of all requests to Memfault Cloud to identify the CLI version used for diagnostics. Previously the User-Agent was only included for chunk POST requests.

[1.3.0] - 2024-11-07

  • Remove support for Python 3.6 + 3.7

[1.2.0] - 2024-08-28

  • Add the upload-software-version-sbom command. Look at the SBOM docs for more info.

[1.1.0] - 2024-07-22

  • Add a user-agent string to chunk POST requests to identify CLI version used for diagnostics.

  • Fixups with ruff (RET504)

[1.0.11] - 2024-06-28

  • Add an option --no-check-uploaded for upload-mcu-symbols to skip an initial check if the symbol file already exists. This option should be used with Org Tokens limited to only uploading symbol file

  • Bump urllib3 dependency to 1.26.19

  • Fixups with ruff 0.4.10

[1.0.10] - 2024-06-13

[1.0.9] - 2024-04-04

  • Add Miniterm help text when launching the memfault console command, to indicate how to exit the console (Ctrl-]).

1.0.8

  • Add Apache 2 license

1.0.7

  • Fix bug when deactivating delta releases when multiple deployments match the filters.

1.0.6

1.0.5

  • Add support for deactivating delta releases.

1.0.4

  • Add upload-elf-symbols command for uploading ELF files with debug symbols built outside of a Yocto environment
  • Add upload-elf-coredump for uploading a Linux coredump to Memfault

1.0.3

  • Fix a bug where upload-aosp-symbols would fail when uploading too many files at once.

1.0.2

  • Fix a bug where upload-yocto-symbols would fail when some files in the tarballs provided did not have the read permission set.

1.0.1

  • Fix upload-custom-data-recording to print a more helpful error message when exceeding device rate limits.

1.0.0

Note: this release is marked as 1.0.0 but does not contain any breaking changes! The version number was bumped to reflect the maturity of the tool.

  • Fix upload-mcu-symbols to skip uploading if the symbol file has already been uploaded, and return a zero exit code in this case

0.18.1

  • Add the --deactivate option to deploy-release, which disables a release for a cohort

0.18.0

  • Add new extra-metadata option to upload-ota-payload to attach custom metadata to that OTA release. The metadata will be returned from Memfault Cloud when fetching the latest Android OTA release.
  • Continue uploading the entire folder of symbols even if any single upload fails due to the symbol file being too large.

0.17.0

  • Add new console command to read SDK exported chunks via a serial port and automatically upload to Memfault.

0.16.0

  • Add support for uploading Android debug symbols from alternative build systems.

0.15.3

  • Warn if a non-slug string is passed to the --project or --org arguments

0.15.2

  • Don't truncate help output from click when the CI environment variable is set, for consistent output formatting

0.15.1

  • Fix some compatibility issues for python3.6 + python3.7

0.15.0

  • 💥 Breaking change: update the upload-yocto-symbols subcommand to take two image paths as required arguments; one for the root filesystem image, and another for the debug filesystem image. Versions 0.14.0 and lower used to take a guess at the path of the debug filesystem image from the value passed to the --image param. To avoid confusion and to support all configurations, the Memfault CLI no longer does any guessing and now takes two separate params: --image and --dbg-image

0.14.0

  • ✨ Update the post-chunk subcommand to split uploads into batches of 500 chunks per upload, to avoid timing out when uploading very large chunk logs

0.13.0

  • 💥 Breaking change: Renamed subcommand upload-debug-data-recording to custom-data-recording

0.12.0

  • ✨ Added subcommand upload-debug-data-recording for uploading debug data files

0.11.0

  • ✨ Enable support for Yocto Dunfell based projects (previously supported Kirkstone only)

0.10.0

  • ✨ Upload-yocto-symbols now uploads additional symbol files

0.9.0

  • ✨ Expanded support for .elf uploading with the upload-yocto-symbols subcommand

0.8.0

  • ✨ Initial support for upload-yocto-symbols subcommand

0.7.0

  • 🐛 Updated to correctly only use the GNU build-id .note section

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

memfault_cli-1.8.0.tar.gz (39.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

memfault_cli-1.8.0-py3-none-any.whl (41.0 kB view details)

Uploaded Python 3

File details

Details for the file memfault_cli-1.8.0.tar.gz.

File metadata

  • Download URL: memfault_cli-1.8.0.tar.gz
  • Upload date:
  • Size: 39.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.2

File hashes

Hashes for memfault_cli-1.8.0.tar.gz
Algorithm Hash digest
SHA256 bcc7321b758e0de7d721c96f07c732016965f08b2d2d8a42960282fff2af7330
MD5 142b743a897416fb5c4c8c969a377063
BLAKE2b-256 fdc5271c521404b1338de1c320652b9487fd3a5f91d5afab0fccc15b7cb337eb

See more details on using hashes here.

File details

Details for the file memfault_cli-1.8.0-py3-none-any.whl.

File metadata

  • Download URL: memfault_cli-1.8.0-py3-none-any.whl
  • Upload date:
  • Size: 41.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.2

File hashes

Hashes for memfault_cli-1.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 012f0e98f07f3479a8871dbdfaedcbf8bad406a7f4a4d9aeea730feea3b2446d
MD5 f89544e5f3420cfe99d63167f93b660a
BLAKE2b-256 87471f0b4f42f0d12ffdd759b37983edb3d676c656517a04d2ba1efacb7c829d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page