Skip to content

Commit

Permalink
expand remove docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ComradeVanti committed Oct 3, 2024
1 parent acf9429 commit 399640d
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,9 +85,14 @@ openupm add com.my.package@1.2.3
Checkout [the commands doc page](./docs/cmd-add.md) for more information.

### Remove packages

Use `openupm remove` to remove one or more dependencies from your project.

```sh
openupm remove com.my.package
```
openupm remove <pkg> [otherPkgs...]
```

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

### Search packages
```
Expand Down
31 changes: 31 additions & 0 deletions docs/cmd-remove.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# `openupm remove`

The `remove` command removes one or more dependencies from a Unity project. This means that it removes the given packages from the projects direct dependencies. It also removes any unneeded scoped registries.

_Currently openupm does not delete the packages from the package cache. This is left for Unity to do._

You should run this command inside the projects root directory.

This command has the following aliases: `rm` and `uninstall`. On this doc page we will always use the primary command name `remove`.

## Arguments

### Packages

Specify one or more packages for openupm to remove. You should only specify the name of a package ie `com.my.package`.

```sh
openupm remove com.my.package
```

## Options

### Project directory

By default openupm expects that you run the 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 remove com.my.package -c /home/user/dev/MyProject
```

0 comments on commit 399640d

Please sign in to comment.