Skip to content

docs: update for pipecat-cli PR #95#873

Open
markbackman wants to merge 1 commit into
mainfrom
docs/cli-pr-95
Open

docs: update for pipecat-cli PR #95#873
markbackman wants to merge 1 commit into
mainfrom
docs/cli-pr-95

Conversation

@markbackman
Copy link
Copy Markdown
Contributor

Automated documentation update for pipecat-cli PR #95.

Changes

api-reference/cli/init.mdx

  • Added TARGET argument documentation - New optional positional argument allows scaffolding into a specific directory (e.g., pc init . scaffolds into current directory without creating a subfolder)
  • Updated usage syntax - Changed from pipecat init [OPTIONS] to pipecat init [TARGET] [OPTIONS]
  • Updated --output parameter - Noted that it's mutually exclusive with TARGET
  • Added new examples - Demonstrated in-place scaffolding with pc init . and combined with non-interactive flags
  • Updated Interactive Setup section - Documented that project name defaults to directory basename when TARGET is provided
  • Updated Generated Project Structure - Added comparison showing the difference between standard (nested) and in-place scaffolding

Gaps identified

None. All relevant source changes have been documented:

  • src/pipecat_cli/commands/init.py → documented new TARGET argument and updated examples
  • src/pipecat_cli/generators/project.py → documented in-place project structure
  • src/pipecat_cli/prompts/questions.py → documented default name behavior
  • src/pipecat_cli/main.py → internal change (init command registration), no user-facing impact

Guides referencing pipecat init use only the basic interactive mode or quickstart command, which remain unchanged.

Updates api-reference/cli/init.mdx to document the new optional TARGET
argument added in pipecat-cli PR #95.

Changes:
- Added TARGET argument documentation
- Updated usage syntax to show [TARGET] [OPTIONS]
- Noted that --output and TARGET are mutually exclusive
- Added examples for in-place scaffolding (pc init .)
- Updated Interactive Setup section to mention default name derivation
- Added note about project structure differences in in-place mode

Relates to pipecat-ai/pipecat-cli#95
@markbackman markbackman added auto-docs Automated documentation update from pipecat source changes cli labels Jun 4, 2026
@mintlify
Copy link
Copy Markdown

mintlify Bot commented Jun 4, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
daily 🟢 Ready View Preview Jun 4, 2026, 10:27 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

auto-docs Automated documentation update from pipecat source changes cli

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant