Repository navigation
Commit 3a644eb
Trim the README and AGENTS.md, and cover skills and debugging (#105)
* Use `lk agent` for console, dev, and start
The Python CLI's dev mode is deprecated and its in-process auto-reload has
been removed, so `lk agent dev` is now the only way to get hot reload. Point
the README, the taskfile help output, and the `dev` task at the LiveKit CLI
for all three local modes, and move the CLI install instructions into Dev
Setup so they come before the first command that needs them.
The Dockerfile still starts the deployed agent with `uv run src/agent.py
start`, since the container image doesn't include `lk`.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01U7yszNU7t5aCHJsKLmU4hv
* Describe what dev mode adds, not just reload
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01U7yszNU7t5aCHJsKLmU4hv
* Trim the README and AGENTS.md, and apply the docs style guide
Mirrors the Node starter's review round: drop guidance a coding agent can
work out on its own, show the direct `uv run src/agent.py start` for
production since that's what the Dockerfile runs, and collapse the CLI
install block into a three-line list with a link to update instructions.
Also a copy pass against the docs style guide: sentence-case headings,
no "we", no hyphens standing in for dashes, bulleted rather than numbered
non-sequential lists, and less filler throughout.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01U7yszNU7t5aCHJsKLmU4hv
* Sell outcomes in the feature list, and cover skills and debugging
The README feature list now says what each piece does for you and links
the docs for how: Fish Audio as an expressive, cost-effective default,
expressive mode, and adaptive interruption handling, which the starter
enables but the list never mentioned. "Using coding agents" points at the
bundled AGENTS.md and livekit-agents skill, and the testing section adds
Agent Console and `lk agent logs` for debugging.
AGENTS.md gains a section on the bundled skill (with a fallback path for
tools that do not load skills on their own) and a debugging checklist.
Links to the moved testing, observability, and workflows pages now point
at their current paths.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01U7yszNU7t5aCHJsKLmU4hv
* Restore the get-page example alongside search
Search returns short excerpts, so reading a result means fetching the
full page. Show both commands in the README, and tell coding agents in
AGENTS.md to fetch the page before acting on a search result.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01U7yszNU7t5aCHJsKLmU4hv
* Add the agent debugger to the README and AGENTS.md
`lk agent debugger` shipped in CLI 2.18.8: it runs the agent in text mode
and lets a coding agent or script drive one turn at a time, printing the
tool calls and handoffs behind each reply.
README lists it under "Run the agent" and raises the CLI floor to 2.18.8.
AGENTS.md adapts the snippet from the coding agents guide so the agent
tries every change with the debugger, and the debugging checklist now
starts from reproducing the problem there. Agent Console stays the answer
for speech issues the text-only debugger cannot show.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01U7yszNU7t5aCHJsKLmU4hv
* Update AGENTS.md
Co-authored-by: u9g <jason.lernerman@livekit.io>
* Update AGENTS.md
Co-authored-by: u9g <jason.lernerman@livekit.io>
* Update AGENTS.md
Co-authored-by: u9g <jason.lernerman@livekit.io>
* Apply Jason's AGENTS.md review round, and point testing at the debugger
- Say the starter, not the SDK, is designed to run in LiveKit Cloud.
- Drop the lk docs intro, the command list, and the MCP transport
details; running lk docs shows the help.
- Widen docs feedback to any LiveKit problem, keeping the to-do-list
timing that has worked well.
- Stop advertising the unit testing framework. Scenarios are the tests,
and the debugger is the loop for checking each change; the README
testing section points there too.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01U7yszNU7t5aCHJsKLmU4hv
* Describe the seven bundled agent skills, not livekit-agents
The skills PR replaces the single livekit-agents skill with seven
focused ones, so the fallback path to its SKILL.md would no longer exist.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01U7yszNU7t5aCHJsKLmU4hv
---------
Co-authored-by: Claude <noreply@anthropic.com>
Co-authored-by: u9g <jason.lernerman@livekit.io>1 parent ec22151 commit 3a644eb
2 files changed
Lines changed: 93 additions & 107 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | | - | |
| 3 | + | |
4 | 4 | | |
5 | | - | |
| 5 | + | |
6 | 6 | | |
7 | | - | |
| 7 | + | |
8 | 8 | | |
9 | | - | |
| 9 | + | |
10 | 10 | | |
11 | | - | |
| 11 | + | |
12 | 12 | | |
13 | | - | |
14 | | - | |
15 | | - | |
16 | | - | |
17 | | - | |
| 13 | + | |
18 | 14 | | |
19 | 15 | | |
20 | 16 | | |
21 | | - | |
22 | | - | |
23 | 17 | | |
24 | 18 | | |
25 | 19 | | |
26 | 20 | | |
27 | 21 | | |
28 | 22 | | |
29 | | - | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
30 | 26 | | |
31 | | - | |
| 27 | + | |
32 | 28 | | |
33 | | - | |
| 29 | + | |
34 | 30 | | |
35 | | - | |
| 31 | + | |
36 | 32 | | |
37 | | - | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
38 | 36 | | |
39 | 37 | | |
40 | 38 | | |
41 | | - | |
| 39 | + | |
42 | 40 | | |
43 | 41 | | |
44 | 42 | | |
45 | | - | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
46 | 50 | | |
47 | | - | |
| 51 | + | |
48 | 52 | | |
49 | | - | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
50 | 59 | | |
51 | | - | |
| 60 | + | |
52 | 61 | | |
53 | | - | |
| 62 | + | |
0 commit comments