https://github.com/onflow/flow-cli

The Flow CLI is a command-line interface that provides useful utilities for building Flow applications
https://github.com/onflow/flow-cli

blockchain cli command-line flow

Last synced: about 1 month ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/onflow/flow-cli
• Owner: onflow
• License: apache-2.0
• Created: 2020-10-30T20:46:17.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2024-04-13T00:13:18.000Z (8 months ago)
• Last Synced: 2024-04-13T17:12:50.849Z (8 months ago)
• Topics: blockchain, cli, command-line, flow
• Language: Go
• Homepage: https://onflow.org
• Size: 67.1 MB
• Stars: 205
• Watchers: 40
• Forks: 60
• Open Issues: 81
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

• best-of-crypto - GitHub - 14% open · ⏱️ 05.06.2024): (Others)

README

        





  

    

  

  


    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](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 try running 'flow setup '. 

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

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

## Contributing 

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