Skip to content

Commit 04926f3

Browse files
authored
Update README.md
1 parent fff75d8 commit 04926f3

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

README.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,11 @@
22

33
A local proxy for LLMs, providing a unified interface for multiple models and support for identity based authentication.
44

5-
## Example config
5+
## Getting started
6+
7+
First create your ~/.prompt-passage.yaml file and configure your providers:
8+
9+
### Example config
610

711
```yaml
812
service:
@@ -30,6 +34,26 @@ providers:
3034
type: azure
3135
```
3236
37+
### Running prompt-passage
38+
39+
Run prompt-passage to start the local proxy
40+
41+
```bash
42+
# Run az login if using azure credentials
43+
44+
# Run prompt passage
45+
pipx run prompt-passage
46+
```
47+
48+
### Connecting
49+
50+
Use `OpenAI compatible`, `Azure OpenAI`, or similar option from the tool you are trying to connect with.
51+
52+
Base url: `http://localhost:8095/providers/{your provider name}/`
53+
54+
API token can be any value unless auth is enabled.
55+
56+
3357
## Dev environment setup
3458

3559
```bash

0 commit comments

Comments
 (0)