Skip to content

Commit 3f019a4

Browse files
committed
Add new command osi download, package name and uv instructions
1 parent a9f85cf commit 3f019a4

1 file changed

Lines changed: 12 additions & 3 deletions

File tree

README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44

55
## Installation
66

7-
You can install it from PyPi or from Docker.
7+
You can install it from PyPI or from Docker.
88

9-
From PyPi, install the package with `pip install osi`.
9+
From PyPi, install the package with `pip install opensyndrome`. Then run it with `osi`.
1010

1111
From Docker, you can run the following command to build the image, tagged `osi`:
1212

@@ -36,6 +36,15 @@ docker run --name osi-cli -it osi
3636

3737
## Usage
3838

39+
First, download the schema and definitions in order to work with the CLI locally.
40+
41+
```bash
42+
osi download schema
43+
osi download definitions
44+
```
45+
46+
The files will be placed in the folder `.open_syndrome` in `$HOME`.
47+
3948
### Convert a human-readable syndrome definition to a machine-readable JSON
4049

4150
You need to have [Ollama](https://github.com/ollama/ollama) installed locally
@@ -76,7 +85,7 @@ To get started with development, you need to have [Poetry](https://python-poetry
7685
### Install dependencies
7786

7887
```bash
79-
poetry install
88+
uv sync
8089
```
8190

8291
### Generate Ollama-compatible JSON

0 commit comments

Comments
 (0)