4 stable releases
1.0.10 | Nov 10, 2023 |
---|---|
1.0.9 | Oct 18, 2023 |
1.0.8 | Sep 17, 2023 |
1.0.7 | Aug 25, 2023 |
#119 in Parser implementations
115 downloads per month
645KB
12K
SLoC
minijinja-cli
minijinja-cli
is a command line executable that uses
MiniJinja to render Jinja2 templates
directly from the command line to stdout.
cargo install minijinja-cli
minijinja-cli my-template.j2 data.json
Arguments
minijinja-cli
has two positional arguments to refer to files. Either one of them can
be set to -
to read from stdin. This is the default for the template, but only one
can be set to stdin at once.
[TEMPLATE]
: the first argument is the filename of the template. If not provided it defaults to-
which means it loads the template from stdin.[DATA]
: the second argument is the path to the data file. This is a file which holds input variables that should be rendered. Various file formats are supported. When data is read fromstdin
,--format
must be specified as auto detection is based on file extensions.
Options
-f
,--format
<FORMAT>
: this defines the input format of the data file. The default isauto
which turns on auto detection based on the file extension. For the supported formats see the next section.-a
,--autoescape
<MODE>
: picks an auto escape mode. The default is auto detection (auto
) based on file extension. The options arenone
to disable escaping,html
to enable HTML/XML escaping,json
to enable JSON (YAML compatible) serialization.-D
,--define
<EXPR>
: defines a variable from an expression. The supported formats areNAME
to define the variableNAME
with the valuetrue
,NAME=VALUE
to define the variableNAME
with the valueVALUE
as string orNAME:=VALUE
to set the variableNAME
to the YAML interpreted valueVALUE
. When YAML support is not enabled,:=
only supports JSON.--strict
: enables strict mode. Undefined variables will then error upon rendering.--no-include
: disallows including or extending of templates from the file system.--env
: passes the environment variables to the template in the variableENV
-E
,--expr
<EXPR>
: rather than rendering a template, evaluates an expression instead. What happens with the result is determined by--expr-out
.--expr-out
<MODE>
: sets the expression output mode. The default isprint
.print
just prints the expression output,json
emits it as JSON serialized value andstatus
hides the output but reports it as exit status.true
converts to0
andfalse
converts to1
. Numeric results are returned unchanged.--fuel
<AMOUNT>
: sets the maximum fuel for the engine. When the engine runs out of fuel it will error.--repl
: spawns an interactive read-eval print loop for MiniJinja expressions.--dump
<KIND>
: prints internals of the template. Possible options aretokens
to see the output of the tokenizer,ast
to see the AST after parsing, andinstructions
to inspect the compiled bytecode.--version
: prints the version.--help
: prints the help.
Formats
The following formats are supported:
json
(*.json
,*.json5
): JSON5 (or JSON if JSON5 is not compiled in)yaml
(*.yaml
,*.yml
): YAMLtoml
(*.toml
): TOMLcbor
(*.cbor
): CBORquerystring
(*.qs
): URL encoded query strings
Examples
Render a template with a string and integer variable:
minijinja-cli template.j2 -D name=World -D count:=3
Render a template with variables from stdin:
echo '{"name": "World"}' | minijinja-cli -f json template.j2 -
Evaluate an expression and print the result:
minijinja-cli --env -E "ENV.HOME or ENV.USERPROFILE"
REPL:
minijinja-cli --repl -D name=World
MiniJinja Expression REPL
Type .help for help. Use .quit or ^D to exit.
>>> name|upper
"WORLD"
>>> range(3)
[0, 1, 2]
Behavior
Templates can extend other templates or include them. Paths are relative to the
parent template. So when you are in foo/bar.j2
and you include utils.j2
it will load foo/utils.j2
. Including of templates can be disabled for
security reasons with --no-include
.
All filters and functions from MiniJinja and minijinja-contrib
are available.
Upon failure a stack trace is rendered to stderr.
The repl
mode lets you execute MiniJinja expressions.
Compile-Time Features
By default all features are enabled. The following features can be explicitly selected when the defaults are turned off:
yaml
: enables YAML supporttoml
: enables TOML supportcbor
: enables CBOR supportjson5
: enables JSON5 support (instead of JSON)querystring
: enables querystring supportdatetime
: enables the date and time filters andnow()
function
Sponsor
If you like the project and find it useful you can become a sponsor.
License and Links
- Issue Tracker
- License: Apache-2.0
Dependencies
~1.6–4MB
~70K SLoC