vangen command - 4d63.com/vangen - Go Packages
README ¶ vangen Vangen is a tool for generating static HTML for Go vanity import paths. Go vanity import paths work by serving a HTML file that tells the go get tool where to download the source from. You can still host the source code at Github, BitBucket, but the vanity URL gives you portability and other benefits. Why Maintain Go vanity import paths with a simple definition file vangen.json . Host Go vanity import paths using static hosting.
No need for Google AppEngine, Heroku, etc. Host the files on Github Pages, AWS S3, Google Cloud Storage, etc. Install Source go get 4d63.com/vangen Linux curl -sSL https://github.com/leighmcculloch/vangen/releases/download/v1.1.3/vangen_1.1.3_linux_amd64.tar.gz | tar xz -C /usr/local/bin vangen Mac curl -sSL https://github.com/leighmcculloch/vangen/releases/download/v1.1.3/vangen_1.1.3_darwin_amd64.tar.gz | tar xz -C /usr/local/bin vangen Windows Download the executable , and save it to your path.
Usage Create a vangen.json (see examples below) Run vangen Host the files outputted in vangen/ at your domain Try it out with go get [domain]/[package] $ vangen -help Vangen is a tool for generating static HTML for hosting Go repositories at a vanity import path. Usage: vangen [-config=vangen.json] [-out=vangen/] Flags: -config filename vangen json configuration filename (default "vangen.json") -help print this help list -out directory output directory that static files will be written to (default "vangen/") -verbose print verbose output when run -version print program version Examples Minimal The repository type and source properties will be set automatically when url begins with https://github.com or https://gitlab.com .
Below is a minimal config for a project hosted on GitHub. { "domain": "4d63.com", "repositories": [ { "prefix": "optional", "subs": [ "template" ], "url": "https://github.com/leighmcculloch/go-optional" } ] } All fields { "domain": "4d63.com", "docsDomain": "pkg.go.dev", "repositories": [ { "prefix": "optional", "subs": [ "template" ], "type": "git", "hidden": false, "url": "https://github.com/leighmcculloch/go-optional", "source": { "home": "https://github.com/leighmcculloch/go-optional", "dir": "https://github.com/leighmcculloch/go-optional/tree/master{/dir}", "file": "https://github.com/leighmcculloch/go-optional/blob/master{/dir}/{file}#L{line}" }, "website": { "url": "https://github.com/leighmcculoch/go-optional" } } ] } Documentation ¶ There is no documentation for this package.
Source Files ¶ View all Source files config.go generate_index.go generate_package.go main.go Click to show internal directories. Click to hide internal directories. go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.