Description

qush is my own CLI to add, commit and push in one line.

Why use it

• it helps you to push a commit faster (one single line instead of three)
• it helps you to push a commit cleaner (a config system to write consistent commits)

Requirements

• nodejs
• git

How it works

install qush globally

npm i qush -g

then run qush from your project folder

qush a p "my new commit"

it will add, commit then push the following message: "[project] add: my new commit"

the commit respects the following template "[target] action: message"

by default, qush will use the default config

the first argument is the action, here is the mapping of this argument for the default config:

• a → add
• d → delete
• r → refactor
• f → fix
• s → setup
• u → update

the second argument is the target, here is the mapping of this argument for the default config:

• d → documentation
• t → test
• p → project

Config

you can add your own config in the root of your github project to customise the commit message template.

the file should be named "qush.config.json", you can see an example in the github repository of this project.

flags available

you can also add several flags into that command

The flag -H or --help

the flag shows the helper of qush.

The flag -C or --config

the flag shows the current config used by qush.

The flag -S or --source

the flag allows you to add only several source files/folders inside the commit.

for example:

qush a p "my new commit" -S README.md --source packages.json

will only commit these two files.

if none of these flags are mentionned, then "git add ." will be used.

The flag -Y or --yes

the flag allows you to push without any confirmation to win even more time.