gogogo

README

gogogo

gogogo is a command and library for creating projects from tar-based templates. It is a Go port of mafintosh/create-project. The default template is bcomnes/go-template on its master branch.

Install

Install the standalone command with Homebrew:

brew install bcomnes/tap/gogogo

This adds the bcomnes/tap tap automatically. Update it later with brew upgrade gogogo.

Alternatively, install the latest source with Go:

go install github.com/bcomnes/gogogo@latest

Command-line usage

Create a project from the default Go template:

gogogo my-project

Create a project from another GitHub repository and branch:

gogogo my-project owner/template#main

A configured repository also accepts a branch name as shorthand:

gogogo my-project next

Flags must appear before the project name, matching the standard Go flag package convention. Pass template parameters with repeatable -set key=value flags:

gogogo -set owner=bcomnes -set license=MIT my-project

Use a local uncompressed or gzip-compressed tar archive:

gogogo -file template.tar.gz my-project

Download an archive from an HTTP or HTTPS URL:

gogogo -url https://example.com/template.tar.gz my-project

Run gogogo -help for complete help text and flag descriptions.

Template placeholders

Text files may use both {{key}} and __key__ placeholders. The name parameter defaults to the destination directory's base name. Unknown placeholders are left unchanged. Use __name__ in files that must remain syntactically valid before generation. For example, a template go.mod can contain:

module github.com/bcomnes/__name__

Likewise, a Go package declaration can contain package __name__. Binary files are detected from their media type and complete contents, then copied byte-for-byte without placeholder substitution.

Configuration

Set a default repository and default template parameters interactively:

gogogo -configure

Configuration is stored in ~/.config/gogogo.json by default. Set GOGOGO_CONFIG to use a different configuration path.

Extraction behavior

The destination must not already exist. Files are extracted into a private staging directory and published atomically. The common top-level directory in the archive is removed. Unsafe paths, escaping links, duplicate paths, and unsupported archive entries are rejected.

Library usage

The implementation is available from github.com/bcomnes/gogogo/pkg.

package main

import (
	"context"
	"log"
	"os"

	gogogo "github.com/bcomnes/gogogo/pkg"
)

func main() {
	archive, err := os.Open("template.tar.gz")
	if err != nil {
		log.Fatal(err)
	}
	defer archive.Close()

	project, err := gogogo.Create(
		context.Background(),
		"my-project",
		archive,
		gogogo.Options{
			Parameters: map[string]string{"owner": "bcomnes"},
		},
	)
	if err != nil {
		log.Fatal(err)
	}

	log.Printf("created %s in %s", project.Name, project.Destination)
}

Repository strings can be parsed with gogogo.ParseRepository, and Repository.ArchiveURL returns the corresponding GitHub archive URL.

License

MIT

Documentation

Overview

Package main implements the gogogo command-line tool.

The CLI downloads or opens a tar-based project template and delegates safe, text-only placeholder substitution and extraction to the pkg library.