https://github.com/martinohmann/kickoff

Kick off projects from skeleton directories
https://github.com/martinohmann/kickoff

cli composition project-bootstrapping skeletons templating

Last synced: 4 months ago
JSON representation

Kick off projects from skeleton directories

• Host: GitHub
• URL: https://github.com/martinohmann/kickoff
• Owner: martinohmann
• License: mit
• Created: 2020-01-02T21:28:19.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-03-07T03:22:28.000Z (over 3 years ago)
• Last Synced: 2026-01-13T20:04:08.956Z (6 months ago)
• Topics: cli, composition, project-bootstrapping, skeletons, templating
• Language: Go
• Homepage: https://martinohmann.github.io/kickoff/
• Size: 5.63 MB
• Stars: 6
• Watchers: 1
• Forks: 0
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# kickoff

[![Build Status](https://github.com/martinohmann/kickoff/workflows/build/badge.svg)](https://github.com/martinohmann/kickoff/actions?query=workflow%3Abuild)

[![codecov](https://codecov.io/gh/martinohmann/kickoff/branch/master/graph/badge.svg)](https://codecov.io/gh/martinohmann/kickoff)

[![Go Report Card](https://goreportcard.com/badge/github.com/martinohmann/kickoff)](https://goreportcard.com/report/github.com/martinohmann/kickoff)

[![GoDoc](https://godoc.org/github.com/martinohmann/kickoff?status.svg)](https://godoc.org/github.com/martinohmann/kickoff)

![GitHub](https://img.shields.io/github/license/martinohmann/kickoff?color=orange)

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](https://asciinema.org/a/414074.svg)](https://asciinema.org/a/414074)

## Documentation

Head over to the [kickoff

documentation](https://martinohmann.github.io/kickoff) or directly jump into

the [Getting started

guide](https://martinohmann.github.io/kickoff/getting-started).

## Features

- Templating of filenames, directory names and file contents via [Go

  templates](https://golang.org/pkg/text/template/) and

  [Sprig](http://masterminds.github.io/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](https://docs.github.com/en/rest/reference/licenses).

- Automatically add a .gitignore created from templates obtained from

  [GitHub Gitignores API](https://docs.github.com/en/rest/reference/gitignore).

- 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.