Skip to content

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

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

Supersedes #100, which made the same move for dev only. (That PR is from a fork this session can't push to, so the work landed here instead. Happy to close this in its favor if @omarelsaid wants to extend theirs.)

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.
  • taskfile.yaml — both post-init help hints and the dev task.
  • AGENTS.md — tells coding agents to run the agent through the CLI, and that the CLI's entrypoint detection expects src/agent.py.

Why

Running the documented command emits two deprecation notices:

dev mode is deprecated and will be removed in a future release; use lk agent dev instead
in-process auto-reload has been removed from the Python CLI; use lk agent dev for hot-reload

The second matters most: hot reload is gone from the Python CLI entirely, so lk agent dev isn't a rename — it's the only way to get reloading. #100 covered dev; console and start are the documented commands too, and leaving them on uv run means the three modes in one README section are invoked three different ways.

Separately, the CLI install instructions were buried in the "Using coding agents" section, below the first commands that need them — including lk agent init, which the very next section recommends. They now lead Dev Setup, and the coding-agents section links down to them instead of repeating the platform commands.

Notes for reviewers

  • The Dockerfile still starts the deployed agent with uv run src/agent.py start. The container image doesn't include lk, and the README now says so.
  • uv keeps its role for dependencies (uv sync), linting, and tests. Only agent execution moved.
  • The connect mode has no CLI equivalent, so nothing here touches it.
  • Verified: taskfile.yaml still parses, no agent.py console|dev|start invocation remains outside the Dockerfile. task dev itself wasn't executed end to end — lk can't be installed in this environment.
  • Counterparts: Use lk agent for console, dev, and start agent-starter-node#65 for the Node starter, plus a livekit/web docs change adding a CLI pointer to the pages that use these commands.

🤖 Generated with Claude Code

https://claude.ai/code/session_01U7yszNU7t5aCHJsKLmU4hv

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
@bcherry bcherry changed the title Update agent CLI commands and documentation Use lk agent for console, dev, and start Sep 18, 2026
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01U7yszNU7t5aCHJsKLmU4hv
@omarelsaid

Copy link
Copy Markdown

Closed #100 in favour of this. Thanks!

@bcherry
bcherry requested review from ShayneP and u9g September 18, 2026 20:43
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