Skip to content

Commit 6dd6f46

Browse files
committed
add docs
1 parent 1309cb3 commit 6dd6f46

File tree

2 files changed

+28
-0
lines changed

2 files changed

+28
-0
lines changed

README.md

+10
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,16 @@ openupm deps com.my.package
118118

119119
Checkout [the commands doc page](./docs/cmd-deps.md) for more information.
120120

121+
### List installed packages
122+
123+
Use `openupm ls` to print the names and versions of installed packages.
124+
125+
```sh
126+
openupm ls
127+
```
128+
129+
Checkout [the commands doc page](./docs/cmd-ls.md) for more information.
130+
121131
### Global command options
122132

123133
There are also some global options that work for every command. You can read about them [here](./docs/global-opts.md).

docs/cmd-ls.md

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
2+
# `openupm ls`
3+
4+
The `ls` command prints the name and version of each installed package for a project.
5+
6+
This command has the `list` alias. On this doc page we will always use the primary command name `ls`.
7+
8+
## Options
9+
10+
### Project directory
11+
12+
By default openupm expects that you run the add command inside your Unity projects root directory. Based on this it determines relative paths to your package manifest etc.
13+
14+
If you need to run openupm from somewhere else you can change the working directory using the `--chdir`/`-c` option. This option accepts an **absolute** path to a Unity projects root directory.
15+
16+
```sh
17+
openupm add com.my.package -c /home/user/dev/MyProject
18+
```

0 commit comments

Comments
 (0)