feat(cli): make pipecat create internal - #4867
Closed
markbackman wants to merge 2 commits into
Closed
Conversation
Hide `pipecat create` from `pipecat --help` so `pipecat init` is the single advertised entry point for starting a project. `create` stays fully functional — it's the scaffolder that coding agents and automation call non-interactively (per the bundled AGENTS.md) and that `init` wraps — it's just no longer surfaced as a human on-ramp. - main.py: register `create` with `hidden=True` - agent_templates/AGENTS.md: note that `create` is intentionally absent from `--help` but fully functional; drop the human-facing aside - agent_templates/GETTING_STARTED.md, cli/__init__.py: reflect `init` as the entry point; stop presenting `create` to humans - tests: assert `create` is hidden from `--help` yet still invocable
Codecov Report✅ All modified and coverable lines are covered by tests.
🚀 New features to boost your workflow:
|
Contributor
Author
|
I don't think we want to do this... |
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
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.
My Summary
createcommand from thepipecat --helpmenu.create, which is still available as an "internal" commandClaude's Summary
Makes
pipecat initthe single advertised entry point for starting a Pipecat project by hidingpipecat createfrompipecat --help.createstays fully functional — it's the scaffolder that coding agents and automation call non-interactively (per the bundledAGENTS.md) and thatinititself wraps. It's just no longer surfaced as a competing human on-ramp.This completes the init-as-starting-point work: previously the CLI presented two confusing on-ramps (
initandcreate); now there's one.Changes
cli/main.py— registercreatewithhidden=True. The command and its--help/--list-optionsstill work; it's only omitted from the top-level help listing.agent_templates/AGENTS.md— add a note in §1 thatcreateis intentionally absent frompipecat --helpbut fully functional, so a coding agent that cross-checks--helpisn't thrown by the omission. The headless scaffolding instructions are otherwise unchanged. Removed the human-facing aside.agent_templates/GETTING_STARTED.md,cli/__init__.py— presentinit(andeval) as the commands; stop pointing humans atcreate.tests/cli/test_create_hidden.py— assertcreateis absent frompipecat --helpyetpipecat create --helpstill resolves.Non-breaking
pipecat create,pipecat create quickstart,pipecat create --help, andpipecat create --list-optionsall run exactly as before. Nothing that invokescreate(agents via AGENTS.md, automation,init's in-process scaffold path) is affected.Testing
uv run pytest tests/cli/— 311 passeduv run ruff check/ruff format --check— cleanpipecat --helplists onlyinit/eval;pipecat create --helpexits 0Related
Docs for this change fold into the open docs PR (pipecat-ai/docs#941).
🤖 Generated with Claude Code