onflow / flow-cli

The Flow CLI is a command-line interface that provides useful utilities for building Flow applications

Flow CLI brings Flow to your terminal. Easily interact with the network and build your dapps.
Read the docs»

Report Bug · Contribute · Read Guidelines

Installation

To install the Flow CLI, follow the installation instructions on the Flow documentation website.

Documentation

You can find the CLI documentation on the CLI documentation website.

Features

The Flow CLI is a command line tool that allows you to interact with the Flow blockchain. Read about supported commands in the CLI documentation website.

Usage:
  flow [command]

👋 Welcome Flow developer!
   If you are starting a new flow project try running 'flow setup <project_name>'. 

🔥 Super Commands
  dev          Build your Flow project
  flix         Execute FLIX template with a given id, name, or local filename
  generate     Generate new boilerplate files
  setup        Start a new Flow project

📦 Flow Entities
  accounts     Create and retrieve accounts and deploy contracts
  blocks       Retrieve blocks
  collections  Retrieve collections
  events       Retrieve events

💬 Flow Interactions
  scripts      Execute Cadence scripts
  transactions Build, sign, send and retrieve transactions

🔨 Flow Tools
  cadence      Execute Cadence code
  dev-wallet   Run a development wallet
  emulator     Run Flow network for development
  flowser      Run Flowser project explorer
  test         Run Cadence tests

🏄 Flow Project
  deploy       Deploy all project contracts
  init         Initialize a new configuration
  project      Manage your Cadence project
  run          Start emulator and deploy all project contracts

🔒 Flow Security
  keys         Generate and decode Flow keys
  signatures   Signature verification and creation

The Flow CLI includes several commands to interact with Flow networks, such as querying account information, or sending transactions. It also includes the Flow Emulator.

Contributing

Read contributing document.