# mz-debug

Materialize debug tool for self-managed and emulator environments.




> For the complete documentation index, see [llms.txt](https://preview.materialize.com/materialize/40269/llms.txt).


`mz-debug` is a command-line interface tool that collects debug information for self-managed and emulator Materialize environments. By default, the tool creates a compressed file (`.zip`) containing logs and a dump of the system catalog. You can then share this file with support teams when investigating issues.

## Install `mz-debug`



**macOS:**

```shell
sudo echo "Preparing to extract mz-debug..."
curl -L "https://binaries.materialize.com/mz-debug-latest-arm64-apple-darwin.tar.gz" \
| sudo tar -xzC /usr/local --strip-components=1
```

**Linux:**
```shell
ARCH=$(uname -m)
sudo echo "Preparing to extract mz-debug..."
curl -L "https://binaries.materialize.com/mz-debug-latest-$ARCH-unknown-linux-gnu.tar.gz" \
| sudo tar -xzC /usr/local --strip-components=1



### Get version and help

To see the version of `mz-debug`, specify the `--version` flag:

```shell
mz-debug --version
```

To see the options for running `mz-debug`,

```shell
mz-debug --help
```

## Next steps

To run `mz-debug`, see
- [`mz-debug self-managed`](https://preview.materialize.com/materialize/40269/markdown-docs/developer-tools/mz-debug/self-managed/index.md)
- [`mz-debug emulator`](https://preview.materialize.com/materialize/40269/markdown-docs/developer-tools/mz-debug/emulator/index.md)


## Pages in this section

- [mz-debug emulator](https://preview.materialize.com/materialize/40269/markdown-docs/developer-tools/mz-debug/emulator/index.md): Use mz-debug to debug Materialize Emulator environments running in Docker.
- [mz-debug self-managed](https://preview.materialize.com/materialize/40269/markdown-docs/developer-tools/mz-debug/self-managed/index.md): Use mz-debug to debug Self-Managed Materialize Kubernetes environments.