Scaffolding New Projects With SBS

Info on how to use the Super Blockchain Scaffolder cli tool.

Check Installation

Before continuing, please check that you have the sbs cli tool installed. One simple way to do this by running it with the --version flag (or its shorthand -v).

sbs -v

If a verson number is printed to the console, you're good to go! 👍

If running the version command prints an error saying something like, "sbs: command not found" then you have not installed the sbs cli tool. See the install page for more help on installing the sbs cli tool.

Decision 1)  Where To Scaffold

You have two options for where you would like the sbs cli tool to put the files and folders when scaffolding a project.

• - Current Directory: Files and folders from the starter project will be written directly to the current working directory, overwriting any existing files and folders with the same name.
• - Named Directory: A new directory will be created (with the provided string argument as the name for the directory), and all files and folders from the starter project will be written within said named directory.

Decision 2)  Which Starter To Scaffold

There are so many awesome starters available to scaffold by the sbs cli tool that making a decision can be really tough sometimes! 🫠

You can browse, filter, and search through the complete list of starters on the search page.

Scaffolding - Interactive Mode

Simply run the sbs command without any command line arguments or flags to run it in interactive mode.

sbs

When running in interactive mode the cli tool will propmt you for input about where to scaffold and which starter you would like to scaffold.

Scaffolding - Direct Mode

By passing flag arguments when running the sbs cli tool you can skip the interactive prompts and have the command directly create specified files in the specified location.

Here is an example of scaffolding the starter named "Foundry Chainlink Starter" into a folder named "foo".

sbs -n foo -s "Foundry Chainlink Starter"

Options & Help

You can view all the available options and flags by running the sbs cli tool with the --help flag.

sbs --help

Contributing

Want to add your own awesome blockchain starter so other people can scaffold it?

Well, yes you can do it, and it's not even that hard!

The the contribute page for more information on contributing.