Skip to content

Commit

Permalink
Merge pull request #1848 from onflow/cf/update-readme
Browse files Browse the repository at this point in the history
Update readme with current commands
  • Loading branch information
chasefleming authored Nov 26, 2024
2 parents aeac68a + c9bc289 commit 308f7f1
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,13 +37,11 @@ Usage:
flow [command]
👋 Welcome Flow developer!
If you are starting a new flow project try running 'flow setup <project_name>'.
If you are starting a new flow project use our super commands, start by running 'flow init'.
🔥 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
generate Generate template files for common Cadence code
init Start a new Flow project
📦 Flow Entities
accounts Create and retrieve accounts and deploy contracts
Expand All @@ -59,19 +57,21 @@ Usage:
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
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
🔗 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).
Expand Down
2 changes: 1 addition & 1 deletion internal/command/template.go
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Examples:
{{.Example}}{{end}}
{{if .HasAvailableSubCommands}}{{if (eq .Name "flow")}}
👋 Welcome Flow developer!
If you are starting a new flow project use our super commands, start by running 'flow setup'. {{end}}{{end}}{{if .HasAvailableSubCommands}}{{$cmds := .Commands}}{{if eq (len .Groups) 0}}
If you are starting a new flow project use our super commands, start by running 'flow init'. {{end}}{{end}}{{if .HasAvailableSubCommands}}{{$cmds := .Commands}}{{if eq (len .Groups) 0}}
Available Commands:{{range $cmds}}{{if (or .IsAvailableCommand (eq .Name "help"))}}
{{rpad .Name .NamePadding }} {{.Short}}{{end}}{{end}}{{else}}{{range $group := .Groups}}
Expand Down

0 comments on commit 308f7f1

Please sign in to comment.