[{"_1":2,"_172":-5,"_173":-5},"loaderData",{"_3":4,"_13":14,"_20":21,"_151":152},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","routes/_layout",{"_15":-5,"_16":17,"_18":17,"_19":11},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","routes/_layout.r.$namespace.$reponame",{"_22":23,"_24":-5,"_25":11,"_26":11,"_27":28,"_29":30,"_31":-5,"_32":11,"_33":34,"_83":84,"_105":106,"_144":-5,"_145":11,"_146":17,"_147":11,"_148":-5,"_149":150},"canonicalUrl","https://hub.docker.com/r/gepardec/j2cli/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","gepardec","reponame","j2cli","cloudBuildSource","isAutobuildsAvailable","repo",{"_35":36,"_37":38,"_40":41,"_42":43,"_44":11,"_45":46,"_47":48,"_49":50,"_52":30,"_27":28,"_53":54,"_55":39,"_56":57,"_58":59,"_60":61,"_62":-5,"_63":57,"_64":65,"_66":11,"_67":28,"_68":69,"_74":11,"_75":76,"_80":28,"_81":82},"categories",[],"content_types",[39],"image","date_registered","2020-02-21T10:38:24.072557Z","description","","is_private","last_updated","2020-03-18T11:41:32.026627Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[51],"application/vnd.docker.container.image.v1+json","name","pull_count",9376,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","[![](https://img.shields.io/travis/com/gepardec/docker-j2cli/master?style=flat-square)](https://travis-ci.com/gepardec/docker-j2cli)\n![Docker Pulls](https://img.shields.io/docker/pulls/gepardec/j2cli?color=brightgreen&style=flat-square)\n![gplv3](https://img.shields.io/badge/license-GPL%20v3.0-brightgreen.svg?style=flat-square)\n![Maintenance](https://img.shields.io/maintenance/yes/2020?style=flat-square)\n

\n $\"gepardec\"$ \n

\n
\n
\n\n# docker-j2cli\n\nIf you want to work with jinja templates from your commandline and want to reduce the risk of \"works on my machine\". Try our j2cli container image.\n\n## Bonus Features\n* base64 encoding and decoding filters for your kubernetes resource files\n\n---\n\n## Preflight\n\nOkay, the whole point is to avoid installing j2 cli on our workstations. To avoid local installation we will use container technology as our abstraction layer.\n\nTherefore we will need to install a container runtime. Please install `docker` on your workstation if you haven't done so already.\n\nIn order to make it easier to use j2 as a container a few bash functions are available in the `bashrc` of the git [repository](https://github.com/gepardec/docker-j2cli). I really recommend that you source the [bashrc](https://raw.githubusercontent.com/gepardec/docker-j2cli/master/bashrc) - it abstracts away all the options and parameter used in the docker command for you. In the next section you will see why.\n\n```\nsource bashrc\n```\n\nHowever it is not just black magic - all commands that are available via the bashrc in this repository will be printed before execution to increase transparency.\n\n---\n\n### Run your j2 command in a container\n\nJust like you would run your j2 command locally you can do so with the `bashrc` function `docker-j2cli`. e.g. to get the cli version of the `j2cli` image you are using simply run\n\n```\ndocker-j2cli j2 --version\n```\n\nwhich wraps following command for ease of use\n\n```\ndocker run --rm -it -e TZ=Europe/Vienna -v /home/myuser/path/to/your/current/directory:/mnt gepardec/j2cli j2 --version\n```\n\nAs you can see the container you are using is deleted after it ran with `--rm`, set the timezone to Europe/Vienna, mount your current directory into the container to alter files on your workstation from the container.\n\n---\n\n## Tutorial\n\nSuppose, you want to have an nginx configuration file template, `nginx.j2`:\n\n```jinja2\nserver {\n listen 80;\n server_name {{ nginx.hostname }};\n\n root {{ nginx.webroot }};\n index index.htm;\n}\n```\n\nAnd you have a JSON file with the data, `nginx.json`:\n\n```json\n{\n \"nginx\":{\n \"hostname\": \"localhost\",\n \"webroot\": \"/var/www/project\"\n }\n}\n```\n\nThis is how you render it into a working configuration file:\n\n```bash\n$ j2 -f json nginx.j2 nginx.json > nginx.conf\n```\n\nThe output is saved to `nginx.conf`:\n\n```\nserver {\n listen 80;\n server_name localhost;\n\n root /var/www/project;\n index index.htm;\n}\n```\n\nAlternatively, you can use the `-o nginx.conf` option.\n\n## Tutorial with environment variables\n\nSuppose, you have a very simple template, `person.xml`:\n\n```jinja2\n{{ name }}{{ age }}\n```\n\nWhat is the easiest way to use j2 here?\nUse environment variables in your bash script:\n\n```bash\n$ export name=Andrew\n$ export age=31\n$ j2 /tmp/person.xml\nAndrew31\n```\n\n## Using environment variables\n\nEven when you use yaml or json as the data source, you can always access environment variables\nusing the `env()` function:\n\n```jinja2\nUsername: {{ login }}\nPassword: {{ env(\"APP_PASSWORD\") }}\n```\n\n\n## Usage\n\nCompile a template using INI-file data source:\n\n $ j2 config.j2 data.ini\n \nCompile using JSON data source:\n\n $ j2 config.j2 data.json\n \nCompile using YAML data source (requires PyYAML):\n\n $ j2 config.j2 data.yaml\n\nCompile using JSON data on stdin:\n\n $ curl http://example.com/service.json | j2 --format=json config.j2\n\nCompile using environment variables (hello Docker!):\n \n $ j2 config.j2\n \nOr even read environment variables from a file:\n\n $ j2 --format=env config.j2 data.env\n\nOr pipe it: (note that you'll have to use the \"-\" in this particular case):\n\n $ j2 --format=env config.j2 - < data.env\n\n \n# Reference\n`j2` accepts the following arguments:\n\n* `template`: Jinja2 template file to render\n* `data`: (optional) path to the data used for rendering.\n The default is `-`: use stdin. Specify it explicitly when using env!\n\nOptions:\n\n* `--format, -f`: format for the data file. The default is `?`: guess from file extension.\n* `--import-env VAR, -e EVAR`: import all environment variables into the template as `VAR`.\n To import environment variables into the global scope, give it an empty string: `--import-env=`.\n (This will overwrite any existing variables!)\n* `-o outfile`: Write rendered template to a file\n* `--undefined`: Allow undefined variables to be used in templates (no error will be raised)\n\n* `--filters filters.py`: Load custom Jinja2 filters and tests from a Python file.\n Will load all top-level functions and register them as filters.\n This option can be used multiple times to import several files.\n* `--tests tests.py`: Load custom Jinja2 filters and tests from a Python file.\n* `--customize custom.py`: A Python file that implements hooks to fine-tune the j2cli behavior.\n This is fairly advanced stuff, use it only if you really need to customize the way Jinja2 is initialized.\n See [Customization](#customization) for more info.\n\nThere is some special behavior with environment variables:\n\n* When `data` is not provided (data is `-`), `--format` defaults to `env` and thus reads environment variables\n* When `--format=env`, it can read a special \"environment variables\" file made like this: `env > /tmp/file.env`\n\n## Formats\n\n\n### env\nData input from environment variables.\n\nRender directly from the current environment variable values:\n\n $ j2 config.j2\n\nOr alternatively, read the values from a dotenv file:\n\n```\nNGINX_HOSTNAME=localhost\nNGINX_WEBROOT=/var/www/project\nNGINX_LOGS=/var/log/nginx/\n```\n\nAnd render with:\n\n $ j2 config.j2 data.env\n $ env | j2 --format=env config.j2\n\nIf you're going to pipe a dotenv file into `j2`, you'll need to use \"-\" as the second argument to explicitly:\n\n $ j2 config.j2 - < data.env\n\n### ini\nINI data input format.\n\ndata.ini:\n\n```\n[nginx]\nhostname=localhost\nwebroot=/var/www/project\nlogs=/var/log/nginx/\n```\n\nUsage:\n\n $ j2 config.j2 data.ini\n $ cat data.ini | j2 --format=ini config.j2\n\n### json\nJSON data input format\n\ndata.json:\n\n```\n{\n \"nginx\":{\n \"hostname\": \"localhost\",\n \"webroot\": \"/var/www/project\",\n \"logs\": \"/var/log/nginx/\"\n }\n}\n```\n\nUsage:\n\n $ j2 config.j2 data.json\n $ cat data.json | j2 --format=ini config.j2\n\n### yaml\nYAML data input format.\n\ndata.yaml:\n\n```\nnginx:\n hostname: localhost\n webroot: /var/www/project\n logs: /var/log/nginx\n```\n\nUsage:\n\n $ j2 config.j2 data.yml\n $ cat data.yml | j2 --format=yaml config.j2\n\n\n\n\nExtras\n======\n\n## Filters\n\n\n### `docker_link(value, format='{addr}:{port}')`\nGiven a Docker Link environment variable value, format it into something else.\n\nThis first parses a Docker Link value like this:\n\n DB_PORT=tcp://172.17.0.5:5432\n\nInto a dict:\n\n```python\n{\n 'proto': 'tcp',\n 'addr': '172.17.0.5',\n 'port': '5432'\n}\n```\n\nAnd then uses `format` to format it, where the default format is '{addr}:{port}'.\n\nMore info here: [Docker Links](https://docs.docker.com/userguide/dockerlinks/)\n\n### `env(varname, default=None)`\nUse an environment variable's value inside your template.\n\nThis filter is available even when your data source is something other that the environment.\n\nExample:\n\n```jinja2\nUser: {{ user_login }}\nPass: {{ \"USER_PASSWORD\"|env }}\n```\n\nYou can provide the default value:\n\n```jinja2\nPass: {{ \"USER_PASSWORD\"|env(\"-none-\") }}\n```\n\nFor your convenience, it's also available as a function:\n\n```jinja2\nUser: {{ user_login }}\nPass: {{ env(\"USER_PASSWORD\") }}\n```\n\nNotice that there must be quotes around the environment variable name\n\n\n\n\nCustomization\n=============\n\nj2cli now allows you to customize the way the application is initialized:\n\n* Pass additional keywords to Jinja2 environment\n* Modify the context before it's used for rendering\n* Register custom filters and tests\n\nThis is done through *hooks* that you implement in a customization file in Python language.\nJust plain functions at the module level.\n\nThe following hooks are available:\n\n* `j2_environment_params() -> dict`: returns a `dict` of additional parameters for\n [Jinja2 Environment](http://jinja.pocoo.org/docs/2.10/api/#jinja2.Environment).\n* `j2_environment(env: Environment) -> Environment`: lets you customize the `Environment` object.\n* `alter_context(context: dict) -> dict`: lets you modify the context variables that are going to be\n used for template rendering. You can do all sorts of pre-processing here.\n* `extra_filters() -> dict`: returns a `dict` with extra filters for Jinja2\n* `extra_tests() -> dict`: returns a `dict` with extra tests for Jinja2\n\nAll of them are optional.\n\nThe example customization.py file for your reference:\n\n```python\n# \n# Example customize.py file for j2cli\n# Contains potional hooks that modify the way j2cli is initialized\n\n\ndef j2_environment_params():\n \"\"\" Extra parameters for the Jinja2 Environment \"\"\"\n # Jinja2 Environment configuration\n # http://jinja.pocoo.org/docs/2.10/api/#jinja2.Environment\n return dict(\n # Just some examples\n\n # Change block start/end strings\n block_start_string='<%',\n block_end_string='%>',\n # Change variable strings\n variable_start_string='<<',\n variable_end_string='>>',\n # Remove whitespace around blocks\n trim_blocks=True,\n lstrip_blocks=True,\n # Enable line statements:\n # http://jinja.pocoo.org/docs/2.10/templates/#line-statements\n line_statement_prefix='#',\n # Keep \\n at the end of a file\n keep_trailing_newline=True,\n # Enable custom extensions\n # http://jinja.pocoo.org/docs/2.10/extensions/#jinja-extensions\n extensions=('jinja2.ext.i18n',),\n )\n\n\ndef j2_environment(env):\n \"\"\" Modify Jinja2 environment\n\n :param env: jinja2.environment.Environment\n :rtype: jinja2.environment.Environment\n \"\"\"\n env.globals.update(\n my_function=lambda v: 'my function says \"{}\"'.format(v)\n )\n return env\n\n\ndef alter_context(context):\n \"\"\" Modify the context and return it \"\"\"\n # An extra variable\n context['ADD'] = '127'\n return context\n\n\ndef extra_filters():\n \"\"\" Declare some custom filters.\n\n Returns: dict(name = function)\n \"\"\"\n return dict(\n # Example: {{ var | parentheses }}\n parentheses=lambda t: '(' + t + ')',\n )\n\n\ndef extra_tests():\n \"\"\" Declare some custom tests\n\n Returns: dict(name = function)\n \"\"\"\n return dict(\n # Example: {% if a|int is custom_odd %}odd{% endif %}\n custom_odd=lambda n: True if (n % 2) else False\n )\n\n```\n---\n\n### Sources\n* https://github.com/kolypto/j2cli","has_starred","hub_user","immutable_tags_settings",{"_70":11,"_71":72},"enabled","rules",[73],".*","is_automated","permissions",{"_77":17,"_78":11,"_79":11},"read","write","admin","user","storage_size",729795613,"orgData",{"_85":86,"_87":88,"_89":90,"_91":28,"_92":28,"_93":94,"_95":28,"_96":97,"_98":99,"_100":101,"_102":43,"_103":43,"_104":17},"id","56b62870ea7546cc83752672673396e6","uuid","56b62870-ea75-46cc-8375-2672673396e6","type","organization","orgname","full_name","location","Wien, Austria","company","profile_url","http://www.gepardec.com","date_joined","2016-11-25T10:02:02.619086Z","gravatar_url","https://www.gravatar.com/avatar/1f167803198dc79cef05f4dd49404ae3?s=80&r=g&d=mm","gravatar_email","badge","is_active","recentTags",[107],{"_108":39,"_109":110,"_111":112,"_85":113,"_114":115,"_45":132,"_133":134,"_135":28,"_136":51,"_52":137,"_138":139,"_140":123,"_141":132,"_142":61,"_143":17},"content_type","creator",1341821,"full_size",354422771,87692022,"images",[116],{"_117":118,"_119":120,"_121":43,"_122":123,"_124":125,"_126":127,"_128":43,"_129":-5,"_130":112,"_58":61,"_131":-5},"architecture","amd64","digest","sha256:11642f3dac6e38d016365fe63a016b764c5145f6512535cff35cae66f3f0c27b","features","last_pulled","2026-09-16T10:30:06.562539157Z","last_pushed","2020-03-18T11:30:39Z","os","linux","os_features","os_version","size","variant","2020-03-18T11:41:31.262848Z","last_updater",1278856,"last_updater_username","media_type","latest","repository",8525443,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"routes/_layout.r.$namespace.$reponame.tags",{"_33":153,"_160":161,"_149":170,"_171":11},{"_35":154,"_37":155,"_40":41,"_42":43,"_44":11,"_45":46,"_47":48,"_49":156,"_52":30,"_27":28,"_53":54,"_55":39,"_56":57,"_58":59,"_60":61,"_62":-5,"_63":57,"_64":65,"_66":11,"_67":28,"_68":157,"_74":11,"_75":159,"_80":28,"_81":82},[],[39],[51],{"_70":11,"_71":158},[73],{"_77":17,"_78":11,"_79":11},"tags",{"_162":59,"_163":-5,"_164":-5,"_165":166},"count","next","previous","results",[167],{"_108":39,"_109":110,"_111":112,"_85":113,"_114":168,"_45":132,"_133":134,"_135":28,"_136":51,"_52":137,"_138":139,"_140":123,"_141":132,"_142":61,"_143":17},[169],{"_117":118,"_119":120,"_121":43,"_122":123,"_124":125,"_126":127,"_128":43,"_129":-5,"_130":112,"_58":61,"_131":-5},[],"canDeleteTags","actionData","errors"]

gepardec/j2cli

Tags for gepardec/j2cli