cli.md

Scaffold CLI

The cli is the basic interface for running your Scaffold app. This page explains all the commands you can use.

version

Displays the version of Scaffold you're using.

Scaffold version

run

Start's your scaffold project, it requires a main.yml file to start.

Scaffold run [project name]

init

Create a new Scaffold project.

Scaffold init [project name]

audit

Checks for naming issues and possible conflicts in a Scaffold project.

Scaffold audit [project name]

auto-doc (experimental feature)

Automatically generates documentation in a auto-doc.md file,this gives a very rough documenation of the endpoint's.

Scaffold auto-doc [project name]