Skip to content

Revise installation steps and add Docker instructions #163

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
CorinBos wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

Revise installation steps and add Docker instructions #163

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
899c1cc
Revise installation steps and add Docker instructions
CorinBos Mar 6, 2026
ec12bd6
Fix punctuation in environment variable instruction
CorinBos Mar 6, 2026
07b4175
Update cloning instructions in README
CorinBos Mar 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 22 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,16 +57,35 @@ By default, Metis uses **ChromaDB** for local, no-setup usage. You can also use

### 1. **Installation**

After cloning the repository, you can either create a virtual environment or install dependencies system-wide.
Clone the repository by forking it to your own GitHub account, then run:
Comment thread
CorinBos marked this conversation as resolved.
Outdated
```bash
git clone https://github.com/YOUR_USERNAME/metis.git
cd metis
```
You can either create a virtual environment or install dependencies system-wide.

To use a virtual environment (recommended):

Create the virtual environment.
```bash
uv venv
```
Activate the virtual environment.

Linux/MacOS
```bash
source .venv/bin/activate
```
Windows
```bash
.venv\Scripts\activate
```
Then run:
```bash
uv pip install .
```

or install system wide using --system:
Or install system wide using --system:

```bash
uv pip install . --system
Expand All @@ -79,12 +98,8 @@ uv pip install '.[postgres]'
```

### 1.1 **Docker**

Ensure docker is installed which can be completed [here](https://docs.docker.com/get-started/get-docker/).
```bash
git clone https://github.com/arm/metis.git

cd metis

docker build -t metis .
```

Expand Down