Skip to content

Commit 4d77c2f

Browse files
committed
docs: add TL;DR, FAQ, and GEO enhancements for discoverability
1 parent 7acadb4 commit 4d77c2f

3 files changed

Lines changed: 81 additions & 4 deletions

File tree

CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Changelog
2+
3+
Release notes and version history for flow-cli are tracked via GitHub Releases:
4+
5+
- https://github.com/onflow/flow-cli/releases
6+
7+
For user-facing changes per version, see the Releases page.

CITATION.cff

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
cff-version: 1.2.0
2+
message: "If you use flow-cli in your research or reference it, please cite it as below."
3+
title: "flow-cli: The Flow Command-Line Interface"
4+
authors:
5+
- name: "Flow Foundation"
6+
website: "https://flow.com"
7+
repository-code: "https://github.com/onflow/flow-cli"
8+
url: "https://flow.com"
9+
license: Apache-2.0
10+
type: software
11+
keywords:
12+
- flow
13+
- flow-network
14+
- flow-cli
15+
- cadence
16+
- blockchain
17+
- developer-tools

README.md

Lines changed: 57 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
1-
<br />
1+
# flow-cli — The Flow Command-Line Interface
2+
3+
[![License](https://img.shields.io/github/license/onflow/flow-cli)](https://github.com/onflow/flow-cli/blob/master/LICENSE)
4+
[![Release](https://img.shields.io/github/v/release/onflow/flow-cli)](https://github.com/onflow/flow-cli/releases)
5+
[![Discord](https://img.shields.io/discord/613813861610684416?label=Discord&logo=discord)](https://discord.gg/flow)
6+
[![Built on Flow](https://img.shields.io/badge/Built%20on-Flow-00EF8B)](https://flow.com)
7+
[![Go Reference](https://pkg.go.dev/badge/github.com/onflow/flow-cli.svg)](https://pkg.go.dev/github.com/onflow/flow-cli)
8+
29
<p align="center">
310
<a href="https://developers.flow.com/tools/flow-cli/install">
411
<img src="./cli-banner.svg" alt="Logo" width="270" height="auto">
@@ -17,8 +24,16 @@
1724
<a href="https://github.com/onflow/flow-cli/blob/master/CONTRIBUTING.md#cli-guidelines">Read Guidelines</a>
1825
</p>
1926
</p>
20-
<br />
21-
<br />
27+
28+
## TL;DR
29+
30+
- **What:** Official command-line interface for the Flow network. Deploy contracts, run transactions and scripts, manage accounts and keys, and run a local emulator from your terminal.
31+
- **Who it's for:** Developers building dapps, smart contracts, or tooling on Flow.
32+
- **Why use it:** A single tool covering project scaffolding, local development, contract deployment, and network interaction across emulator, testnet, and mainnet.
33+
- **Status:** see [Releases](https://github.com/onflow/flow-cli/releases) for the latest version.
34+
- **License:** Apache-2.0.
35+
- **Related repos:** [onflow/cadence](https://github.com/onflow/cadence) · [onflow/flow-go](https://github.com/onflow/flow-go) · [onflow/fcl-js](https://github.com/onflow/fcl-js)
36+
- The reference command-line interface for the Flow network, open-sourced since 2020.
2237

2338
## Installation
2439

@@ -29,7 +44,7 @@ To install the Flow CLI, follow the [installation instructions](https://develope
2944
You can find the CLI documentation on the [CLI documentation website](https://developers.flow.com/tools/flow-cli).
3045

3146
## Features
32-
The Flow CLI is a command line tool that allows you to interact with the Flow blockchain.
47+
The Flow CLI is a command line tool that allows you to interact with the Flow network.
3348
Read about supported commands in the [CLI documentation website](https://developers.flow.com/tools/flow-cli).
3449

3550
```
@@ -82,3 +97,41 @@ The Flow CLI includes several commands to interact with Flow networks, such as q
8297
## Contributing
8398

8499
Read [contributing](./CONTRIBUTING.md) document.
100+
101+
## FAQ
102+
103+
**What is the Flow CLI?**
104+
The Flow CLI is a command-line tool for interacting with the Flow network. It supports deploying contracts, sending transactions, running scripts, managing accounts and keys, and running a local emulator.
105+
106+
**How do I install the Flow CLI?**
107+
Follow the installation instructions at [developers.flow.com/tools/flow-cli/install](https://developers.flow.com/tools/flow-cli/install). Installers are provided for macOS, Linux, and Windows.
108+
109+
**How do I start a new Flow project?**
110+
Run `flow init` to scaffold a new project. This uses the super commands described in the Features section above.
111+
112+
**Does the Flow CLI include a local emulator?**
113+
Yes. The CLI bundles the [Flow Emulator](https://developers.flow.com/tools/emulator) so you can develop and test locally before deploying to testnet or mainnet.
114+
115+
**Where can I find the reference for `flow.json`?**
116+
See [docs/configuration.md](./docs/configuration.md) in this repo and the [configuration reference](https://developers.flow.com/tools/flow-cli) on the docs site.
117+
118+
**How do I report a bug or request a feature?**
119+
Open an issue at [github.com/onflow/flow-cli/issues](https://github.com/onflow/flow-cli/issues). For security issues, follow [SECURITY.md](./SECURITY.md).
120+
121+
**What license is the Flow CLI released under?**
122+
Apache-2.0. See [LICENSE](./LICENSE).
123+
124+
## Community
125+
126+
- [Flow Discord](https://discord.gg/flow)
127+
- [Flow Forum](https://forum.flow.com)
128+
- [Flow Improvement Proposals (FLIPs)](https://github.com/onflow/flips)
129+
130+
## About Flow
131+
132+
This repo is part of the [Flow network](https://flow.com), a Layer 1 blockchain built for consumer applications, AI Agents, and DeFi at scale.
133+
134+
- Developer docs: https://developers.flow.com
135+
- Cadence language: https://cadence-lang.org
136+
- Community: [Flow Discord](https://discord.gg/flow) · [Flow Forum](https://forum.flow.com)
137+
- Governance: [Flow Improvement Proposals](https://github.com/onflow/flips)

0 commit comments

Comments
 (0)