Overview

Jumppad is controlled via a very easy to use command-line interface (CLI). Jumppad is only a single command-line application: jumppad, which takes a subcommand such as up or status. The complete list of subcommands is in the navigation to the left.

Help

The Jumppad CLI is a well-behaved command line application. In erroneous cases, a non-zero exit status will be returned. It also responds to -h and --help as you would most likely expect.

To view a list of the available commands at any time, just run Jumppad with no arguments. To get help for any specific subcommand, run the subcommand with the -h argument.

Each command has been conveniently documented on this website. Links to each command can be found on the left.

Autocomplete

Jumppad's CLI supports command autocomplete. Autocomplete can be installed or uninstalled by running the following on bash, zsh or fish shells:

jumppad completion [bash|zsh|fish|powershell]

Loading completions for your shell.

source <(yourprogram completion bash)

# To load completions for each session, execute once:
# Linux:
jumppad completion bash > /etc/bash_completion.d/jumppad

# macOS:
jumppad completion bash > /usr/local/etc/bash_completion.d/jumppad

Environment variables

Jumppad can use environment variables to configure command-line tool options. These environment variables can be overridden as needed using individual flags.

  • Name
    LOG_LEVEL
    Type
    (string: info)
    Required
    Readonly
    Description

    Set the log level for the jumppad command to either debug, info, warning or error.