gmakstutis/openrag
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 2

use-uvx

Browse source
This commit is contained in:
Mendon Kissling 2025-10-28 09:52:03 -04:00
parent ff4ddc7fc9
commit af7eaddfb1
1 changed files with 31 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

49
docs/docs/get-started/install.mdx
View file

@ -17,7 +17,7 @@ Instead of starting OpenRAG using Docker commands and manually editing values in
Once OpenRAG is running, use the TUI to monitor your application, control your containers, and retrieve logs. Once OpenRAG is running, use the TUI to monitor your application, control your containers, and retrieve logs.
If you prefer running Docker commands and manually editing `.env` files, see [Install with Docker](/get-started/docker). If you prefer running Podman or Docker containers and manually editing `.env` files, see [Install OpenRAG Containers](/get-started/docker).
## Prerequisites ## Prerequisites
@ -30,10 +30,6 @@ If you prefer running Docker commands and manually editing `.env` files, see [In
## Install the OpenRAG Python wheel {#install-python-wheel} ## Install the OpenRAG Python wheel {#install-python-wheel}
:::important
The `.whl` file is currently available as an internal download during public preview, and will be published to PyPI in a future release.
:::
The OpenRAG wheel installs the Terminal User Interface (TUI) for configuring and running OpenRAG. The OpenRAG wheel installs the Terminal User Interface (TUI) for configuring and running OpenRAG.
1. Create a new project with a virtual environment using `uv init`. 1. Create a new project with a virtual environment using `uv init`.
@ -46,26 +42,43 @@ The OpenRAG wheel installs the Terminal User Interface (TUI) for configuring and
The `(venv)` prompt doesn't change, but `uv` commands will automatically use the project's virtual environment. The `(venv)` prompt doesn't change, but `uv` commands will automatically use the project's virtual environment.
For more information on virtual environments, see the [uv documentation](https://docs.astral.sh/uv/pip/environments). For more information on virtual environments, see the [uv documentation](https://docs.astral.sh/uv/pip/environments).
2. Add the local OpenRAG wheel to your project's virtual environment. 2. Ensure all dependencies are installed and updated in your virtual environment.
```bash
uv add PATH/TO/openrag-VERSION-py3-none-any.whl
```
Replace `PATH/TO/` and `VERSION` with the path and version of your downloaded OpenRAG `.whl` file.
For example, if your `.whl` file is in the `~/Downloads` directory, the command is `uv add ~/Downloads/openrag-0.1.8-py3-none-any.whl`.
3. Ensure all dependencies are installed and updated in your virtual environment.
```bash ```bash
uv sync uv sync
``` ```
4. Start the OpenRAG TUI. 3. Install and start the OpenRAG TUI.
```bash ```bash
uv run openrag uvx openrag
``` ```
<details closed>
<summary>Install a local wheel without uvx</summary>
If you downloaded the OpenRAG wheel to your local machine, follow these steps:
1. Add the wheel to your project's virtual environment.
```bash
uv add PATH/TO/openrag-VERSION-py3-none-any.whl
```
Replace `PATH/TO/` and `VERSION` with the path and version of your downloaded OpenRAG `.whl` file.
For example, if your `.whl` file is in the `~/Downloads` directory:
```bash
uv add ~/Downloads/openrag-0.1.8-py3-none-any.whl
```
2. Run OpenRAG.
```bash
uv run openrag
```
</details>
4. Continue with [Set up OpenRAG with the TUI](#setup).
5. Continue with [Set up OpenRAG with the TUI](#setup).
## Set up OpenRAG with the TUI {#setup} ## Set up OpenRAG with the TUI {#setup}