idkmng is a TOML-based project initializer that helps you quickly set up project directories and files according to predefined templates. It's designed for developers who want to streamline their workflow by automating the creation of consistent project structures.
Template-based, with easy TOML support!
Creating a project often involves setting up specific files with unique formats. For instance, a browser extension requires files like:
manifest.json
Content.js
etc..
Each file has its own structure and syntax. With idkmng, you can effortlessly initialize projects with the required files and configurations using a simple command, regardless of the specific format needed.
For example, to set up a browser extension project, you can run:
$ idkmng browser_extensionand 💥 your project files will be ready for your initial commit. Isn’t that amazing?
idkmng is template-based, allowing you to define multiple templates for the same type of project. This means you can customize the initialization process to suit different requirements, such as variations in manifest.json or other project-specific files.
If you have Rust 🦀 🚀 installed on your machine run the following command:
$ cargo install --git https://github.com/pwnxpl0it/idkmngAlternatively you can go to Releases and download the binary
$ sudo tar -xzf idkmng-<RELEASE>.tar.gz -C /usr/local/binReplace with the version number or tag of the release you want to install.
now you should be able to run idkmng in your terminal!
Default templates path is ~/.config/idkmng/templates
Note
You can use -c option to override the config path if you needed to.
The template structure is like the following:
[info]
name = ""
description = ""
author = ""
[[files]] # file1
path="/path/to/file1"
content="""
"""
[[files]] # file2
path="/path/to/file2"
content="""
#etc...
"""Tip
Info section is not required and can be ignored
Note
You can use -q (quiet) option to hide template information even if it is provided in the template
| Field | Description |
|---|---|
path |
The path of the file where content will be saved. |
content |
The content to be written to the file. |
keywords/placeholders |
idkmng recognizes default keywords and placeholders, such as {{$HOME}} or {{$CURRENTDIR}}. Some keywords, like {{$PROJECTNAME}}, may prompt for user input. |
| Multiple Files | You can include as many files as needed, each with its own path and content. |
Here is a table of defualt keyword for idkmng:
| Keyword/placeholder | Value | Example |
|---|---|---|
| PROJECTNAME | ||
| CURRENTDIR | Current directory | pwd=/foo/bar => bar |
| HOME | Home directory | /home/user/ |
| YYYY | Current Year in YYYY format | 2024 |
| YY | Current Year in YY format | 24 |
| MM | Current Month | 2 |
| DD | Current Day | 24 |
| NOW | Current date and time | 2024-02-23 22:22:38.151417626 +00:00 |
| NOW_UTC | Current date and time in UTC | 2024-02-23 22:21:17.897444668 UTC |
you can have keywords/placeholder that asks for user input to take as a value by using the following format {{$%s:f}} this already works with {{$PROJECTNAME}}. but you can have your own...
Example:
# --snip
content="""
{{$TEST:read}}
"""Functions supported by idkmng:
| Function | Description | Example |
|---|---|---|
| read | Asks for user input to replace placeholder with | {{$TEST:read}} |
| env | Replace with value from environment variables | {{$PATH:env}} |
also keep in mind that once a function gets called on a keyword you can use {{$TEST:read}} or {{$TEST}} both are going to work and value will be replaced for both of them.
I have a private personal templates repo that I may share soon, but for now I can only provide a few examples
Neovim Plugin [Click to expand]
Now this one overhere is just for basic neovim plugin structure I use to create nvim plugins for my personal use also I have another one to create the docs for the plugin (just basic files not autogenerate docs)
[info]
name = "Neovim Plugin"
description = "A template for nvim plugin"
author = "Mohamed Tarek @pwnxpl0it"
[[files]]
path="{{$PROJECTNAME}}/lua/{{$PROJECTNAME}}/init.lua"
content="""
local M = {}
M.config = {}
M.setup = function ()
if config ~= nil then
M.config = config
end
end
return M
"""
[[files]]
path="{{$PROJECTNAME}}/plugin/init.lua"
content="""
require("{{$PROJECTNAME}}")
"""Jekyll new blogpost [Click to expand]
I am starting a Blog (still underconstruction 🏗️) but anyway I use this template to create a new post in my blog directly from CLI,This one here uses more keywords and includes a private BLOGPATH placeholder that it's value is loaded from config file.
[info]
name = "new_post"
description = "New jekyll post"
author = "Mohamed Tarek @pwnxpl0it"
[[files]]
path="{{$BLOGPATH}}/_posts/{{$YYYY}}-{{$MM}}-{{$DD}}-{{$blogtitle:read}}.markdown"
content="""
---
layout: post
title: "{{$blogtitle}}"
date: {{$NOW_UTC}}
tags: {{$Tags:read}}
---
"""
Browser (Chrome) Extension [Click to expand]
This one is just for creating a really BASIC chrome extension with no icon or anything else, I use it because I like it to be minimal, still can add more placeholders but since this is for private use I don't really care, about version etc...[info] # Generated using `idkmng new` btw
name = "browser_extension"
description = "A Template for creating a browser extension"
author = "Mohamed Tarek @pwnxpl0it"
refrence= "https://developer.chrome.com/docs/extensions/mv3/manifest/"
[[files]]
path="{{$PROJECTNAME}}/manifest.json"
content="""
{
"manifest_version": 3,
"name":"{{$PROJECTNAME}}",
"version": "1.0.1",
"content_scripts":[
{
"matches":["<all_urls>"],
"js":["content.js"]
}
]
}
"""
[[files]]
path="{{$PROJECTNAME}}/content.js"
content="""
console.log("Hello world!")
"""
*TIP 💡 *: Info section can have any additional values, it won't get printed but maybe usefull if sharing the template or just as a reference for docs like I did here
You can use json to replace placeholders in your template, idkmng will automatically load values from a json file and replace them automatically
idkmng uses JSON Query language to load values from json nodes.
This is made possible using Rust's jq-rs crate 🦀 which has bindings to libjq.
Here is an example:
{
"user": {
"id": "12345",
"name": "John Doe",
"email": "john.doe@example.com"
},
"status": ["200 OK"]
}example template:
[[files]]
path="test"
content="""
User ID: {{$.user.id}}
User Name: {{$.user.name}}
User Email: {{$.user.email}}
Response Status: {{$.status[0]}}
"""$ idkmng template --json test.jsonOutput:
$ cat test
User ID: 12345
User Name: John Doe
User Email: john.doe@example.com
Response Status: 200 OKNote
Although this is a cool feature to automate user inputs, It comes with performance costs Why?
idkmng now supports Liquid templating alongside its own custom syntax. This allows you to benefit from Liquid's logic (loops, conditionals) while continuing to use idkmng's powerful keyword replacement.
[[files]]
path = "output.txt"
content = """
{% for i in (1..5) %}
Example! {{ i }} {{ "{{$file:read}}" | append: ".html" }}
{% endfor %}
"""idkmngreplaces{{$file:read}}with user input.- Liquid handles loops and string manipulation.
Example! 1 ff.html
Example! 2 ff.html
Example! 3 ff.html
Example! 4 ff.html
Example! 5 ff.html
With this integration, you can create dynamic and flexible templates that combine the strengths of both idkmng and Liquid.
Also there is one more time saving way! if you have some files in /foo/bar/ you can just run idkmng init and it will create a template for you with directory name bar.toml and it will have all your files in it! 🌸
You can have your own Keywords for idkmng to replace with desired values! Idkmng finds them stored in $HOME/.config/idkmng/config.toml Or the config path you specified using -c/--config option 🦀
[Keywords]
AUTHOR = "Mohamed Tarek"
USERNAME = "@pwnxpl0it"
GITHUB = "https://github.com/pwnxpl0it"
#etc .....I wrote a neovim plugin that makes it a way easier, Check it out idkmng.nvim.