Cursor rules · livekit/agents-js

First lines (shown under the repo's Apache-2.0 license)

// SPDX-FileCopyrightText: 2025 LiveKit, Inc.
//
// SPDX-License-Identifier: Apache-2.0

---
description: Guidline on how to write code for @livekit/agents JS package
globs: *.ts,package.json
alwaysApply: false
---

# LiveKit Agents

Realtime framework for production-grade multimodal and voice AI agents.

## Project structure

```
.
|-- KMS
|   `-- logs
|-- LICENSES
|   |-- Apache-2.0.txt
|   `-- CC-BY-NC-SA-4.0.txt
|-- agents
|   |-- src
|   |   |-- ipc
|   |   |   |-- index.ts
|   |   |   |-- inference_executor.ts
|   |   |   |-- inference_proc_executor.ts
|   |   |   |-- inference_proc_lazy_main.ts
|   |   |   |-- job_executor.ts
|   |   |   |-- job_proc_executor.ts
|   |   |   |-- job_proc_lazy_main.ts
|   |   |   |-- message.ts
|   |   |   |-- proc_pool.ts
|   |   |   `-- supervised_proc.ts
|   |   |-- llm
|   |   |   |-- __snapshots__
|   |   |   |   |-- chat_context.test.ts.snap
|   |   |   |   |-- tool_context.test.ts.snap
|   |   |   |   `-- utils.test.ts.snap
|   |   |   |-- provider_format
|   |   |   |   |-- google.test.ts
|   |   |   |   |-- google.ts
|   |   |   |   |-- index.ts
|   |   |   |   |-- openai.test.ts
|   |   |   |   |-- openai.ts
|   |   |   |   `-- utils.ts
|   |   |   |-- chat_context.test.ts
|   |   |   |-- chat_context.ts
|   |   |   |-- index.ts
|   |   |   |-- llm.ts
|   |   |   |-- realtime.ts
|   |   |   |-- remote_chat_context.test.ts
|   |   |   |-- remote_chat_context.ts
|   |   |   |-- tool_context.test.ts
|   |   |   |-- tool_context.ts
|   |   |   |-- tool_context.type.test.ts
|   |   |   |-- utils.test.ts
|   |   |   `-- utils.ts
|   |   |-- metrics
|   |   |   |-- base.ts
|   |   |   |-- index.ts
|   |   |   |-- usage_collector.ts
|   |   |   `-- utils.ts
|   |   |-- multimodal
|   |   |   |-- agent_playout.ts
|   |   |   `-- index.ts
|   |   |-- stream
|   |   |   |-- deferred_stream.test.ts
|   |   |   |-- deferred_stream.ts
|   |   |   |-- identity_transform.test.ts
|   |   |   |-- identity_transform.ts
|   |   |   |-- index.ts
|   |   |   |-- merge_readable_streams.ts
|   |   |   |-- stream_channel.test.ts
|   |   |   `-- stream_channel.ts
|   |   |-- stt
|   |   |   |-- index.ts
|   |   |   |-- stream_adapter.ts
|   |   |   `-- stt.ts
|   |   |-- tokenize
|   |   |   |-- basic
|   |   |   |   |-- basic.ts
|   |   |   |   |-- hyphenator.ts
|   |   |   |   |-- index.ts
|   |   |   |   |-- paragraph.ts
|   |   |   |   |-- sentence.ts
|   |   |   |   `-- word.ts
|   |   |   |-- index.ts
|   |   |   |-- token_stream.ts
|   |   |   |-- tokenizer.test.ts
|   |   |   `-- tokenizer.ts
|   |   |-- tts
|   |   |   |-- index.ts
|   |   |   |-- stream_adapter.ts
|   |   |   `-- tts.ts
|   |   |-- voice   # voice agent core components
|   |   |   |-- avatar
|   |   |   |   |-- datastream_io.ts
|   |   |   |   `-- index.ts
|   |   |   |-- room_io
|   |   |   |   |-- _input.ts
|   |   |   |   |-- _output.ts
|   |   |   |   |-- index.ts
|   |   |   |   `-- room_io.ts
|   |   |   |-- transcription
|   |   |   |   |-- _utils.ts
|   |   |   |   |-- index.ts
|   |   |   |   `-- synchronizer.ts
|   |   |   |-- agent.test.ts
|   |   |   |-- agent.ts
|   |   |   |-- agent_activity.ts
|   |   |   |-- agent_session.ts
|   |   |   |-- audio_recognition.ts
|   |   |   |-- events.ts
|   |   |   |-- generation.ts
|   |   |   |-- index.ts
|   |   |   |-- io.ts
|   |   |   |-- run_context.ts
|   |   |   `-- speech_handle.ts
|   |   |-- _exceptions.ts
|   |   |-- audio.ts
|   |   |-- cli.ts
|   |   |-- constants.ts
|   |   |-- generator.ts
|   |   |-- http_server.ts
|   |   |-- index.ts
|   |   |-- inference_runner.ts
|   |   |-- job.ts
|   |   |-- log.ts
|   |   |-- plugin.ts
|   |   |-- transcription.ts
|   |   |-- types.ts
|   |   |-- utils.test.ts
|   |   |-- utils.ts
|   |   |-- vad.ts
|   |   |-- version.ts
|   |   `-- worker.ts
|   |-- CHANGELOG.md
|   |-- README.md
|   |-- api-extractor.json
|   |-- package.json
|   |-- tsconfig.json
|   `-- tsup.config.ts
|-- examples
|   |-- src
|   |   |-- drive-thru
|   |   |   |-- database.ts
|   |   |   |-- drivethru_agent.ts
|   |   |   `-- order.ts
|   |   |-- frontdesk
|   |   |   |-- calendar_api.test.ts
|   |   |   |-- calendar_api.ts
|   |   |   |-- calendar_integration.test.ts
|   |   |   `-- frontdesk_agent.ts
|   |   |-- Dockerfile-example
|   |   |-- basic_agent.ts
|   |   |-- basic_eou.ts
|   |   |-- basic_tool_call_agent.ts