Skip to content

martinohmann/kickoff

Repository files navigation

kickoff

Build Status codecov Go Report Card GoDoc GitHub

Start new projects from reusable skeleton directories. Use community project skeletons or create your own. No more need to copy & paste initial boilerplate like Makefiles, CI configuration or language specific configuration files from existing projects to a new one.

asciicast

Documentation

Head over to the kickoff documentation or directly jump into the Getting started guide.

Features

  • Templating of filenames, directory names and file contents via Go templates and Sprig.
  • Extensible by allowing users to pass arbitrary values to templates via config files or CLI flags.
  • Automatically populate LICENSE file with an open source license obtained from the GitHub Licenses API.
  • Automatically add a .gitignore created from templates obtained from GitHub Gitignores API.
  • Set local author, repository and skeleton defaults using custom config file.
  • Skeleton composition: projects can be created by composing multiple skeletons together.

License

The source code of kickoff is released under the MIT License. See the bundled LICENSE file for details.