Skip to content

Commit

Permalink
add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ComradeVanti committed Nov 1, 2024
1 parent 1309cb3 commit 6dd6f46
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,16 @@ openupm deps com.my.package

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

### List installed packages

Use `openupm ls` to print the names and versions of installed packages.

```sh
openupm ls
```

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

### Global command options

There are also some global options that work for every command. You can read about them [here](./docs/global-opts.md).
Expand Down
18 changes: 18 additions & 0 deletions docs/cmd-ls.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@

# `openupm ls`

The `ls` command prints the name and version of each installed package for a project.

This command has the `list` alias. On this doc page we will always use the primary command name `ls`.

## Options

### Project directory

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.

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.

```sh
openupm add com.my.package -c /home/user/dev/MyProject
```

0 comments on commit 6dd6f46

Please sign in to comment.