Documentation

Quick Start

Install the CLI, add your first vanity URL, and start using it — in under 5 minutes.

Custom Domains

Use your own domain as a vanity URL prefix with automatic TLS certificates.

CLI Reference

All commands, flags, and configuration options for the gvu CLI tool.

FAQ

Common questions about vanity URLs, module paths, quotas, and troubleshooting.

Wildcard Routing

Cover all repos under a custom domain with a single wildcard rule — Pro only.

Comparisons

See how gvu stacks up against hand-written meta tags, govanity, and other approaches.

Quick Start

Install Linux & macOS curl -fsSL gomodvanityurls.com/install.sh | bash Or download a binary from the latest release. Windows Choose based on your shell environment: Option A — PowerShell (recommended): powershell -ExecutionPolicy ByPass -c "irm https://gomodvanityurls.com/install.ps1 | iex" The script auto-detects your architecture, verifies the download, and configures PATH. Run gvu --version to verify. Option B — Git Bash / MSYS2 / Cygwin: Open your shell terminal, then run: curl -fsSL gomodvanityurls.com/install.sh | bash The script auto-detects Windows and downloads the correct .exe binary. ...

Custom Domains

Verified and Pro users can use their own domain as the vanity URL prefix. Prerequisites A Verified or Pro account (run gvu auth bind <email> to upgrade) A domain you control with DNS management access gvu CLI installed — see Quick Start Setup Important: DNS must be configured before running gvu add. The server verifies your domain’s CNAME record during route creation. 1. Configure DNS Point your domain to the service via CNAME: ...

CLI Reference

Route management Command Description gvu add <vanity-path> <repo-url> Add a new vanity URL route gvu list List all your registered routes gvu remove <route-id> [...] Remove one or more routes gvu add The hosting platform is auto-detected from the repo URL. Flags Flag Description --subdir <path> Subdirectory within the repo where go.mod lives (Go 1.25+). Use * for subdir wildcard (Pro only). Omit for single-module repos. Examples # ── gomod.io routes (default domain, all users) ── # GitHub gvu add gomod.io/mylib https://github.com/myorg/mylib.git gvu add gomod.io/mylib ssh://git@github.com:myorg/mylib.git # GitLab gvu add gomod.io/mylib https://gitlab.com/myorg/mylib.git gvu add gomod.io/mylib ssh://git@gitlab.com:myorg/mylib.git # Bitbucket gvu add gomod.io/mylib https://user@bitbucket.org/myorg/mylib.git gvu add gomod.io/mylib ssh://git@bitbucket.org:myorg/mylib.git # Codeberg gvu add gomod.io/mylib https://codeberg.org/myorg/mylib.git gvu add gomod.io/mylib ssh://git@codeberg.org:myorg/mylib.git # Self-hosted GitLab (custom port) gvu add gomod.io/mylib http://gitlab.example.com/group/mylib.git gvu add gomod.io/mylib ssh://git@gitlab.example.com:2222/group/mylib.git # ── Monorepo (Go 1.25+, --subdir) ── # go.mod at go/module-a/go.mod inside the repo gvu add gomod.io/module-a https://github.com/myorg/monorepo.git --subdir go/module-a gvu add gomod.io/module-b https://github.com/myorg/monorepo.git --subdir go/module-b # ── Custom domain routes (Verified/Pro only) ── gvu add go.mycompany.com/mylib https://github.com/myorg/mylib.git gvu add go.mycompany.com/mylib ssh://git@gitlab.com:myorg/mylib.git # ── Wildcard routes (Pro + custom domain only) ── # Repo wildcard — cover all repos under a GitHub org gvu add 'go.mycorp.com/dept1/*' 'https://github.com/dept1/*.git' # Subdir wildcard — cover all subdirs in a monorepo gvu add go.mycorp.com/dept1/mono https://github.com/dept1/mono.git '--subdir=*' Note: Wildcard routes require a Pro account and a custom domain. Repo wildcard and subdir wildcard are mutually exclusive per route. See Wildcard Routing for full details. ...

FAQ

Module Path Why must go.mod use the vanity URL instead of github.com/...? When you set up a vanity URL like gomod.io/mylib, the Go toolchain uses the import path (the vanity URL) to locate the module. The module directive in go.mod must match exactly: // go.mod — correct module gomod.io/mylib // go.mod — WRONG module github.com/yourorg/mylib If they don’t match, go get and go build will fail with an error like: ...

Wildcard Routing

Wildcard routing lets you cover all repositories under a custom domain prefix with a single rule, eliminating the need to register each repo individually. Prerequisites A Pro account (run gvu subscribe to upgrade) A custom domain with DNS CNAME already configured gvu CLI installed — see Quick Start Note: Wildcard routes are not available on the default gomod.io domain. They require a custom domain. Repo wildcard (W1) Use repo wildcard when you have many repos under the same GitHub organization or path prefix. ...