Skip to main content

Super Commands

Flow CLI Super commands are set of commands that can be used during development of your dApp to greatly simplify the workflow. The result is you can focus on writing the contracts and the commands will take care of the rest.

Init​

The initial command to start your new Flow project is flow init. It will ask you a few questions about how you'd like to configure your project and then create the necessary files and folders, set up the configuration file, and install any core contract dependencies you might need.

During the initialization process, flow init will prompt you if you want to install any core smart contracts (e.g. NonFungibleToken) and set them up in your project. If you choose to install core contracts, the CLI will use the Dependency Manager under the hood to automatically install any required smart contract dependencies.

Note: If you just want the flow.json configured without creating any folders or files, you can run flow init --config-only.

Running the command:


_10
> flow init $PROJECT_NAME

Will create the following folders and files:

  • /contracts folder should contain all your Cadence contracts,
  • /scripts folder should contain all your Cadence scripts,
  • /transactions folder should contain all your Cadence transactions,
  • /tests folder should contain all your Cadence tests,
  • flow.json is a configuration file for your project, which will be automatically maintained.

Using Scaffolds​

Based on the purpose of your project you can select from a list of available scaffolds. You can access the scaffolds by simply using the --scaffold flag like so:


_10
> flow init $PROJECT_NAME --scaffold

If you'd like to skip the interactive mode of selecting a scaffold, use the --scaffold-id flag with a known ID:


_10
> flow init $PROJECT_NAME --scaffold-id=1

The list of scaffolds will continuously grow, and you are welcome to contribute to that. You can contribute by creating your own scaffold repository which can then be added to the scaffold list by following instructions here.

Testing​

flow init will also have created an example test file in the /tests folder. You can run the tests by using the flow test command.

Import Schema​

You can simply import your contracts by name. We have introducted a new way to import your contracts. This will simply your workflow.

The new import schema format looks like:


_10
import "{name of the contract}"

Example:


_10
import "HelloWorld"

This will automatically import the contract you have created in your project with the same name and save the configuration in flow.json. It doesn't matter if the contract has been deployed on a non-default account.

Learn More​

To learn more about next steps following the initial setup, check out the following links:

Rate this page