Skip to content

Commit dd46e36

Browse files
chevdorchevdor
committed
Prepare for new version
1 parent fb72fcc commit dd46e36

2 files changed

Lines changed: 45 additions & 117 deletions

File tree

‎README.md‎

Lines changed: 24 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
## Intro
44

5-
![tera cli logo 256](resources/logo/tera-cli-logo_256.png)
5+
<figure>
6+
<img src="resources/logo/tera-cli-logo_256.png" alt="tera cli logo 256" />
7+
</figure>
68

79
[tera](https://github.com/Keats/tera) is a template engine written in Rust and inspired by Jinja2. It allows merging some data called `context data` into a template and produces a new output. This project, `tera-cli`, is a command line for the [tera template engine](https://github.com/Keats/tera).
810

@@ -186,61 +188,24 @@ Passing the `-a | --escape` flag allows escaping the content.
186188

187189
## Usage
188190

189-
teracli 0.2.2
190-
chevdor <chevdor@gmail.com>
191-
Command line utility for the tera templating engine. You need to provide a template using the tera
192-
syntax as well as some data (various format are supported)
193-
194-
USAGE:
195-
tera [OPTIONS] --template <TEMPLATE> [CONTEXT]
196-
197-
ARGS:
198-
<CONTEXT> Location of the context data. This file can be of the following type: json |
199-
toml | yaml. If you prefer to pass the data as stdin, use `--stdin`
200-
201-
OPTIONS:
202-
-a, --escape
203-
Auto-escape rendered content. This is useful for HTML output
204-
205-
-e, --env
206-
If true, the current ENV will be appended to the data under the --env-key key
207-
208-
--env-first
209-
By default, the context is made of the data you pass and the ENV is applied afterwards.
210-
Setting this option will apply the ENV first. This is interesting if you prefer your
211-
data to override the ENV
212-
213-
--env-key <ENV_KEY>
214-
By default, if --env is set, the environment variables will be attached at the root of
215-
the context. This is convenient but may end up conflicting with your data. To prevent
216-
collisions, you can provide a custom key with this option
217-
218-
--env-only
219-
If you want to solely use the ENV as context, you may pass this option. This will
220-
prevent an error about no context being passed to be raised
221-
222-
--fail-on-collision
223-
if you prefer your data to override the ENV
224-
225-
-h, --help
226-
Print help information
227-
228-
-i, --include
229-
This flag tells the command to parse all templates found in the same path where the
230-
given template is located [aliases: inherit]
231-
232-
--include-path <INCLUDE_PATH>
233-
Option to define a different path from which search and parse templates [aliases:
234-
inherit-path]
235-
236-
-o, --out <OUT>
237-
Optional output file. If not passed, using stdout
238-
239-
-s, --stdin
240-
The context data can be passed using stdin
241-
242-
-t, --template <TEMPLATE>
243-
Location of the template
244-
245-
-V, --version
246-
Print version information
191+
Command line utility for the tera templating engine. You need to provide a template using the tera syntax as well as some data (various format are supported)
192+
193+
Usage: tera [OPTIONS] --template <TEMPLATE> [CONTEXT]
194+
195+
Arguments:
196+
[CONTEXT] Location of the context data. This file can be of the following type: json | toml | yaml. If you prefer to pass the data as stdin, use `--stdin`
197+
198+
Options:
199+
-t, --template <TEMPLATE> Location of the template
200+
-i, --include This flag tells the command to parse all templates found in the same path where the given template is located [aliases: inherit]
201+
--include-path <INCLUDE_PATH> Option to define a different path from which search and parse templates [aliases: inherit-path]
202+
-s, --stdin The context data can be passed using stdin
203+
-e, --env If true, the current ENV will be appended to the data under the --env-key key
204+
--env-key <ENV_KEY> By default, if --env is set, the environment variables will be attached at the root of the context. This is convenient but may end up conflicting with your data. To prevent collisions, you can provide a custom key with this option
205+
--env-first By default, the context is made of the data you pass and the ENV is applied afterwards. Setting this option will apply the ENV first. This is interesting if you prefer your data to override the ENV
206+
--fail-on-collision if you prefer your data to override the ENV
207+
--env-only If you want to solely use the ENV as context, you may pass this option. This will prevent an error about no context being passed to be raised
208+
-o, --out <OUT> Optional output file. If not passed, using stdout
209+
-a, --escape Auto-escape rendered content. This is useful for HTML output
210+
-h, --help Print help
211+
-V, --version Print version

‎doc/usage.adoc‎

Lines changed: 21 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -1,58 +1,21 @@
1-
teracli 0.2.2
2-
chevdor <chevdor@gmail.com>
3-
Command line utility for the tera templating engine. You need to provide a template using the tera
4-
syntax as well as some data (various format are supported)
5-
6-
USAGE:
7-
tera [OPTIONS] --template <TEMPLATE> [CONTEXT]
8-
9-
ARGS:
10-
<CONTEXT> Location of the context data. This file can be of the following type: json |
11-
toml | yaml. If you prefer to pass the data as stdin, use `--stdin`
12-
13-
OPTIONS:
14-
-a, --escape
15-
Auto-escape rendered content. This is useful for HTML output
16-
17-
-e, --env
18-
If true, the current ENV will be appended to the data under the --env-key key
19-
20-
--env-first
21-
By default, the context is made of the data you pass and the ENV is applied afterwards.
22-
Setting this option will apply the ENV first. This is interesting if you prefer your
23-
data to override the ENV
24-
25-
--env-key <ENV_KEY>
26-
By default, if --env is set, the environment variables will be attached at the root of
27-
the context. This is convenient but may end up conflicting with your data. To prevent
28-
collisions, you can provide a custom key with this option
29-
30-
--env-only
31-
If you want to solely use the ENV as context, you may pass this option. This will
32-
prevent an error about no context being passed to be raised
33-
34-
--fail-on-collision
35-
if you prefer your data to override the ENV
36-
37-
-h, --help
38-
Print help information
39-
40-
-i, --include
41-
This flag tells the command to parse all templates found in the same path where the
42-
given template is located [aliases: inherit]
43-
44-
--include-path <INCLUDE_PATH>
45-
Option to define a different path from which search and parse templates [aliases:
46-
inherit-path]
47-
48-
-o, --out <OUT>
49-
Optional output file. If not passed, using stdout
50-
51-
-s, --stdin
52-
The context data can be passed using stdin
53-
54-
-t, --template <TEMPLATE>
55-
Location of the template
56-
57-
-V, --version
58-
Print version information
1+
Command line utility for the tera templating engine. You need to provide a template using the tera syntax as well as some data (various format are supported)
2+
3+
Usage: tera [OPTIONS] --template <TEMPLATE> [CONTEXT]
4+
5+
Arguments:
6+
[CONTEXT] Location of the context data. This file can be of the following type: json | toml | yaml. If you prefer to pass the data as stdin, use `--stdin`
7+
8+
Options:
9+
-t, --template <TEMPLATE> Location of the template
10+
-i, --include This flag tells the command to parse all templates found in the same path where the given template is located [aliases: inherit]
11+
--include-path <INCLUDE_PATH> Option to define a different path from which search and parse templates [aliases: inherit-path]
12+
-s, --stdin The context data can be passed using stdin
13+
-e, --env If true, the current ENV will be appended to the data under the --env-key key
14+
--env-key <ENV_KEY> By default, if --env is set, the environment variables will be attached at the root of the context. This is convenient but may end up conflicting with your data. To prevent collisions, you can provide a custom key with this option
15+
--env-first By default, the context is made of the data you pass and the ENV is applied afterwards. Setting this option will apply the ENV first. This is interesting if you prefer your data to override the ENV
16+
--fail-on-collision if you prefer your data to override the ENV
17+
--env-only If you want to solely use the ENV as context, you may pass this option. This will prevent an error about no context being passed to be raised
18+
-o, --out <OUT> Optional output file. If not passed, using stdout
19+
-a, --escape Auto-escape rendered content. This is useful for HTML output
20+
-h, --help Print help
21+
-V, --version Print version

0 commit comments

Comments
 (0)