Home

Hecate offers several commands as well as some default command line options. hecate -h or hecate --help will display the common command line options and the available commands. User hecate help <command> to get help on a specific command.

usage: hecate [-h] [--verbose] [--consul-host CONSUL_HOST]
              [--consul-port CONSUL_PORT] [--consul-token CONSUL_TOKEN]
              [--consul-data-center CONSUL_DATA_CENTER] [--consul-verify-ssl]
              {provision,list,get,delete,sync,config,daemon} ...

optional arguments:
  -h, --help            show this help message and exit
  --verbose, -v         Be verbose
  --consul-host CONSUL_HOST, -ch CONSUL_HOST
                        The Consul host
  --consul-port CONSUL_PORT, -cp CONSUL_PORT
                        The Consul port
  --consul-token CONSUL_TOKEN, -ct CONSUL_TOKEN
                        The Consul authentication token
  --consul-data-center CONSUL_DATA_CENTER, -cd CONSUL_DATA_CENTER
                        The Consul data center
  --consul-verify-ssl, -cv
                        Verify SSL of Consul host

Valid commands:
  command

  {provision,list,get,delete,sync,config,daemon}

Common Options

• --help - Displays the help for Hecate. When used with a sub-command displays the help specific to that sub-command
• --verbose - Enable verbose logging. It is recommended to use the -v variant of this flag if you want to specify the log level to use
  • -v - logging.ERROR
  • -vv - logging.WARNING
  • -vvv - logging.INFO
  • -vvvv - logging.DEBUG
• --consul-host - Overrides any global or user config for the Consul host to connect to
• --consul-port - Overrides any global or user config for the Consul port to connect to
• --consul-token - Overrides any global or user config for the auth token to use for connecting to Consul
• --consul-data-center - Overrides and global or user config for the Consul data center to connect to
• --consul-verify-ssl - When present will force the Consul connection to connect over SSL

Commands

• provision - seeds a public key to Consul, creating a private/public key pair is necessary
• list - lists users in Consul, or the keys for a specific user
• get - retrieves the public key for a user/host combination
• delete - deletes a user from Consul, or a specific key for a user
• sync - synchronizes the authorized_keys for all, or a specific user/s
• config - displays or edits the Consul configuration
• daemon - runs the Hecate daemon