Skip to main content

Overview

Installation​

Installation and configuration instructions are available here. The CLI reads configuration from $HOME/.signadot/config.yaml (override with --config flag). See the config file reference for details about configuration options and environment variables.

Usage​

In most cases, the CLI uses the pattern of signadot <entity> <verb>, where <entity> is a Signadot entity such as a Sandbox, RouteGroup, Resource, or JobRunnerGroup and <verb> is some operation on the entity such as an upsert or deletion.

Once you have installed the CLI, you can get a feel for the commands using the help command.

signadot help

Each command may have command-specific flags and nested sub-commands, which you can see by running:

signadot help <command>

Templates​

Many commands accept YAML input. In many contexts YAML values may be dynamic whereas their skeleton or template is stored in a file. The YAML templates documentation provides information about templating YAML with the Signadot CLI.