<br />
<p align="center">
  <a href="https://developers.flow.com/tools/flow-cli/install">
    <img src="./cli-banner.svg" alt="Logo" width="270" height="auto">
  </a>

  <p align="center">
    <i>Flow CLI brings Flow to your terminal. Easily interact with the network and build your dapps.</i>
    <br />
    <a href="https://developers.flow.com/tools/flow-cli/install"><strong>Read the docs»</strong></a>
    <br />
    <br />
    <a href="https://github.com/onflow/flow-cli/issues">Report Bug</a>
    ·
    <a href="https://github.com/onflow/flow-cli/blob/master/CONTRIBUTING.md">Contribute</a>
    ·
    <a href="https://github.com/onflow/flow-cli/blob/master/CONTRIBUTING.md#cli-guidelines">Read Guidelines</a>
  </p>
</p>
<br />
<br />

## Installation

To install the Flow CLI, follow the [installation instructions](https://developers.flow.com/tools/flow-cli/install) on the Flow documentation website.

## Documentation

You can find the CLI documentation on the [CLI documentation website](https://developers.flow.com/tools/flow-cli).

## 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](https://developers.flow.com/tools/flow-cli).

```
Usage:
  flow [command]

👋 Welcome Flow developer!
   If you are starting a new flow project use our super commands, start by running 'flow init'. 

🔥 Super Commands
  generate     Generate template files for common Cadence code
  init         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
  flix         execute, generate, package
  flowser      Run Flowser project explorer
  test         Run Cadence tests

🏄 Flow Project
  deploy       Deploy all project contracts
  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

🔗 Dependency Manager
  dependencies Manage contracts and dependencies
```

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](https://developers.flow.com/tools/emulator).


![Alt Text](./cli.gif)

## Contributing 

Read [contributing](./CONTRIBUTING.md) document.
