4 releases (1 stable)
1.0.0 | Jun 9, 2023 |
---|---|
0.0.4 | Jun 2, 2023 |
0.0.3 | May 21, 2023 |
0.0.2 | May 19, 2023 |
#22 in #scaffold
33KB
484 lines
sbs-cli
The Super Blockchain Scaffolder command line utility!
Learn more at https://sbs-cli.org
Purpose
The sbs-cli is a free and open-source command line tool meant to make it easy for anyone to explore, learn, and build with all of the many awesome blockchain tooling, libraries, and protocols available today and in the future!
History
The sbs-cli was created by Jim (@JimLynchCodes) and Pranav (@ps428) for the Spring 2023 Chainlink hackathon.
Companion Site
Visit sbs-cli.org to learn more about the project and the sbs orgnaization!
Installation
The sbs-cli can be installed with either npm or cargo.
Option A) Install via NPM
Recommended for most users
npm i -g sbs-cli
Option B) Install via Cargo
Recommended for Rust users (and those contributing to sbs-cli project)
cargo install sbs-cli
Usage
Run in interactive mode (prompts user for necessary information)
sbs
Various flags can be passed to skip over the interactive prompts.
See all optional flags:
sbs --help
Example usage with flag arguments:
sbs -n "my-new_directory" -s "Chainlink Foundry Starter"
Dev Workflow
Note: Open-source contributors wanted!
1) First, clone this repo
git clone
2) Run Tests
cargo test
3) Run Locally
cargo run
Some examples of running locally with flag arguments:
cargo run -- -a
cargo run -- -c
cargo run -- -n foo
cargo run -- -n foo -s "Foundry Starter Kit"
Deploying
Deploys are currently done through the SBS Team account using the rust-to-npm
package.
First, manually increment the version in Cargo.toml
file.
Make sure you are logged into npm and cargo in your cli before trying to deploy:
cargo login
npm adduser
Note that we want "sbs" to be the command users run but we want users to install it with "sbs-cli" so we deploy with the -n flag like so:
rust-to-npm-cli deploy -b -n sbs-cli
Dependencies
~19–37MB
~600K SLoC