Git Quick Pusher
A simple easy to use npm package (CLI tools) to push your code into your github repositories in a single line.
Features
-
To connect git to your local github repository in a single line.
-
To push your code to your local github repository in a single line.
-
To create a new branch in your local github repository and push your code to it in a single line.
-
To push your code to an existing branch other than the "master" branch in a single line( under development, some bugs are being fixed ).
-
More Future Updates will be added as stated in UPCOMING.md and stay tuned for it.
Installation
There are two ways of installing and using this package( CLI tool ):
1). As a Command Line Interface (CLI) tool globally in your system
Clone the repository:
git clone https://github.com/arcAman07/git-quick-pusher.git
Install the dependencies:
npm i
Install the package globally on your machine:
npm i -g
2). From npm as a package installed as a dependency
npm i gitquickpusher
Usage
1). To connect git to your local github repository for the first time:
Syntax( default branch is set to be "master")
quick set "<Commit Message>" <Repository Url>
2). To commit and push code to your local existing github repository:
Syntax( default branch is set to be "master")
quick push "<Commit Message>"
3). To create a new branch in your github repository and push your code to it:
Syntax
quick branch <Branch Name> "<Commit Message>"
4). To push your code to an already existing branch other than the "master" branch( under development, some bugs are being fixed ):
Syntax
quick send <Branch Name> "<Commit Message>"
5). To get help about the CLI commands in this package:
Syntax
quick --help
In-Action
1). To connect git to your local github repository for the first time( default branch is set to be "master"):
2). To commit and push code to your local existing github repository( default branch is set to be "master"):
3). To create a new branch in your github repository and push your code to it:
4). To push your code to an already existing branch other than the "master" branch( under development, some bugs are being fixed ):
5). To get help about the CLI commands in this package:
Pre-Requisites
-
Node js installed globally in your local system.
-
Presence of any text-editors like Atom, Goland, VS Code, etc .
-
Initialise npm in your current project and then install the package in your local system.
Contributions
-
If you liked the package and you are using it in your day to day life for your projects, do star the repo.
-
If you have any feedbacks or cool things you want to add to this package, raise an issue and I will surely look into it.
-
If you want to contribute to this package check out the the CONTRIBUTING.md file in this repository.
-
Also you can check out the UPCOMING.md file in this repository to know about the future additions and updates which I am planning to make to this package.