Skip to content

Commit

Permalink
docs: add path setup instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
renancaraujo committed Oct 18, 2023
1 parent 973eb41 commit a53449c
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 4 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,14 @@ Or install a [specific version](https://pub.dev/packages/very_good_cli/versions)
dart pub global activate very_good_cli <version>
```

If you haven't already, you might need to [set up your path][path_setup_link].

When that is not possible (eg: CI environments), run `very_good` commands via:

```sh
dart pub global run very_good_cli:very_good <command> <args>
```

### Commands ✨

### `very_good create`
Expand Down Expand Up @@ -194,3 +202,4 @@ Run "very_good help <command>" for more information about a command.
[new_syntax_link]: site/docs/resources/syntax_changes_in_0_10_0.md
[very_good_create]: https://raw.githubusercontent.com/VeryGoodOpenSource/very_good_cli/main/doc/assets/very_good_create.gif
[very_good_ventures_link]: https://verygood.ventures
[path_setup_link]: https://dart.dev/tools/pub/cmd/pub-global#running-a-script-from-your-path
18 changes: 14 additions & 4 deletions site/docs/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,20 @@ Very Good CLI requires Dart `">=3.1.0 <4.0.0"`
dart pub global activate very_good_cli
```

Or install a [specific version](https://pub.dev/packages/very_good_cli/versions) using:

```sh
dart pub global activate very_good_cli <version>
```

If you haven't already, you might need to [set up your path][path_setup_link].

When that is not possible (eg: CI environments), run `very_good` commands via:

```sh
dart pub global run very_good_cli:very_good <command> <args>
```

## Commands

### `very_good create`
Expand All @@ -48,10 +62,6 @@ Available subcommands:
Run "very_good help" to see global options.
```

#### Syntax changes in 0.10.0

⚠️ v0.10.0 changed the syntax of the `very_good create` command. Learn about the changes [here][new_syntax_link].

### `very_good packages get`

Get packages in a Dart or Flutter project.
Expand Down

0 comments on commit a53449c

Please sign in to comment.