Skip to content

Commit 3cd407b

Browse files
committed
update readme
1 parent 1a1d6be commit 3cd407b

File tree

1 file changed

+40
-8
lines changed

1 file changed

+40
-8
lines changed

agent_video/pipecat/README.md

Lines changed: 40 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ For a complete documentation on how the agent works and how to setup the service
1111
- Python 3.10 or higher
1212
- Deepgram account (For speech-to-text transcription)
1313
- Cartesia account (for text-to-speech and voice cloning)
14-
- Tavus account (for video replica)
14+
- Tavus or Heygen account (for video replica)
1515

1616
## Start Restack
1717

@@ -21,9 +21,17 @@ To start the Restack, use the following Docker command:
2121
docker run -d --pull always --name restack -p 5233:5233 -p 6233:6233 -p 7233:7233 -p 9233:9233 ghcr.io/restackio/restack:main
2222
```
2323

24-
## Start python shell
24+
## Configure environment variables
2525

26-
If using uv:
26+
In all subfolders, duplicate the `env.example` file and rename it to `.env`.
27+
28+
Obtain a Restack API Key to interact with the 'gpt-4o-mini' model at no cost from [Restack Cloud](https://console.restack.io/starter)
29+
30+
## Start Restack Agent
31+
32+
in /agent
33+
34+
### Start python shell
2735

2836
```bash
2937
uv venv && source .venv/bin/activate
@@ -35,7 +43,7 @@ If using pip:
3543
python -m venv .venv && source .venv/bin/activate
3644
```
3745

38-
## Install dependencies
46+
### Install dependencies
3947

4048
If using uv:
4149

@@ -51,13 +59,37 @@ pip install -e .
5159
python -c "from src.services import watch_services; watch_services()"
5260
```
5361

54-
## Configure Your Environment Variables
62+
## Start Pipecat pipeline
5563

56-
Duplicate the `env.example` file and rename it to `.env`.
64+
in /pipeline
5765

58-
Obtain a Restack API Key to interact with the 'gpt-4o-mini' model at no cost from [Restack Cloud](https://console.restack.io/starter)
66+
### Start python shell
67+
68+
```bash
69+
uv venv && source .venv/bin/activate
70+
```
71+
72+
If using pip:
5973

60-
## Create Room and run Agent in parallel
74+
```bash
75+
python -m venv .venv && source .venv/bin/activate
76+
```
77+
78+
### Install dependencies
79+
80+
If using uv:
81+
82+
```bash
83+
uv sync
84+
uv run dev
85+
```
86+
87+
If using pip:
88+
89+
```bash
90+
pip install -e .
91+
python -c "from src.services import watch_services; watch_services()"
92+
```
6193

6294
### from UI
6395

0 commit comments

Comments
 (0)