Install/Update¶

This section covers installing and updating ovi. Currently this must be done manually. As the project evolves, a curl‑to‑bash installer/updater will be added.

Installation¶

Clone the git repo for the latest changes, or download the .zip file from the release you want and extract it.
Change into the directory containing the source code
Run the setup script:
```
bash setup.sh
```

The installation is now complete!

Updating¶

If you cloned the git repo during installation, simply run git pull. If you downloaded a .zip file, download the new release and extract it.
Change into the directory containing the new source code
Run the setup script again:
```
bash setup.sh
```

ovi has now been updated!

Setup script¶

This file, located at project_root/setup.sh, is a bash script that does the following:

Warning

DO NOT run this script as root.

Note

This script must be run as a user with sudo privileges

Check for sudo privileges
Grant executable permissions to ovi
Install the python3.14-venv package if not present
Create the Python virtual environment and install required packages.
Create the global symlink into PATH. If an existing command named ovi is found and it is not an ovi installation, the script will abort for safety. If you are certain you want to override the command, run the setup script again with the --force flag.

This script is safe to run multiple times.

You are welcome to inspect the script before running it.

If you encounter any bugs/issues, open an issue on GitHub