Skip to content

Swaps to LK init #53

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

Merged
aryeila merged 2 commits into from
Mar 10, 2026
+14 −0
Merged

Swaps to LK init #53

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
730ce98
lk init
aryeila Mar 4, 2026
5390c19
Wrap manual setup in collapsed section
aryeila Mar 10, 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
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,18 @@ The project includes a complete [AGENTS.md](AGENTS.md) file for these assistants

## Dev Setup

Create a project from this template with the LiveKit CLI (recommended):

```bash
lk cloud auth
lk agent init my-agent --template agent-starter-python
```

The CLI clones the template and configures your environment. Then follow the rest of this guide from [Run the agent](#run-the-agent).

<details>
<summary>Alternative: manual setup without the CLI</summary>

Clone the repository and install dependencies to a virtual environment:

```console
Expand All @@ -69,6 +81,8 @@ lk cloud auth
lk app env -w -d .env.local
```

</details>

## Run the agent

Before your first run, you must download certain models such as [Silero VAD](https://docs.livekit.io/agents/build/turns/vad/) and the [LiveKit turn detector](https://docs.livekit.io/agents/build/turns/turn-detector/):
Expand Down