Skip to content

feat(cli): make pipecat create internal - #4867

Closed
markbackman wants to merge 2 commits into
mainfrom
mb/create-internal
Closed

feat(cli): make pipecat create internal#4867
markbackman wants to merge 2 commits into
mainfrom
mb/create-internal

Conversation

@markbackman

@markbackman markbackman commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

My Summary

  • Hides the create command from the pipecat --help menu.
  • Continues to instruct the AGENTS.md how to use create, which is still available as an "internal" command
  • Other related cleanup

Claude's Summary

Makes pipecat init the single advertised entry point for starting a Pipecat project by hiding pipecat create from pipecat --help. create stays fully functional — it's the scaffolder that coding agents and automation call non-interactively (per the bundled AGENTS.md) and that init itself 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 (init and create); now there's one.

Changes

  • cli/main.py — register create with hidden=True. The command and its --help / --list-options still work; it's only omitted from the top-level help listing.
  • agent_templates/AGENTS.md — add a note in §1 that create is intentionally absent from pipecat --help but fully functional, so a coding agent that cross-checks --help isn'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 — present init (and eval) as the commands; stop pointing humans at create.
  • tests/cli/test_create_hidden.py — assert create is absent from pipecat --help yet pipecat create --help still resolves.

Non-breaking

pipecat create, pipecat create quickstart, pipecat create --help, and pipecat create --list-options all run exactly as before. Nothing that invokes create (agents via AGENTS.md, automation, init's in-process scaffold path) is affected.

Testing

  • uv run pytest tests/cli/ — 311 passed
  • uv run ruff check / ruff format --check — clean
  • Verified live: pipecat --help lists only init/eval; pipecat create --help exits 0

Related

Docs for this change fold into the open docs PR (pipecat-ai/docs#941).

🤖 Generated with Claude Code

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

codecov Bot commented Jun 23, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

Files with missing lines Coverage Δ
src/pipecat/cli/main.py 74.13% <100.00%> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@markbackman
markbackman requested a review from aconchillo June 23, 2026 21:58
@markbackman

Copy link
Copy Markdown
Contributor Author

I don't think we want to do this...

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.

1 participant