git-full-setup
v1.0.0
Published
This is a simple tool that sets up Git perfectly, VS Code integration, useful aliases, and best practices on your computer in one go.
Maintainers
Readme
Git Full Setup
This is a simple tool that sets up Git perfectly on your computer in one go.
What does it do?
- Asks for your name and email
- Sets up SSH key for GitHub (creates new one if you don't have)
- Shows you the public key → tells you exactly where to paste it on GitHub
- Tests the SSH connection
- Sets many useful Git settings (aliases, VS Code editor, safe CRLF, etc.)
- Creates a good global .gitignore file
- Shows you everything it did at the end
Requirements (install these first)
- Node.js + npm → download from https://nodejs.org (use LTS version)
- Git → download from https://git-scm.com/downloads
- Visual Studio Code (recommended, but not required)
- A GitHub account
How to install
Open your terminal / Git Bash and run this one command:
npm install -g git-full-setupHow to use
Just type this command and press Enter:
git-setupThen follow the instructions on the screen.
Step-by-step what happens when you run it
- It asks for your full name and email
- It checks if you already have SSH key
- If you have → shows the key, tells you to add it to GitHub
- If you don't → creates a new secure key (ed25519)
- It starts SSH agent, adds your key
- Tests connection to GitHub
- Sets all Git global settings
- Creates ~/.gitignore_global
- Shows you the full list of your new settings
- Tells you "Success!"
After setup, test it
git clone [email protected]:Olorunshogo/git-full-setup.git
cd git-full-setupIf it clones without asking for password → success!
Common problems & fixes
- "Permission denied (publickey)": You forgot to add the key to GitHub or didn't save it
- SSH test fails: Run
ssh -v [email protected]to see details - On Windows: Always use "Git Bash" (not Command Prompt or PowerShell)
- VS Code not opening: Make sure VS Code is installed and in your PATH
Uninstall
npm uninstall -g git-full-setupnpm access token
