Skip to content

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

Open
bcherry wants to merge 2 commits into
mainfrom
bcherry/stoic-meitner-0makbf
Open

bcherry wants to merge 2 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:

  • README.mdlk agent console, lk agent dev, and lk agent start under "Run the agent", plus a new "Install the LiveKit CLI" step at the top of Dev Setup.
  • package.json — the dev script now runs lk agent dev.
  • taskfile.yaml — the hint printed after lk agent init.
  • AGENTS.md — tells coding agents to run the agent through the CLI, and that the CLI's entrypoint detection expects src/main.ts.

Why

lk agent console|dev|start is the documented way to run an agent locally, and it's the only way to get hot reload now that in-process auto-reload is gone from the Python CLI. The Node starter should match the Python one so the two templates don't drift.

The CLI install instructions were buried in the "Using coding agents" section, below the first commands that need them. They now lead Dev Setup, where a new user hits them before running anything; the coding-agents section links down to them instead of repeating the platform commands.

Notes for reviewers

  • The start script stays node src/main.ts start on purpose. The Dockerfile runs pnpm start, and the container image doesn't include lk.
  • pnpm run dev still works — it just shells out to the CLI now, which matches what Server startup modes recommends for package.json.
  • Verified: prettier --check clean on the changed files, package.json and taskfile.yaml still parse. pnpm install doesn't run in this environment (Node 22 vs. the engines floor of 24), so the scripts themselves weren't executed end to end.
  • Docs counterpart: livekit/web gains a CLI pointer on the pages that use these commands. The Python starter gets the same treatment.

🤖 Generated with Claude Code

https://claude.ai/code/session_01U7yszNU7t5aCHJsKLmU4hv


Generated by Claude Code

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
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.

2 participants