# Outer Wilds Mod Manager CLI
The CLI interface for the Outer Wilds Mod Manager, built using clap.
Core |
CLI |
GUI
[](https://crates.io/crates/owmods_cli)
[](https://github.com/ow-mods/ow-mod-man/blob/main/LICENSE)
[](https://github.com/ow-mods/ow-mod-man/actions/workflows/ci_rs.yml)
[](https://github.com/ow-mods/ow-mod-man/actions/workflows/release_cli.yml)
[](https://aur.archlinux.org/packages/owmods-cli-bin)
The CLI interface for the [Outer Wilds Mod Manager](https://github.com/ow-mods/ow-mod-man), this package is responsible for providing a streamlined way to manage, install, and validate your mods. As well as running the game. This is achieved using the [owmods_core](https://crates.io/crates/owmods_core) package.
## Usage
Run `owmods help` for a list of commands
### Shortcuts
Some command shortcuts exist for convenience
- `install` -> `i`
- `install-zip` -> `iz`
- `install-url` -> `iu`
- `list` -> `ls`
- `update` -> `up`
- `enable` -> `e`
- `disable` -> `d`
- `uninstall` -> `rm`
- `readme` -> `man`
- `github` -> `repo`
- `protocol` -> `proto`
### Autocomplete
How to use value hints and generate shell completions.
Usage with zsh:
```console
owmods generate-completions zsh > /usr/local/share/zsh/site-functions/_owmods
compinit
```
Bash:
```console
owmods generate-completions bash > /usr/local/share/bash-completions/completions/_owmods
compinit
```
Fish:
```console
owmods generate-completions fish > owmods_autocomplete.fish
. ./owmods_autocomplete.fish
```
Check [clap_complete docs](https://docs.rs/clap_complete/latest/clap_complete/shells/enum.Shell.html#variants) for a list of all supported shells.
## Building
This package requires rust and cargo to build.
Run `cargo build -p owmods_cli --release` from the **root of the repo** to create a release binary.