A scaffolding tool to get new projects up and running quickly
Switch branches/tags
Nothing to show
Clone or download
Vincent Prouillet
Vincent Prouillet Prepare for 0.1.8 release
Latest commit 3c41915 Oct 1, 2018
Type Name Latest commit message Commit time
Failed to load latest commit information.
ci Fix copy/paste Aug 2, 2018
examples Travis debugging Aug 1, 2018
src Add test cases for subdirectories Sep 12, 2018
.editorconfig Initial commit Feb 15, 2018
.gitignore Start of non-wip state Jul 27, 2018
.travis.yml Fix tokens Aug 2, 2018
Cargo.lock Prepare for 0.1.8 release Sep 30, 2018
Cargo.toml Prepare for 0.1.8 release Sep 30, 2018
LICENSE Initial commit Feb 15, 2018
README.md Prepare for 0.1.8 release Sep 30, 2018
appveyor.yml Fix tokens Aug 2, 2018
kickstart.gif Slightly higher res gif Aug 1, 2018



A CLI tool to easily get a new project up and running by using pre-made templates. This is a slightly more powerful version of an equivalent tool in Python, cookiecutter.

Linux build status Windows build status Crates.io



kickstart is available only through crates.io:

$ cargo install kickstart

Or as a pre-built binary on the Releases page.

Run kickstart --help for a full listing of the available commands and their flags/options.


  • Cross-platform: Windows, Mac and Linux supported
  • Single binary: no need to install a virtualenv or anything else
  • Simple to use
  • Directory names and filenames can be templated: {{ repo_name }}/{{author}}.md is a valid path
  • All templating done through Tera - a template engine inspired by Jinja2
  • Choose your own adventure: supports conditional questions based on previous answers
  • Can load templates from a local directory or from a Git repository
  • Has conditional cleanup to not let irrelevant files in the projects after generation
  • Templates can be made for any kind of projects/languages

The main drawback compared to cookiecutter is the lack of hook scripts support, which can be mitigated a bit by the conditional cleanup.

Try it out

# From the root of this repo
$ kickstart examples/super-basic
$ kickstart examples/complex -o Hello
# Anywhere
$ kickstart https://github.com/Keats/kickstart -s examples/super-basic
$ kickstart https://github.com/Keats/kickstart-sample -o sample
# Additionally, kickstart supports git URL shorthands (see [#19](https://github.com/Keats/kickstart/issues/19))
# Here, gl maps to `https://gitlab.com/`
$ kickstart gl:YourNick/template

Creating your own template

Creating a template is fairly simple: create files and then just add a template.toml in the root folder. Here is a description of all the fields available in it:

# Required, name of the template
name = "Django"
# Optional, longer form description
description = "A fully-featured Django template"
# Required, the version of the kickstart schema, currently only `1` is used
kickstart_version = 1
# Optional, the URL of the template
url = "https://google.com"
# Optional, a list of authors for this template
authors = [

# Optional, a list of keywords for this template
keywords = [

# Optional, those files will NOT be copied over when generating the template
# Use it to remove template-specific like its CI or its README/docs
ignore = [
# Optional, a list of patterns. All files matching one of the patterns will
# be copied over without going through Tera.
# Use it for files that contain syntax similar to Tera for example
copy_without_render = [

# Optional, a list of cleanup actions to do.
# All paths listed will be deleted if the `name` has the value `value` after
# the questions have been answered and the project generated.
cleanup = [
    { name = "spa", value = true, paths = ["{{ project_name }}/templates/"]},
    { name = "auth_method", value = "none", paths = ["{{ project_name }}/docs/auth.md"]},

# A list of variables, the schema is explained in detail below
name = "project_name"
default = "my-project"
prompt = "What is the name of this project?"
validation = "^([a-zA-Z][a-zA-Z0-9_-]+)$"

name = "database"
default = "postgres"
prompt = "Which database do you want to use?"
choices = ["postgres", "mysql", "sqlite"]

name = "pg_version"
default = "10.4"
prompt = "Which version of Postgres?"
choices =  [
only_if = { name = "database", value = "postgres" }

name = "auth_method"
default = "jwt"
prompt = "How are users going to be authenticated?"
choices = ["jwt", "sessions", "none"]

name = "sentry"
default = true
prompt = "Do you want to add Sentry integration?"

name = "spa"
default = false
prompt = "Is the frontend a SPA?"

name = "js_framework"
default = "React"
prompt = "Which JS framework do you want to setup?"
choices =  [
only_if = { name = "spa", value = true }

name = "typescript"
default = true
prompt = "Do you want to use TypeScript?"
only_if = { name = "spa", value = true }

A variable has the following required fields:

  • name: the name of the variable in Tera context
  • default: the default value for that question, kickstart uses that to deduce the type of that value (only string, bool and integer are currently supported)
  • prompt: the text to display to the user

And three more optional fields:

  • choices: a list of potential values, kickstart will make the user pick one
  • only_if: this question will only be asked if the variable name has the value value
  • validation: a Regex pattern to check when getting a string value

List of templates


0.1.8 (2018-09-30)

  • Allow loading templates from a subdirectory

0.1.7 (2018-08-09)

  • Work with Git aliases
  • The crate now works as a library as well as a binary

0.1.6 (2018-08-02)

  • Add a --no-input flag to the main command to generate a template from defaults
  • Validate that a template only uses allowed TOML types (String, integer and boolean) in validate command
  • Better question UI

0.1.5 (2018-07-31)

  • Fix git clone command

0.1.4 (2018-07-31)

  • Fix missing error display impl
  • Fix TOML error not showing up
  • Fix multi-layered questions being asked when they shouldn't

0.1.3 (2018-07-31)

  • Add pattern to match in the question when there is on

0.1.2 (2018-07-31)

  • Add optional validation field to validate a string against a regex
  • Add colours and boldness to CLI
  • Use git command rather than git2 crate to avoid some build issues
  • Add cleanup field to template definition for post-generation cleanup
  • Add validate command to diagnose errors in a template.toml file