Cithak
Homepage:
File merging powered with Dmerge.js
π€ What Is This
Cithak is a simple, secure yet powerful template manager CLI. Cithak can merge two templates by merge configuration files from those templates and Cithak was designed to be safe and transparent, so everything will be done under your permission.π Motivation
Cithak was created because sometimes a template will broke other templates and templates are difficult to manage or combine. We solve this problem by give Cithak ability to merge readme and configuration files and ability to clone templates from github, gitlab, bitbucket, or your local storage with just simple CLIπ» Features
Secure
Cithak will log every activities and execute every tasks that you give permission to execute, or you can disable task execution with
--no-exec
flagSmart
Cithak can do more than overwrite your files, it can give index or merge data from two mergeable files like
.json
, .yaml
, .env
and some other configuration files, you can disable this feature with --no-merge
flagFlexible
Cithak can use template from anywhere, clone templates from your local storage, github, gitlab, or bitbucket using git. You can use cithak with or without internet connection
π Installation
- Node.js
npm install -g cithak
- Windows, Linux, Mac
To use Cithak on Windows, Linux, or Mac without node js, download the latest executable for your operating system from releases
π Documentation
π‘ Quick Start
- Create a template
template.json
, it can contain description for your template and many more, for more information about template.json
, read this section.{
"description": "describe-your-template-here"
}
- Save new template
cth save [template-name]
- Check your template
cth info [template-name]
, it should log your template name and it's description- Clone to your project
cth clone [template-name]
.Congratulation, now you know how to use Cithak CLIπ
π Docs
CLI
for more CLI information type
cth help
in your terminal or search for command examplemergeable Files
- YAML :
*.yml
,*.yaml
- TOML :
*.toml
*.tml
- JSON :
*.json
- README :
README.[md, txt, markdown]
- ENV :
*.env
- REST :
*.rest
.prettierrc
.gitignore
.npmignore
.prettierignore
Template JSON
template.json is important for your template, it contains description and tasks of your template, template.json must havedescription
that describe the template, and template.json can also have:- tasks
tasks is array of string contains all commands will executed
{
"tasks": [
"npm i package",
"node index.js",
"echo 'hello'"
]
}
- include
include is array of glob string will include a file to the template folder if that file or folder is outside from the template folder.
"include": [
"../outside.js",
"../outside-folder/outside2.js"
]
- exclude
exclude is array of glob string that will ignore files that match with it's pattern
"exclude": [
"**/*-ignore.*"
]
More information, Visit our website
π Contibuting
If you interested in contributing to this project, please read our CONTRIBUTING.md.We are currently working on rewriting Cithak to TypeScript to make the cithak code more understandable and clear