CLI

Arguments

Arguments must be entered before commands.

-c [path]

Path to the JSON/Jsonnet configuration file.

-f [format]

Set log format (human, kv, raw, default: human).

-l [level]

Set minimum log level (none, debug, info, error, default: info).

-p

Disable paging via less.

-s [status]

Set the minimum status for error message logging.

-x [key=value]

Set config key=value (can be provided multiple times).

Commands

Tunlr comes with a list of default Commands, but you can add custom Commands using Macros–Command templates that live within the Tunlr configuration.

Commands also support partial matching. Tunlr will attempt to match a partial CLI command (like cfg) to the longest matching command or macro (in this instance, config).

autocomplete

Adds autocomplete for Tunlr commands into your terminal:

$ source <(tunlr autocomplete)

client

Run Tunlr in client mode. See Guides > Client for more details.

config

Show the rendered config from all sources (file, environment variables, and command line arguments).

docs

Open a web browser to the documentation website (this website).

eula

View the Tunlr End User License Agreement (EULA).

jq

Query JSON from stdin using jq. Supports standard JQ filters, and the -r flag to render raw values.

keys

Generate cryptographic keys for server JWT signing.

password

Generate a password hash for Config > server_staticUsernames_passwordHash.

server

Run Tunlr in server mode. See Guides > Server for more details.

version

Print the current version of Tunlr.