cli

Pipecat CLI - command-line tools for building Pipecat AI voice agents.

This package provides command-line tools for: - Initializing a new Pipecat project with pipecat init (the entry point: writes the

coding-agent guide, then helps you build with a coding agent or scaffolds a runnable bot — interactively or non-interactively from flags or a config file)

• Running behavioral evals against a bot with pipecat eval

And allows installing extensions like Pipecat Cloud: - Deploying to Pipecat Cloud with pipecat cloud

Subpackages

• commands
  • Submodules
    • eval
      • run()
      • suite()
    • init
      • init_command()
• generators
  • ProjectGenerator
    • ProjectGenerator.__init__()
    • ProjectGenerator.generate()
    • ProjectGenerator.print_next_steps()
  • Submodules
    • project
      • ProjectGenerator
• prompts
  • ProjectConfig
    • ProjectConfig.project_name
    • ProjectConfig.bot_type
    • ProjectConfig.transports
    • ProjectConfig.mode
    • ProjectConfig.stt_service
    • ProjectConfig.llm_service
    • ProjectConfig.tts_service
    • ProjectConfig.realtime_service
    • ProjectConfig.video_service
    • ProjectConfig.generate_client
    • ProjectConfig.client_framework
    • ProjectConfig.client_server
    • ProjectConfig.daily_pstn_mode
    • ProjectConfig.twilio_daily_sip_mode
    • ProjectConfig.video_input
    • ProjectConfig.video_output
    • ProjectConfig.recording
    • ProjectConfig.transcription
    • ProjectConfig.deploy_to_cloud
    • ProjectConfig.enable_krisp
    • ProjectConfig.enable_observability
    • ProjectConfig.enable_eval
  • ask_project_questions()
  • Submodules
    • questions
      • replace_question_with_answer()
      • ProjectConfig
      • ask_project_questions()
• registry
  • ServiceRegistry
    • ServiceRegistry.SERVICE_CONFIGS
    • ServiceRegistry.IMPORTS
    • ServiceRegistry.FEATURE_IMPORTS
    • ServiceRegistry.BASE_IMPORTS
    • ServiceRegistry.FEATURE_DEFINITIONS
    • ServiceRegistry.WEBRTC_TRANSPORTS
    • ServiceRegistry.TELEPHONY_TRANSPORTS
    • ServiceRegistry.STT_SERVICES
    • ServiceRegistry.LLM_SERVICES
    • ServiceRegistry.TTS_SERVICES
    • ServiceRegistry.REALTIME_SERVICES
    • ServiceRegistry.VIDEO_SERVICES
  • ServiceLoader
    • ServiceLoader.get_service_by_value()
    • ServiceLoader.get_all_services_by_type()
    • ServiceLoader.get_service_config()
    • ServiceLoader.get_service_import()
    • ServiceLoader.extract_extras_for_services()
    • ServiceLoader.validate_service_exists()
    • ServiceLoader.get_transport_options()
    • ServiceLoader.get_imports_for_services()
    • ServiceLoader.get_missing_services()
  • ServiceDefinition
    • ServiceDefinition.value
    • ServiceDefinition.label
    • ServiceDefinition.package
    • ServiceDefinition.class_name
    • ServiceDefinition.env_prefix
    • ServiceDefinition.include_params
    • ServiceDefinition.settings_params
    • ServiceDefinition.manual_config
    • ServiceDefinition.recommended
    • ServiceDefinition.additional_imports
    • ServiceDefinition.param_defaults
  • extract_package_extra()
  • Submodules
    • service_loader
      • extract_package_extra()
      • ServiceLoader
    • service_metadata
      • ServiceDefinition
      • ServiceRegistry

Submodules

• config_validator
  • ConfigValidationError
    • ConfigValidationError.__init__()
  • validate_and_build_config()
  • load_config_from_file()
  • config_to_json()
• main
  • run()
• scaffold
  • list_options_callback()
  • scaffold_interactive()
  • resolve_scaffold_config()
  • generate_scaffold()
  • scaffold_quickstart()