Command-Line InterfaceΒΆ

The command-line interface (CLI) makes most of the C API available from the command-line. The purpose of the CLI are manifold:

  • The CLI source code serve as example code of using the C API
  • The CLI itself provide tools for experimentation and debugging
  • A supplement to unit-testing the C API

Usage of the CLI is described by invoking the commands prefixed with nvm_ without arguments and examples of their use are given in the following sections.

Additionally, a set of Environment Variables environment variables modify the behavior of the CLI commands.

Note

This CLI is not meant to be tool for conditioning or initialitization of Open-Channel SSDs, for such purposes see lnvm-tools and NVMe CLI