The Memfault CLI tool is a simple command-line program which purpose is to make integrations with the Memfault cloud from other systems, like continuous integration servers, as easy as possible.
Under the hood, the tool acts as a client to Memfault's HTTP API.
The Memfault CLI tool is written in Python and published publicly in the Python Package Index (pypi).
To install it, make sure you have a recent version of Python 3.x installed.
Use a virtualenv to avoid conflicts with dependencies of other projects that use Python.
pip3 install memfault-cli to install it.
Once installed, the
memfault command should be available in your shell:
There are four different ways to authenticate using the Memfault CLI.
- With a user email and password
- With a user email and user API key
- With a Memfault Project key
- With an Organization Auth token
Not all commands will work with every authentication method. Below shows which commands require which forms of authentication.
|Command||Email + Password||Email + API key||Organization Token||Project Key|
To use email and password authentication, pass
To use an Organization auth token, pass
--org-token with the contents of your
Organization Auth token after the
To use a Memfault Project key, pass
--project-key after the
If you are going to be working with the same project you can add standard arguments as environment variables to your shell init file or via the command line:
With these changes, the invocation reduces to: