git-init-plus
git-init-plus copied to clipboard
Published
20 hours ago •
eddyerburgh
eddyerburgh
⚡ Turbo charged git init
git-init-plus
Shell script to kick start a git project
Initializes git, creates LICENSE, adds .gitignore, and creates a README.md with your project title.
Table of contents
- Installation
- Linux
- OSX
- Windows
- Usage
- Options
Installation
Linux
In your terminal run:
wget https://raw.githubusercontent.com/eddyerburgh/git-init-plus/master/install.sh && chmod +x install.sh && sudo ./install.sh
This script downloads the install file, makes it executable and runs it
The install file adds this directory to /opts/git-init-plus and creates a sym-link for the git-init-plus script in /usr/local/bin
OSX
curl -O https://raw.githubusercontent.com/eddyerburgh/git-init-plus/master/install.sh && chmod +x install.sh && sudo ./install.sh
And add usr/local/bin to PATH, in ~/.bash_profile
export PATH="/usr/local/bin:$PATH"
Windows
Currently unavailable
Usage
git-init-plus
Will walk you through creation of a new git project
git-init-plus -l ISC -n Edd -p project-name
Will initialize git, add an ISC LICENSE, a README.md with project-name as a title and a .gitignore file
If .git, README.md or LICENSE already exist, git-init-plus will prompt you to verify whether it should replace the file
Options
| Parameter | Usage | Example |
|---|---|---|
| -l | name of license to create (defaults to MIT) | git-init-plus -l Apache |
| --license | name of license to create (defaults to MIT) | git-init-plus --license Apache |
| -n | name(s) of copyright holder(s) to be added to LICENSE | git-init-plus -n Edd |
| --name | name(s) of copyright holder(s) to be added to LICENSE | git-init-plus --name Edd |
| -p | project name to be added as title to README.md | git-init-plus -p git-init-plus |
| --project-name | project name to be added as title to README.md | git-init-plus --project-name git-init-plus |
| -h | prints out usage | git-init-plus -h |
| --help | prints out usage | git-init-plus --help |
eddyerburgh