knap

1# Knap
2 
3Use Knap CLI to render Markdown templates with variables, filters, and logic.
4 
5If not installed: `npm install -g knap` (requires Node.js 20 or later). Alternatively, use `npx knap`.
6 
7Run `knap --help` for available commands and options. Discover the language through the CLI's offline reference:
8 
9```bash
10knap help syntax
11knap help filters
12knap help filter date
13knap help tags
14knap help tag for
15```
16 
17Use the lists to find names, then request individual help for syntax, parameters, and examples with expected output.
18 
19## Usage
20 
21Render a template with JSON variables:
22 
23```bash
24knap render template.md --data article.json -o note.md
25```
26 
27Supply a template and data inline:
28 
29```bash
30knap render -t '# {{ title | trim }}' --data-json '{"title":"Hello"}'
31```
32 
33Override a variable or pipe JSON data:
34 
35```bash
36knap render template.md --data article.json --set 'title=Custom title'
37cat article.json | knap render template.md --data -
38```
39 
40Data must be a JSON object; its properties become template variables. `--set` overrides literal top-level keys with strings. Use JSON for nested objects, arrays, numbers, and booleans.
41 
42Choose one template source (file, `-t`, or stdin) and one data source (`--data` or `--data-json`). Only one input can read stdin. Without a template file or `-t`, Knap reads the template from stdin.
43…