Fuels CLI

The quickest way to build full stack Fuel dApps.

• fuels init — Creates a new fuels.config.ts file
• fuels build — Build forc workspace and generate Typescript types for everything
• fuels deploy — Deploy workspace contracts and save their IDs to JSON file
• fuels dev — Start local Fuel Core node and build + deploy on every file change

Getting started

Imagine you have this file structure:

my-fuel-dapp # NextJS app or similar
├── sway-programs # Forc's workspace
│   ├── src
│   ├── ...
│   └── Forc.toml
├── public
│   └── ...
├── src
│   ├── app
│   ├── ...
├   └── sway-programs-api # Type-safe generated API
└── package.json

Prerequisites

The Fuel Toolchain and its components (namely forc and fuel-core) are pre-requisite for several operations with the Fuels CLI. For example:

• Building out contracts using fuels build requires forc.
• Deploying contracts locally using fuels deploy requires fuel-core.

Follow the installation guide if you don't have them installed already.

Installation

Add it to your my-fuel-dapp project:

::: code-group

npm install fuels@{{fuels}} --save

pnpm add fuels@{{fuels}}

bun add fuels@{{fuels}}

:::

Double-checking

npx fuels@{{fuels}} -v

Next Step

Use fuels init to create a fuel.config.ts file.