Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Important: If you're upgrading snforge to version 0.48.0 or later, please read the 0.48.0 Migration Guide.

snforge new

Create a new StarkNet Foundry project at the provided path that should either be empty or not exist.

<PATH>

Path to a location where the new project will be created.

-n, --name

Name of a package to create, defaults to the directory name.

-t, --template

Name of a template to use when creating a new project. Possible values:

  • balance-contract (default): Basic contract with example tests.
  • cairo-program: Simple Cairo program with unit tests.
  • erc20-contract: Includes an ERC-20 token contract and a contract that allows multiple transfers of a specific token.

--no-vcs

Do not initialize a new Git repository.

--overwrite

Try to create the project even if the specified directory is not empty, which can result in overwriting existing files

-h, --help

Print help.