gitauto-cli v1.0.3
gitauto 
A command line tool to automate GitHub project creation locally as well as remotely.
Getting Started
To get started with using gitauto, you will need a Personal Access Token from GitHub. This token can be used to authenticate everytime you give commands. (Make sure to check Write Repo and Read Repo while creating the TOKEN)
Learn about getting a Personal Access Token from GitHub, here.
You can specify a project directory where you want all your GitHub Projects to go.
Create a .env file in the C:/Users/USER/AppData/Roaming/npm/node_modules/gitauto-cli/ directory with the following parameters.
TOKEN=****************************************
USER=YourUsername
FOLDER=C:/Users/<Username>/Documents/MyProjects/Prerequisites
This tool requires npm and Node.js to be installed in your system. Run the following commands:
npm --version
node --versionIf you get no errors, you're probably good to go.
Installing
Install using npm:
npm install gitauto-cli -gNote: Don't forget to use the -g flag to install it globally in your system.
Usage
gitauto offers two commands create and delete
create
gitauto create myNewRepo- It creates a remote repository myNewRepo in your GitHub account.
- Creates a new project with the same name in the directory specified in the .env file in your local system.
- Initializes Git init with a README.md file.
- Commits these changes with message "Initial Commit".
- Adds remote origin to the local repository.
- Pushes all the changes to the remote repository.
create with flag(-o)
gitauto create myNewRepo -o- The -o or --only flag specifies that ONLY a remote repository is to be created.
- Creates a remote repository myNewRepo in your GitHub account and displays the URL.
- No file changes are made to the system.
delete
gitauto delete myNewRepo- It deletes remote repository with the name myNewRepo from your GitHub account.
- Looks for project with the same name in the directory specified in the .env file in your local system and deletes it.
- Used for deleting repos existing both on local system as well as remotely.
delete with flag(-o)
gitauto delete myNewRepo -o- The -o or --only flag specifies that ONLY the remote repository is to be deleted.
- No file changes are made to the system.
Author
- Nakshatra Saxena - GitHub
Built With
- Octokit - GitHub REST API client for JavaScript
- Commander - The complete solution for node.js command-line programs
- Chalk - Terminal string styling done right