Skip to content

Commit 0fcd611

Browse files
committed
docs: updated readme for env:list command
1 parent 2347266 commit 0fcd611

File tree

2 files changed

+23
-12
lines changed

2 files changed

+23
-12
lines changed

README.md

+21-10
Original file line numberDiff line numberDiff line change
@@ -122,11 +122,12 @@ environment and repositories.
122122
| 1 | dev help | List of all available commands. |
123123
| 2 | dev self-update | Update DEV.env to the latest version. |
124124
| 3 | dev env:config | Add development environment setup file to DEV.env. |
125-
| 4 | dev env:setup | Setup development environment. |
126-
| 5 | dev repos:config | Add repositories YAML file to DEV.env. |
127-
| 6 | dev repos:publish | Publish repositories YAML file to a project directory. |
128-
| 7 | dev repos:setup | Setup Git Repositories from repositories YAML file. |
129-
| 8 | dev repos:status | List all Git Repositories and setup status. |
125+
| 4 | dev env:list | List available development environment setup files. |
126+
| 5 | dev env:setup | Setup development environment. |
127+
| 6 | dev repos:config | Add repositories YAML file to DEV.env. |
128+
| 7 | dev repos:publish | Publish repositories YAML file to a project directory. |
129+
| 8 | dev repos:setup | Setup Git Repositories from repositories YAML file. |
130+
| 9 | dev repos:status | List all Git Repositories and setup status. |
130131

131132
Below I have provided more information on each ***DEV.env*** CLI command.
132133

@@ -223,7 +224,17 @@ $ dev env:config git@<git-url>.git --only=macos
223224
$ dev env:config git@<git-url>.git --only=macos,vscode
224225
```
225226

226-
#### 4. <ins>Setup development environment</ins>
227+
#### 4. <ins>List available development environment setup files</ins>
228+
229+
***DEV.env*** offers a `env:list` command to show a list of available
230+
development environment files in a table view that have been configured using
231+
***DEV.env*** `env:config` command.
232+
233+
```bash
234+
$ dev env:list
235+
```
236+
237+
#### 5. <ins>Setup development environment</ins>
227238

228239
Once you have added your development environment setup files to ***DEV.env***.
229240
You can use the `env:setup` command to run the various setup files to configure
@@ -239,7 +250,7 @@ $ dev env:setup macos
239250
$ dev env:setup macos vscode
240251
```
241252

242-
#### 5. <ins>Add repositories YAML file to DEV.env</ins>
253+
#### 6. <ins>Add repositories YAML file to DEV.env</ins>
243254

244255
***DEV.env*** allows you to add your pre-existing YAML repositories
245256
configuration files. Similar to the `env:config` command, you can provide a
@@ -285,7 +296,7 @@ $ dev repos:config git@<git-url>.git --only=personal
285296
$ dev repos:config git@<git-url>.git --only=personal,company
286297
```
287298

288-
#### 6. <ins>Publish DEV.env repositories configuration templates</ins>
299+
#### 7. <ins>Publish DEV.env repositories configuration templates</ins>
289300

290301
Before ***DEV.env*** can set up your repositories, you will need to publish a
291302
YAML repositories configuration file to your projects root directory. You can
@@ -328,7 +339,7 @@ directory.
328339
$ dev repos:publish personal
329340
```
330341

331-
#### 7. <ins>Setup git repositories</ins>
342+
#### 8. <ins>Setup git repositories</ins>
332343

333344
Once you have published your YAML repository configuration file. You will need
334345
to provide the following information.
@@ -413,7 +424,7 @@ The `repos:setup` command also accepts a repositories name as an argument.
413424
$ dev repos:setup repository-name
414425
```
415426

416-
#### 8. <ins>Check git repositories setup status</ins>
427+
#### 9. <ins>Check git repositories setup status</ins>
417428

418429
Although you are not required to use ***DEV.env*** to manage your development
419430
environment, ***DEV.env*** does offer a `repos:status` command to show a list

images/dev-env-cli.svg

+2-2
Loading

0 commit comments

Comments
 (0)