Powerful CLI Macros
Explore the docs »

Report Bug · Request Feature · Ask Question · Contribute

⚠️ PRE-RELEASE: Everything is subject to change ⚠️

Generate powerful macros for your CLI tools with a simple and smart approach.

• ✍️ Write complex CLI interfaces in a declarative style.
• 🗄️ Combine many inconsistent CLI tools under a single consistent one.
• 🥷 Or just rewrite the CLI interface of a tool for a faster and more user-tailored experience.

Installation

npm i -g climat

Windows: CLiMAT runs sh actions through a POSIX shell. On Windows this is the sh.exe that ships with Git for Windows, so it must be installed and git must be on your PATH. CLiMAT fails fast with a clear error if it cannot be found.

Usage

Write your macro in sgit.cli

sgit {
    sub acp(amend a: flag) {
        action { 
            git add . && 
            git commit @{amend ? "--amend"} && 
            git push @{amend ? "--force"} 
        }
    }
    sub cf(branch: arg, force f: flag) {
        action { 
            git checkout feature/@{branch} @{force ? "--force"} 
        }
    }
}

Installing this via sudo climat install sgit.cli will generate

sgit acp             # Will add all files to index, commit and push
sgit acp --ammend    # Will add all files to index, ammend last commit and push force
sgit acp -a          # Can use shorthands for parameters
sgit cf myFeature    # git checkout feature/myFeature

What does it stand for?

CLi MAcro Tree