generators

Project generation modules for Pipecat CLI.

class pipecat.cli.generators.ProjectGenerator(config: ProjectConfig)

Bases: object

Generates a complete Pipecat project from configuration.

__init__(config: ProjectConfig)

Initialize the project generator.

Parameters:

config – Project configuration from user prompts

generate(output_dir: Path | None = None, non_interactive: bool = False, in_place: bool = False) → Path

Generate the complete project structure.

Parameters:

• output_dir – Optional directory to create project in (defaults to current dir). When in_place is True this is the exact destination; otherwise the project is created in a <output_dir>/<project_name> subfolder.

• non_interactive – If True, raise FileExistsError instead of prompting

• in_place – If True, scaffold directly into output_dir (or the current directory) without nesting under a <project_name> subfolder.

Returns:

Path to the created project directory

Raises:

FileExistsError – If a project already exists at the destination and non_interactive is True

print_next_steps(project_path: Path, in_place: bool = False) → None

Print next steps for the user.

Parameters:

• project_path – The directory the project was created in.

• in_place – If True, the project was scaffolded into the current directory, so the “cd into your project” step is omitted.

Submodules

• project
  • ProjectGenerator
    • ProjectGenerator.__init__()
    • ProjectGenerator.generate()
    • ProjectGenerator.print_next_steps()