Skela

Quick Start

Get up and running with Skela in minutes

Quick Start

In this guide, we'll create a simple Skela template and use it to generate a new project.

# 1. Create a Template

Create a new directory for your template:

mkdir my-template
cd my-template

Create a skela.yaml file:

name: My First Template
target: "{{ .projectName }}"

variables:
  - name: projectName
    kind: project-name
    prompt: What is the project name?

  - name: author
    kind: input
    prompt: Who is the author?
    default: "Unknown"

steps:
  - kind: print
    message: "Done! Created project {{ .projectName }} by {{ .author }}."

Create a file to be copied, for example README.md:

# {{ .projectName }}

Created by {{ .author }}.

# 2. Run Skela

Now, go back to the parent directory and run Skela pointing to your template:

cd ..
skela ./my-template

Follow the prompts:

  1. Enter a project name (e.g., awesome-app).
  2. Enter an author name.

Skela will create a directory named awesome-app containing the rendered README.md.

# Next Steps