Getting Started
Your first godegit download — step by step.
Getting Started
This guide walks you through your first godegit download.
Step 1: Install godegit
If you have not installed godegit yet, see the Installation guide. The fastest way:
pnpm add -g godegit
Verify it is working:
godegit --version
Step 2: Download a repository
The basic command is:
godegit <repo> [destination]
For a concrete example, download the Vue TypeScript template:
godegit vuejs/create-vue-templates/typescript my-vue-app
godegit fetches the files from vuejs/create-vue-templates/typescript and saves
them to my-vue-app.
For a generic placeholder:
godegit user/my-template my-project
Step 3: Explore what you got
Change into the new directory:
cd my-vue-app
You will find:
- The repository's files at the top level
- No
.gitfolder — there is no inherited commit history - No prior authorship — the files are yours from the start
You can initialize a fresh git repository immediately:
git init
git add .
git commit -m "Initial commit"
Step 4: Next steps
Now that you have the basics, explore what else godegit can do:
- Command Reference — All flags, including
--branchfor specific branches - Subdirectories — Download only a specific folder from a repository
- Templates — Patterns and tips for using template repositories
- Troubleshooting — Common issues and solutions