Skip to main content

The Topaz CLI


topaz is available on Linux, macOS and Windows platforms.

  • Via Homebrew for macOS or LinuxBrew for Linux

    brew tap aserto-dev/tap && brew install aserto-dev/tap/topaz
  • Via WinGet for Windows 10+

    winget install Aserto.Topaz
  • On Windows 10+

    Download the topaz_windows_x86_64.msi file from the GitHub releases page and execute the MSI.

  • Via a GO install

    go install


Usage: topaz <command> [flags]

Topaz CLI

start start topaz instance (daemon mode)
stop stop topaz instance
restart restart topaz instance
status status of topaz daemon process
config configure topaz instance
run start topaz instance (console mode)
templates template commands
console open topaz console in the browser
directory (ds) directory commands
authorizer (az) authorizer commands
certs certificate management
install install topaz container
uninstall uninstall topaz container
update update topaz container version
version version information

-h, --help Show context-sensitive help.
-N, --no-check disable local container status check ($TOPAZ_NO_CHECK)
-L, --log log level

Run "topaz <command> --help" for more information on a command.

If you don't add the Topaz self-signed certs to your trust chain, you'll need to execute most commands that interact with Topazd using the -i (insecure) flag.