Command Reference

All godegit commands, flags, and examples.

Command Reference

Synopsis

godegit <repo> [dest]
ArgumentRequiredDescription
repoYesRepository in user/repo shorthand or full GitHub URL
destNoDestination directory (defaults to repository or subdirectory name)

Flags

FlagShortDescription
--branch <name>-bDownload a specific branch or tag
--depth <n>Limit download depth (default: full tree)
--output <dir>-oOutput directory (alias for dest)
--verbose-vEnable verbose output for debugging
--help-hShow help message
--versionShow 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