Light Dark Auto

Install the Greymatter CLI

The CLI lets you interact with the mesh without needing to handcraft API calls.


Download the binaries for your operating system, substituting your credentials in curl’s --user flag.

Mac OS Linux
curl -u <your email>:<your identity token> -O \ 
tar -xvf greymatter-cli_4.7.7_darwin_amd64.tar.gz
curl -u <your email>:<your identity token> -O  \ \
tar -xvf greymatter-cli_4.7.7_linux_amd64.tar.gz

Move the binary to somewhere on your $PATH (like /usr/local/bin).

Verify Your Installation

After moving the binary to your path, verify your installation by running the greymatter command.

$ greymatter  
   greymatter - The official greymatter application networking command line interface.

   greymatter [global options] command [command options] [arguments...]

   v4.8.0 ad3a8c7

   The greymatter CLI is used to interact with the application networking platform.

   apply        create or replace an entire mesh object with input from a file or stdin
   create       create a mesh object
   delete       delete a mesh object
   edit         edit a mesh object interactively
   get          get a mesh object by ID
   init         Initialize a greymatter CUE module.
   list         list mesh objects by type
   modify, mod  modify an existing object; note: zones cannot be modified
   sync         Sync a CUE module directory tree of greymatter configurations to a mesh.
   upgrade      Upgrade a greymatter CUE module.
   help, h      Shows a list of commands or help for one command

   --api value               A fully qualified URL for the control API
   --base64-config value     base64 encoded TOML config file
   --catalog value           A fully qualified URL for the catalog API
   --config value, -c value  Path to config file (default: "/Users/kylegallagher/.config/greymatter/config.toml") [$GREYMATTER_CONFIG]
   --log-level value         (default: "info")
   --help, -h                show help (default: false)
   --version, -v             print the version (default: false)

The --help flag also works on subcommands.

greymatter SUBCOMMAND --help

If you receive an error after running the greymatter command:

  • verify your PATH includes the location where you moved the binary
  • check the binary’s file permissions (it should be executable)
  • ensure you downloaded the correct binary for your system.


greymatter is configurable via flags, environment variables, and a config file. The default path for a config file is $HOME/.config/greymatter/config.toml, but an alternative path can be specified with the --config flag or the GREYMATTER_CONFIG environment variable.

See the CLI Configuration docs for more information.

Next Steps

Follow our guide to Install with GitOps.