Skip to content

Commit 3f2c098

Browse files
authored
docs: add path setup instructions (#861)
1 parent 973eb41 commit 3f2c098

File tree

2 files changed

+23
-4
lines changed

2 files changed

+23
-4
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,14 @@ Or install a [specific version](https://pub.dev/packages/very_good_cli/versions)
3434
dart pub global activate very_good_cli <version>
3535
```
3636

37+
If you haven't already, you might need to [set up your path][path_setup_link].
38+
39+
When that is not possible (eg: CI environments), run `very_good` commands via:
40+
41+
```sh
42+
dart pub global run very_good_cli:very_good <command> <args>
43+
```
44+
3745
### Commands ✨
3846

3947
### `very_good create`
@@ -194,3 +202,4 @@ Run "very_good help <command>" for more information about a command.
194202
[new_syntax_link]: site/docs/resources/syntax_changes_in_0_10_0.md
195203
[very_good_create]: https://raw.githubusercontent.com/VeryGoodOpenSource/very_good_cli/main/doc/assets/very_good_create.gif
196204
[very_good_ventures_link]: https://verygood.ventures
205+
[path_setup_link]: https://dart.dev/tools/pub/cmd/pub-global#running-a-script-from-your-path

site/docs/overview.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,20 @@ Very Good CLI requires Dart `">=3.1.0 <4.0.0"`
2424
dart pub global activate very_good_cli
2525
```
2626

27+
Or install a [specific version](https://pub.dev/packages/very_good_cli/versions) using:
28+
29+
```sh
30+
dart pub global activate very_good_cli <version>
31+
```
32+
33+
If you haven't already, you might need to [set up your path][path_setup_link].
34+
35+
When that is not possible (eg: CI environments), run `very_good` commands via:
36+
37+
```sh
38+
dart pub global run very_good_cli:very_good <command> <args>
39+
```
40+
2741
## Commands
2842

2943
### `very_good create`
@@ -48,10 +62,6 @@ Available subcommands:
4862
Run "very_good help" to see global options.
4963
```
5064

51-
#### Syntax changes in 0.10.0
52-
53-
⚠️ v0.10.0 changed the syntax of the `very_good create` command. Learn about the changes [here][new_syntax_link].
54-
5565
### `very_good packages get`
5666

5767
Get packages in a Dart or Flutter project.

0 commit comments

Comments
 (0)