Flow CLI
MacOS
Homebrew
_10brew install flow-cli
From a pre-built binary
This installation method only works on x86-64.
This script downloads and installs the appropriate binary for your system:
_10sh -ci "$(curl -fsSL https://raw.githubusercontent.com/onflow/flow-cli/master/install.sh)"
To update, simply re-run the installation command above.
It is currently not possible to install earlier versions of the Flow CLI with Homebrew.
Linux
From a pre-built binary
This installation method only works on x86-64.
This script downloads and installs the appropriate binary for your system:
_10sh -ci "$(curl -fsSL https://raw.githubusercontent.com/onflow/flow-cli/master/install.sh)"
To update, simply re-run the installation command above.
Install a specific version
To install a specific version of Flow CLI newer than v0.42.0, append the version tag to the command (e.g. the command below installs CLI version v0.44.0).
_10sh -ci "$(curl -fsSL https://raw.githubusercontent.com/onflow/flow-cli/master/install.sh)" -- v0.44.0
To install a version older than v0.42.0, refer to Installing versions before 0.42.0 below.
Windows
From a pre-built binary
This installation method only works on Windows 10, 8.1, or 7 (SP1, with PowerShell 3.0), on x86-64.
-
Open PowerShell (Instructions)
-
In PowerShell, run:
_10iex "& { $(irm 'https://raw.githubusercontent.com/onflow/flow-cli/master/install.ps1') }"
To update, simply re-run the installation command above.
Create your first project
With the Flow CLI super commands, initiating your new project becomes effortless. Execute the flow setup command and make a selection from a variety of accessible scaffolds:
_19> flow setup hello-world --scaffold_19_19🔨 General Scaffolds_19 [1] Empty Cadence Project - Empty project containing only basic folder structure and flow.json configuration._19 [2] Simple Cadence Project - Scaffold contains required folder structure as well as some example Cadence code._19 [3] Cadence NFT Project - Scaffold contains the ExampleNFT sample NFT contract._19 [4] Hybrid Custody Project - Starter for exploring & implementing Hybrid Custody._19_19💻 Web Scaffolds_19 [5] FCL Web Dapp - Simple TypeScript web application using next.js, FCL, and Cadence._19_19📱 Mobile Scaffolds_19 [6] Swift iOS simple example - iOS example demonstrating usage of FCL and Flow interactions._19 [7] Android simple example - Android example demonstrating usage of FCL and Flow interactions._19 [8] FCL React Native Mobile Dapp - React Native (Expo) mobile dapp example demonstrating FCL and Flow interactions._19_19🏀 Unity Scaffolds_19 [9] Simple Unity - Simple example demonstrating how to interact with the Flow network using Unity SDK._19 [10] Mobile Unity Game - Example words game built on Flow using the Unity SDK.
After you have created your new project, you can proceed to writing contracts. Once your contracts have been written, run the flow dev
command the CLI will deploy them to the Flow emulator. Flow emulator is
a simplified version of Flow network that runs locally. It makes writing, deploying and testing contracts easier.
So proceed by starting the emulator:
_10> flow emulator
And then the flow dev:
_10> flow dev
Next steps
As part of the next steps you can read more about flow dev command.