Command Reference
All godegit commands, flags, and examples.
Command Reference
Synopsis
godegit <repo> [dest]
| Argument | Required | Description |
|---|---|---|
repo | Yes | Repository in user/repo shorthand or full GitHub URL |
dest | No | Destination directory (defaults to repository or subdirectory name) |
Flags
| Flag | Short | Description |
|---|---|---|
--branch <name> | -b | Download a specific branch or tag |
--depth <n> | Limit download depth (default: full tree) | |
--output <dir> | -o | Output directory (alias for dest) |
--verbose | -v | Enable verbose output for debugging |
--help | -h | Show help message |
--version | Show version number |
Examples
Download a repository
godegit user/my-template
Downloads into a my-template directory.
Rename the output directory
godegit user/my-template my-project
Downloads into my-project instead.
Download a specific branch
godegit user/my-template --branch develop
Downloads the develop branch.
Download a specific tag
godegit vuejs/vue --branch v3.4.0
Downloads the v3.4.0 release tag.
Download a subdirectory
godegit vuejs/create-vue-templates/typescript my-vue-app
Downloads only the typescript subdirectory. See
Subdirectories for details.
Enable verbose output for debugging
godegit user/my-template --verbose
Prints detailed progress, useful for diagnosing slow or failed downloads.
Common patterns
Starting from a template
godegit user/my-template my-new-project
cd my-new-project
git init
Pinning to a stable release
godegit user/my-template --branch v1.0.0 my-project
Overriding the output path
godegit user/my-template --output ./projects/my-project
See also
- Installation — Install godegit
- Getting Started — Step-by-step first use guide
- Subdirectories — Download specific folders from a repo
- Templates — Scaffold new projects from template repositories