docs: CLI ships with pipecat-ai; rename init→create + document agent-ready init#869
Open
markbackman wants to merge 5 commits into
Open
docs: CLI ships with pipecat-ai; rename init→create + document agent-ready init#869markbackman wants to merge 5 commits into
markbackman wants to merge 5 commits into
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Contributor
|
❌ Broken links detected! Please check the workflow logs for details on which links are broken and fix them before merging. |
The pipecat init CLI now ships with pipecat-ai as the optional [cli] extra, and pipecatcloud / pipecat-ai-tail are co-installed plugins. - Swap install commands to \`uv tool install "pipecat-ai[cli]"\` across the quickstarts, build-your-next-bot, and the Gemini Live quickstart. - Reframe the CLI overview: init is built in; cloud/tail co-install via \`--with pipecatcloud\` / \`--with pipecat-ai-tail\`. - Fix the Tail page install + observer wiring (pipecat-ai-tail / \`from pipecat_tail.observer import TailObserver\`). - Pipecat Cloud: fix the CI install examples (PATs guide) and add an "Install the CLI" step to the introduction. The deploy GitHub Action is API-key based and untouched. Hold until pipecat-ai 1.4.0 ships with the CLI.
PR #4710 (pipecat-ai 1.4.0) renames the scaffolder `pipecat init` -> `pipecat create` and repurposes `pipecat init` to make a project agent-ready (writes AGENTS.md/CLAUDE.md/GETTING_STARTED.md). Align the docs with that CLI: - New api-reference/cli/create.mdx carries the scaffolder reference (the former init.mdx content); init.mdx is rewritten for the new agent-ready command. docs.json nav adds create. - CLI overview lists both commands and points scaffold links at create. - Build Your Next Bot leads with the recommended agent flow (`pipecat init` -> coding session -> agent scaffolds via `pipecat create`), keeping the direct `pipecat create` path. - Sweep scaffolder invocations to `create` in quickstart, examples, gemini-live, cloud-builds, and the client quickstart. Builds on 04d011d (the pipecat-ai[cli] package move). Hold until 1.4.0.
markbackman
force-pushed
the
mb/pipecat-ai-cli-port
branch
from
61504cb to
470709f
Compare
Contributor
|
❌ Broken links detected! Please check the workflow logs for details on which links are broken and fix them before merging. |
…E.md The AI-Assisted Development page covered the Context Hub but never mentioned `pipecat init`. Add a lead section: run `pipecat init` to make a project agent-ready (writes AGENTS.md/CLAUDE.md/GETTING_STARTED.md), pairing with the Context Hub for live context, and link Build Your Next Bot. Clarify that the existing CLAUDE.md section is the framework repo's own file, distinct from the one init writes into your project.
main removed the `pipecat tail` subcommand (page + nav); the rebase replayed this branch's overview edits, which still referenced it. Remove the Monitor card, the tail co-install, command entry, and --help line so the overview matches the shipped CLI and has no dead links.
markbackman
force-pushed
the
mb/pipecat-ai-cli-port
branch
from
04c4bf2 to
b42ea16
Compare
markbackman
changed the title
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.
Aligns the docs with the CLI changes shipping in pipecat-ai 1.4.0 (pipecat-ai/pipecat#4710): the CLI now ships with
pipecat-aias the optional[cli]extra, the scaffolder is renamedinit→create, andpipecat initis repurposed to make a project agent-ready.Packaging
uv tool install "pipecat-ai[cli]"across the quickstarts, build-your-next-bot, and Gemini Live.cloudco-installs as a plugin via--with pipecatcloud.CLI rename:
init→create, plus the newinitapi-reference/cli/create.mdx— the scaffolder reference (formerinit.mdxcontent), now with--evalandpipecat create quickstart.api-reference/cli/init.mdxrewritten for the new agent-ready command: writesAGENTS.md/CLAUDE.md/GETTING_STARTED.md, takes[TARGET_DIR]+--force, never clobbers an existingCLAUDE.md, stamps a provenance footer, and redirects tocreateif scaffolder flags are passed.docs.jsonnav: addcreate.cli/overview.mdx: list both commands; point the scaffold card/links atcreate.create: quickstart, examples overview, Gemini Live, cloud-builds, client quickstart.Discoverability / agent flow
build-your-next-bot.mdx: leads with the recommended agent flow (pipecat init→ open a coding session → the agent scaffolds viapipecat create), keeping the directpipecat createpath below.ai-tools.mdx: new "Make your project agent-ready (pipecat init)" lead section that pairs with the Context Hub; intro now covers agent setup, not just context; the existing CLAUDE.md section is clarified as the framework repo's file (distinct from the oneinitwrites into your project).Tail removal
pipecat tailsubcommand docs: deleteapi-reference/cli/tail.mdx, drop it from the nav and the CLI overview. (The standalone Tail tool keeps its own repo; only the CLI subcommand docs are removed.)