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

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

Commands also support partial matching. YAML8n 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 Yaml8n commands into your terminal:

$ source <(yaml8n autocomplete)

docs

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

generate [path]

Generate code for the outputs specified within the Translations located at path.

jq

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

translate [path]

Add missing translations for the Translations located at path using Google Cloud Translation API. See Guides/Add Missing Translations for more information.

validate [path]

Lint and validate the Translations located at path.

version

Print the current version of Yaml8n.

watch [path]

Watch the Translations located at path for changes and generate code for the outputs specified within on change.