Repository navigation
Lead the README with lk agent init, and let the agent detect the spoken language #111
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.
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
Open
bcherry
wants to merge
19
commits into
main
Choose a base branch
from
bcherry/inspiring-ramanujan-n56lsd
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
19 commits
Select commit
Hold shift + click to select a range
2cd066b
Recommend lk agent init and explain how to get the agent skills
claude 3b1e034
Show the full lk agent init command for each starter
claude 52d25fb
Tighten the skills and lk agent init wording
claude f552bab
Make the AGENTS.md skills instructions direct
claude 8f34a1d
Ask before installing the agent skills
claude f63afa4
Lead the README with getting started, then coding agents
claude 80ad8fb
Lead the README with getting started and drop manual setup
claude 70a1f46
Drop the Use this template tip
claude df4cb09
Drop docs search from the README
claude 65bbaba
Number the getting started steps and move coding agents down
claude 281506f
Fold LiveKit Cloud sign-up and lk cloud auth into the CLI step
claude f8e5c3c
Trim the project creation step
claude 06c5eb0
Add the package manager and dependency install to getting started
claude c590105
Merge main into the agent skills README branch
claude dfe87c5
Merge main into the agent skills README branch
claude e65df81
Drop the self-hosting section and other deploy targets from the README
claude 6a9824b
Make AGENTS.md match the CLI, and keep spoken formatting out of tool …
bcherry 811f0ea
Reword the spell-out rule to name TTS responses and tool arguments
bcherry a6278a6
Leave the STT language unset so the model detects and switches languages
bcherry File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -32,19 +32,21 @@ When you run into any problem with LiveKit, add it to your to-do list, then subm | |||||
|
|
||||||
| ## LiveKit agent skills | ||||||
|
|
||||||
| LiveKit publishes agent skills for each stage of the work: reading the docs, building, debugging, testing, writing scenarios, running simulations, and operating in production. They defer to the live documentation for API details. Before you start a task, check that they're installed: look for `.agents/skills/` or `.claude/skills/` in this project, or in the developer's home directory for a global install. If they're missing, install them with `lk skills install --yes`, which installs them for the coding agents it detects and adds the LiveKit Docs MCP server to their config. If you can't run commands, or the CLI has no `skills` command (it was added in v2.19.0), ask the developer to update the CLI and run `lk skills install`. If your tool doesn't load skills automatically, or they were installed after this session started, read the matching `SKILL.md` (for example `.agents/skills/<name>/SKILL.md`) before you start that kind of task. | ||||||
| LiveKit's agent skills cover each stage of the work: reading the docs, building, debugging, testing, writing scenarios, running simulations, and operating in production. Use them. | ||||||
|
|
||||||
| Before you start a task, check that they're installed: look for `.agents/skills/` or `.claude/skills/` in this project, or in the developer's home directory for a global install. If they're missing, ask the developer for permission, then install them with `lk skills install --yes`. This also adds the LiveKit Docs MCP server. If you can't run commands, or the CLI has no `skills` command (it was added in v2.19.0), ask the developer to update the CLI and run `lk skills install`. If your tool doesn't load skills automatically, or they were installed during this session, read the matching `.agents/skills/<name>/SKILL.md` before you start that kind of task. | ||||||
|
|
||||||
| ## Handoffs and tasks ("workflows") | ||||||
|
|
||||||
| Voice AI agents are highly sensitive to latency. Design complex agents in a structured way that keeps irrelevant context and unneeded tools out of each LLM request. LiveKit Agents supports handoffs, where one agent hands control to another, and tasks, which are tightly scoped prompts that achieve a specific outcome, for building reliable workflows. Use them instead of long instruction prompts that cover several phases of a conversation. See the [workflows documentation](https://docs.livekit.io/agents/logic/workflows/) for more information. | ||||||
|
|
||||||
| ## Testing | ||||||
|
|
||||||
| To keep agent behavior from regressing, add a scenario to `scenarios.yaml` and run it with `lk agent simulate text --scenarios scenarios.yaml`. Make sure the scenarios run in CI on every merge to `main`. Read the [simulations documentation](https://docs.livekit.io/testing/simulations/) before editing them. | ||||||
| To keep agent behavior from regressing, add a scenario to `scenarios.yaml` and run it with `lk agent simulate text --scenarios scenarios.yaml --yes`. The `--yes` flag adds ids to new scenarios, which the CLI otherwise asks about, or refuses to do without a terminal. When you change what the agent is for, update or replace the starter scenarios that no longer describe it, since they still expect the general-purpose assistant. Make sure the scenarios run in CI on every merge to `main`. Read the [simulations documentation](https://docs.livekit.io/testing/simulations/) before editing them. | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The CLI's own error already says this ("re-run with --yes to have them added to the file", simulate_scenario_ids.go#L47). Keep the flag and drop the explanation?
Suggested change
|
||||||
|
|
||||||
| Important: when you modify core agent behavior such as instructions, tool descriptions, or tasks, workflows, and handoffs, never guess at what works. Start by writing a scenario for the desired behavior. For example, if you're adding a tool, write a scenario that exercises it, then iterate on the tool until the scenario passes. This is how you produce a working, reliable agent. | ||||||
|
|
||||||
| After changing the agent, try it with the [agent debugger](https://docs.livekit.io/testing/debugger/) (CLI 2.18.8 or later) before calling the change done. Start the agent with `lk agent debugger start`, send user turns with `lk agent debugger say "..."`, and read the tool calls in each turn as well as the reply. Run `lk agent debugger restart` after every code edit, since a running session keeps the old code, and `lk agent debugger stop` when you're done. | ||||||
| After changing the agent, try it with the [agent debugger](https://docs.livekit.io/testing/debugger/) (CLI 2.19.0 or later) before calling the change done. Start the agent with `lk agent debugger start`, send user turns with `lk agent debugger say "..."`, and read the tool calls in each turn as well as the reply. A passing simulation only covers the inputs its scenarios use, so also try other inputs in the debugger, where each tool call's arguments and result show problems the reply hides. Run `lk agent debugger restart` after every code edit, since a running session keeps the old code, and `lk agent debugger stop` when you're done. | ||||||
|
|
||||||
| ## Debugging | ||||||
|
|
||||||
|
|
||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
--yesdoesn't do anything here. A coding agent's stdin isn't a terminal, andSkipPromptsalready treats that as yes. The only prompt it would skip is the one before replacing LiveKit skills that lk didn't install (skills.go#L320-L327), and a project with no skills has none.Also, the first sentence checks
.claude/skills/too, but the last one only points at.agents/skills/. A Claude-only install lands in.claude/skills.