Skip to content
Branch: master
Find file History

Waiter CLI


To install the Waiter CLI, clone this repo and from this folder run:

pip3 install -e .

This will install the waiter command on your system.


In order to use the Waiter CLI, you'll need a configuration file. waiter looks first for a .waiter.json file in the current directory, and then for a .waiter.json file in your home directory. The path to this file may also be provided manually via the command line with the --config option.

There is a sample .waiter.json file included in this directory, which looks something like this:

  "clusters": [
      "name": "dev0",
      "url": "",
      "disabled": false
      "name": "dev1",
      "url": "",
      "disabled": true

Each entry in the clusters array conforms to a cluster specification ("spec"). A cluster spec requires a name and a url pointing to a Waiter cluster.


The fastest way to learn more about waiter is with the -h (or --help) option.

All global options (--cluster, --config, etc.) can be provided when using subcommands.

  • create: You can create a token with create.
  • show: You can view a token's details with show.
You can’t perform that action at this time.