Climan 1.1.0

Climan

Climan is a NuGet package that automates repetitive and tedious commands for you by allowing you to create, store, and manage CLI commands that can be executed using Climan's cm shorthand.

Description

Climan provides a simple way to automate CLI commands that are often lengthy and repetitive. With Climan, you can create and save custom CLI commands with arguments, making it easy to recall and execute them later. Climan's cm shorthand lets you execute these commands quickly and efficiently. Commands with required arguments will prompt you to enter the corresponding arguments before execution.

Installation

You can install Climan using dotnet CLI:

dotnet tool install --global Climan

Usage

Run cm in your project directory, your solution, or anywhere you need to automate terminal commands. For example:

cm
CLIMAN is running...
Hit CTRL-C or ESC to quit.
> git
> docker
> commit and push to remote branch
> do any repetitive things with any CLIs

cm
CLIMAN is running...
Hit CTRL-C or ESC to quit.
INF Run the program again with argument 'repo' to create new repositories.

To execute saved commands, simply run:

cm
CLIMAN running...
Hit CTRL-C or ESC to quit.
> git

> git pull origin dev

For commands that required arguments, Climan will prompt you to enter the corresponding arguments before executing:

cm
CLIMAN running...
Hit CTRL-C or ESC to quit.
> docker

> docker exec -it <containerName> /bin/bash
Please enter <containerName>: my-container

You can also use Climan to automate specific use cases, for example:

cm
CLIMAN running...
Hit CTRL-C or ESC to quit.
> commit and push to remote branch

> git add -A && git commit -m <commit_message> && git push -u origin <branch>
Please enter <commit_message>: fix issue #21
Please enter <branch>: dev

To get started with Climan, create a command repository by running:

cm repo
> Create a new command

You will then be prompted to enter a CLI name and a command to execute for the CLI. If the command requires arguments, you can specify placeholders using "<" and ">", such as <argumentName1>, <ArgumentName2>, <argument_name3> etc. These arguments will be prompted when executing the command.

To create commands with no arguments, run:

cm repo
> Create a new command
Please enter the CLI name: git
Please enter the command for docker CLI: git pull origin dev

To create commands with arguments, run:

cm repo
> Create a new command
Please enter the CLI name: docker
Please enter the command for docker CLI: docker exec -it <containerName> /bin/bash

To edit saved commands, run:

cm repo
> Update existing commands

To delete saved commands, run:

cm repo
> Delete commands

Technologies

Climan is built using .NET.

Contributing

Contributions to Climan are welcome. Please open an issue or submit a pull request for any changes you would like to make.

License

Climan is licensed under the MIT License.