# AMD SMI CLI tool

A command line tool for manipulating and monitoring the `amdgpu` kernel;
`amd-smi` is intended to replace and deprecate the existing
[`rocm-smi`](https://github.com/rocm/rocm_smi_lib) CLI tool.

When using the CLI tool, you should have at least one AMD GPU and the driver
installed.

>[!NOTE]
>The AMD SMI CLI tool is provided as an example code to aid the development of
>telemetry tools. The Python or C++ library is recommended as a robust data
>source.

Find the documentation in the `docs/` directory.

- [Install AMD SMI](../docs/install/install.md)
- [About the tool and how to get started](../docs/how-to/amdsmi-cli-tool.md)

## Online documentation

Explore the latest documentation on the [ROCm documentation
portal](https://rocm.docs.amd.com/projects/en/latest/index.html).

- [Install AMD SMI](https://rocm.docs.amd.com/projects/amdsmi/en/latest/install/install.html)

- [CLI tool usage](https://rocm.docs.amd.com/projects/amdsmi/en/latest/how-to/amdsmi-cli-tool.html).

