Forc Template

Icon Linkforc-template

Create a new Forc project from a git template

Icon LinkUSAGE:

forc template [OPTIONS] <PROJECT_NAME>

Icon LinkARGS:

<PROJECT_NAME>

The name of the project that will be created

Icon LinkOPTIONS:

-h, --help

Print help information

-L, --log-level <LOG_LEVEL>

Set the log level

-s, --silent

Silence all output

-t, --template-name <TEMPLATE_NAME>

The name of the template that needs to be fetched and used from git repo provided

-u, --url <URL>

The template url, should be a git repo [default: https://github.com/fuellabs/sway]

-v, --verbose

Use verbose output

-V, --version

Print version information

EXAMPLES:

Icon LinkCreate a new Forc project from an option template

forc template new-path --template-name option

Icon LinkEXAMPLE

forc template --url https://github.com/owner/template/ --project_name my_example_project

The command above fetches the HEAD of the template repo and searches for Forc.toml at the root of the fetched repo. It will fetch the repo and prepare a new Forc.toml with the new project name. Outputs everything to current_dir/project_name.

forc template --url https://github.com/FuelLabs/sway --template_name counter --project_name my_example_project

The command above fetches the HEAD of the sway repo and searches for counter example inside it (there is an example called counter under sway/examples). It will fetch the counter example and prepare a new Forc.toml with the new project name. Outputs everything to current_dir/project_name.