CLI

Squadbase CLI

The Squadbase CLI is a tool that makes it easy to create and initialize projects.
This guide covers installation and explains each command in detail.

For source code and release notes, see the
GitHub repository.

Installation

macOS / Linux — Homebrew

brew tap squadbase/homebrew-squadbase
brew install squad

Windows — Scoop

scoop bucket add squad https://github.com/squadbase/scoop-bucket.git
scoop install squad

cURL script

curl -fsSL https://raw.githubusercontent.com/squadbase/squadbase/main/scripts/install.sh | sh

Go install

go install github.com/squadbase/squadbase@latest

Commands

squad create [PROJECT_NAME]

Create a new project from a template.
PROJECT_NAME is optional.

$ squad create my-awesome-project

squad init [DIRECTORY]

Initialize an existing directory with a squadbase.yml configuration.

$ squad init

Or specify a directory:

$ squad init /path/to/project

squad help [COMMAND]

Display help for the CLI or for a specific command.

$ squad help
$ squad help create

squad --version

Show the current CLI version.

$ squad --version