chore(cli): tidy CLI docstrings and drop "agent-ready" jargon - #4868
Closed
markbackman wants to merge 2 commits into
Closed
chore(cli): tidy CLI docstrings and drop "agent-ready" jargon#4868markbackman wants to merge 2 commits into
markbackman wants to merge 2 commits into
Conversation
- `cli/__init__.py`: list the actual command surface — `init` (entry
point), `create`, and `eval`
- Replace the "agent-ready" terminology across the CLI with plain language
("initialize a project" / "set up for coding agents"), matching the docs.
Rename the internal `_print_agent_ready` helper to `_print_ready` and
change its message to "Your project is ready."
Codecov Report✅ All modified and coverable lines are covered by tests.
... and 1 file with indirect coverage changes 🚀 New features to boost your workflow:
|
Trim the orientation paragraph to what the human reader needs — this file is yours; AGENTS.md/CLAUDE.md are the agent's guide, picked up automatically. Drop the breakdown of what AGENTS.md teaches the agent.
Contributor
Author
|
Superseded by #4883, which folds these CLI-cleanup commits together with making |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Small CLI cleanup, no behavior change:
cli/__init__.pynow lists the actual command surface —pipecat init(the entry point),pipecat create, andpipecat eval. Previously it only mentionedcreateandinitand omittedeval.inithelp text and the post-init message, which now reads "Your project is ready." The internal_print_agent_readyhelper is renamed to_print_ready.Testing
uv run pytest tests/cli/— 309 passeduv run ruff check/ruff format --check— clean🤖 Generated with Claude Code