Skip to content

Use lk agent for console, dev, and start - #65

Merged
bcherry merged 10 commits into
mainfrom
bcherry/stoic-meitner-0makbf
Sep 25, 2026
Merged

bcherry merged 10 commits into
mainfrom
bcherry/stoic-meitner-0makbf

Conversation

@bcherry

@bcherry bcherry commented Sep 18, 2026 •

Copy link
Copy Markdown
Contributor

What

Points the starter's local run instructions at the LiveKit CLI, and trims the README and AGENTS.md:

  • README
    • CLI install moves to the top of Dev setup as a three-line list, with a link to the update instructions. The floor is now 2.18.8, the first version with lk agent debugger.
    • "Run the agent" shows lk agent console, lk agent dev, and lk agent debugger, then the direct node src/main.ts start for production. That's what the Dockerfile runs via pnpm start.
    • The feature list says what each piece does for you and links the docs for how. That covers 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" shows lk docs search followed by lk docs get-page, since search only returns excerpts, and points to the bundled AGENTS.md and LiveKit Agents skill.
    • "Testing and debugging" points to the debugger for turn-by-turn checks, and adds Agent Console and lk agent logs.
    • Manual setup includes the git clone it was missing, and uses --write --destination rather than short flags.
  • package.json — the dev script runs lk agent dev. start is unchanged.
  • taskfile.yaml — the post-init hint prints lk agent dev.
  • AGENTS.md
    • Drops guidance a coding agent can work out on its own: the project-layout paragraph, the run-command walkthrough, the lk docs command list, and the MCP transport details.
    • Adds a section on the bundled skill, with a fallback path for tools that don't load skills on their own.
    • Makes scenarios the tests and lk agent debugger the loop for checking each change, instead of the unit testing framework. The debugging checklist starts from reproducing the problem in the debugger, and points to Agent Console for speech issues the text-only debugger can't show.
    • Widens the feedback prompt from docs gaps to any LiveKit problem, keeping the to-do-list timing.
  • Copy pass against the docs style guide: sentence-case headings, no "we", no hyphens standing in for dashes, bulleted rather than numbered lists where order doesn't matter, and less filler. Links to the testing, observability, and workflows pages point at their current paths.

Why

lk agent console and lk agent dev are the documented way to run an agent locally, and the Python starter already moved to them (livekit-examples/agent-starter-python#103). The CLI install instructions were buried in "Using coding agents", below the first commands that need them. lk agent debugger gives a coding agent a cheap way to check its own changes, so the starter should tell it to.

Notes for reviewers

  • "Cost-effective" is based on LiveKit Inference pricing: Fish Audio S2.1 Pro is $15 per 1M characters, the lowest paid TTS tier, against $50 for Cartesia and $150–300 for ElevenLabs.
  • AGENTS.md now matches the Python starter's after the review round there (Trim the README and AGENTS.md, and cover skills and debugging agent-starter-python#105), apart from tooling and the Node.js feature-parity note. The "LiveKit documentation" block is likely mirrored in other starters, which will now differ.
  • src/agent.test.ts is still in the repo; only the docs stopped pointing to it.
  • Every docs.livekit.io link in both files returns 200 without a redirect. prettier --check is clean.

🤖 Generated with Claude Code

https://claude.ai/code/session_01U7yszNU7t5aCHJsKLmU4hv

Match the Python starter: the README now documents `lk agent console`,
`lk agent dev`, and `lk agent start` for local runs, the `dev` script and the
taskfile hint run through the CLI, and the CLI install instructions moved into
Dev Setup so they come before the first command that needs them.

The `start` script stays a direct `node src/main.ts start`, because the
Dockerfile runs `pnpm start` and the container image doesn't include `lk`.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01U7yszNU7t5aCHJsKLmU4hv
Comment thread README.md Outdated
@bcherry
bcherry requested a review from u9g September 18, 2026 20:31
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01U7yszNU7t5aCHJsKLmU4hv
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Review feedback: drop guidance a coding agent can work out on its own
(project layout, where to run commands, the dev/start scripts), show the
direct `node src/main.ts start` for production since that's what the
Dockerfile runs, and use long flag names in human-facing commands.

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. Collapses the CLI install
block into a three-line list and links the update instructions.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01U7yszNU7t5aCHJsKLmU4hv
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
@bcherry
bcherry requested a review from u9g September 23, 2026 20:29
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
`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
- 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
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
Keeps the rewritten Testing paragraph and carries over #67's
`lk agent simulate text` fix.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01U7yszNU7t5aCHJsKLmU4hv
@bcherry
bcherry merged commit a26eedb into main Sep 25, 2026
5 checks passed
@bcherry
bcherry deleted the bcherry/stoic-meitner-0makbf branch September 25, 2026 16:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants