docs: the Context Hub ships with the Pipecat CLI - #1055
Open
markbackman wants to merge 1 commit into
Open
Conversation
Contributor
|
🔍 Mintlify preview for this branch: https://daily-docs-context-hub-ships-with-cli.mintlify.site |
`uv tool install "pipecat-ai[cli]"` provides `pipecat context-hub`, so setup is the CLI install. The pages that taught a `--with` co-install, and the section comparing the two installs, describe a choice that no longer exists. `pipecat init` now performs the setup on its coding-agent path — registering the MCP server and offering to build the index — which no page covered. `install`'s exit codes are documented alongside it, since `3` is how a caller tells "printed the config to paste" from "configured a client". First-build cost is stated as a floor, upwards of three minutes and about 900 MB of disk: it varies with single-core speed, and a first run on a cold machine also downloads the embedding models. Refresh is given separately, since it re-ingests only the sources that moved.
markbackman
force-pushed
the
docs/context-hub-ships-with-cli
branch
from
August 4, 2026 02:46
eb893c1 to
16dfb2e
Compare
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.
The Context Hub now ships inside
pipecat-ai[cli], souv tool install "pipecat-ai[cli]"is the whole install. These pages still taught a--withco-install, weighed two install paths against each other, and warned that--withreplaces the tool environment — a choice that no longer exists.Depends on pipecat-ai/pipecat#5122; land after that releases.
What changed
api-reference/context-hub.mdx--withwarning and the whole "Which install to choose" section; kept theuvxpath for using the hub without the CLIapi-reference/cli/context-hub.mdx## Installationdown to a line. Addedinstall's exit codes and that re-running converges rather than skippingapi-reference/cli/overview.mdxcontext-hubmoves from "(requirespipecat-ai-context-hub)" to "(built in)"; the--withexample reverts topipecatcloudonlyapi-reference/cli/init.mdx--context-hub/--no-context-hubflagpipecat/get-started/build-your-next-bot.mdxinitdoes it for youpipecat/get-started/quickstart.mdxquickstartdoesn't stop to askTwo additions beyond the rename
pipecat initperforms the setup, and no page said so. It registers the MCP server with the coding agent CLIs it finds and offers to build the index. That is the largest user-visible change in the release, soinit.mdxgains a section and the getting-started pages stop instructing people to do it by hand.install's exit codes are documented, including3. It is the only way a caller distinguishes "configured a client" from "printed the config for you to paste" — both print, and neither is an error. Cursor, VS Code, and Zed always take the second path.Corrected figures
The old text said "~2 min first run" in one place and "allow several minutes" in another, and no page mentioned the disk cost.
Measured cold: 17,359 records, 922 MB, in 2m46s and 3m48s across two runs on the same machine — both with a warm model cache, so a genuine first run also pays a ~186 MB model download. A later refresh with one source changed took 77s.
So the first build is stated as a floor — upwards of three minutes and about 900 MB of disk — rather than a target. The total is dominated by embedding ~17k records on the CPU, so it tracks single-core speed; a point estimate would be wrong for most readers. This matches the
3+ minutesthe CLI prompt shows. Refresh is documented separately at one to two minutes, since it re-ingests only sources whose contents moved.Also corrected
context-hub.mdxclaimed a standalone install plus the CLI's copy costs "a second copy on disk — the two environments share very little." They share the index, which is the ~900 MB part; only the package duplicates.Checks
mintisn't installed locally, so internal links were verified by hand — every target exists. Worth amint broken-linksrun before merge.