Skip to main content

Introduction

Welcome to the documentation for Scaffold, your go-to repository for kick-starting your projects!

If you're tired of setting up your project environment from scratch each time you begin a new venture, you're in the right place.

Scaffold is designed to give you a consistent and tested foundation for your projects, so you can focus on the important stuff.

Quick start​

The quickest way to start is a single command in a new empty directory - it downloads Scaffold and then prompts you for the project details:

curl -fsSL https://getscaffold.dev/init.sh | bash

To run unattended - for automation and AI agents - pass the details as options instead of answering prompts:

curl -fsSL https://getscaffold.dev/init.sh | \
  bash -s -- --namespace=AcmeApp --name=acme-app --author="Jane Doe"

The latest release is used by default; to pin a specific tag, branch, or commit, pass --ref to the script after bash -s -- (for example bash -s -- --ref=1.2.3). Then commit and push the result to your repository.

Alternative: start from a checkout​

Prefer to work from a local copy first?

  1. Download the latest release from GitHub.
  2. Run ./init.sh to replace yournamespace, yourproject, Your Name and other strings with your own and choose the features.
  3. Commit and push the changes to your repository.

Run ./init.sh --help for all options.