CLI CMD Command helper
Project description
CMDS Helper
This modul will help us to automate CLI Command we usually use in projects.
How To Use
-
Install cmds-helper module using
pip
-
Make runner file in root of your project files directory (i.e
run.py
)--ProjectDir --{{Your project files/folder}} --run.py --{{your cmd json file}}cmd.json
-
Import cmdshelper
Helper
classfrom cmdshelper.helper import Helper
-
Instantiate the
Helper
classcmd = Helper()
-
Make command json file. You can make many cmd json file for grouping cmd or just make 1 cmd json file. The program will read all json file ends with
cmd.json
in your project directory and add it tolist_command
inHelper
class. The syntax is :{ "{your_cmd_identifier}" : [ "{cmd_command_to_run}", "{cmd_command_to_run}", ... ], "{your_cmd_identifier}" : [ "{cmd_command_to_run}", "{cmd_command_to_run}", ... ], ... }
-
{your_cmd_identifier}
is identifier for calling all cmd command under that identifier. every identifier must be unique -
cmd_command_to_run
is the cmd command you want to run. The command is string you usually type in CLI, but in the json file, you separate every command/optional/arguments using comma / ','. -
In
cmd_command_to_run
, you can add argument to pass, with type%{i}
(i
is index arguments passes)
-
-
Example :
"gitACP" : [ "git,add,.", "git,commit,-m,%1", "git,push" ]
the identifier to call that command is
gitACP
(command to call git common command[add, commit, and push]
). under that identifier, we specify all command we want to call"git add ."
is typed"git,add,."
"git commit -m "{message}" "
is typed"git,commit,-m,%1"
%1
means that the first argument passed when calling that command identifier, will replacing%1
into the passed string- If you just want add same commit message for each commit, you can just change
%1
into your message likefeat: add something
"git push"
is typed"git,push"
You can see another command examples in
example_cmd.json
-
There are 2 ways to run this
file
, by CLI with passingarg
or by hardcode the command inscript
-
CLI Passing argument :
-
After instantiate the class, you can type this code :
import sys cmd.run(sys.argv[1:])
-
To run it, you just need to run the file and passing the
command identifier
andargument
if needed -
Example run it in CommandPrompt
py run.py gitACP "feat: add something
that will call the
gitACP
command and passfeat: add something
as commit message
-
-
Hardcoded Command :
-
After instantiate the class, you can type this code :
cmd.run([{your command here}])
-
Example :
cmd.run(["gitACP","feat: add something"])
to run it, you just need to run
run.py
file
-
-
-
Full code in
run.py
will be :from cmdshelper.helper import Helper import sys cmd = Helper() # run using cli cmd.run(sys.argv[1:]) # run using hardcode command #cmd.run(["gitACP","feat: add something"])
License
This project is licensed under the terms of the MIT license.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for cmds_helper-0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 320828e4c4a4f18f78ca4255005a5ccb416fddd004975b894483448142a510a0 |
|
MD5 | 48047627dee2679ed50f85b8a1d029b4 |
|
BLAKE2b-256 | 54138961f9c400098bc4135fce066bdec1da0dc65c42402404ee211f91d0b9cb |