/** * Help text for the connect studio command */ export declare const connectStudioHelp = "\nCommand Overview:\n The connect command starts the Connect Studio, a development environment for building\n and testing Powerhouse applications. It provides a visual interface for working with\n your project.\n\n This command:\n 1. Starts a local Connect Studio server\n 2. Provides a web interface for development\n 3. Allows you to interact with your project components\n 4. Supports various configuration options for customization\n\nOptions:\n --port Port to run the server on. Default is 3000.\n\n --host Expose the server to the network. By default, the server\n only accepts connections from localhost.\n\n --open Automatically open the browser window after starting the server.\n\n --cors Enable CORS (Cross-Origin Resource Sharing).\n\n --strictPort Exit if specified port is already in use.\n\n --force Force the optimizer to ignore the cache and re-bundle.\n\n --mode Vite mode to use (e.g., development, production).\n\n --config-file Path to the powerhouse.config.js file. This allows you to\n customize the behavior of Connect Studio.\n\n --vite-config-file Path to the vite config file.\n\n --project-root The root directory of the project. Default is current directory.\n\nExamples:\n $ ph connect # Start Connect Studio on default port 3000\n $ ph connect --port 8080 # Start on port 8080\n $ ph connect --host # Expose to network (not just localhost)\n $ ph connect --open # Open browser automatically\n $ ph connect --cors # Enable CORS\n $ ph connect --strictPort # Exit if port is in use\n $ ph connect --force # Force re-bundle\n $ ph connect --mode production # Use production mode\n $ ph connect --config-file custom.config.js # Use custom configuration\n $ ph connect --vite-config-file vite.config.js # Use custom vite config\n $ ph connect --project-root /path/to/project # Set project root\n $ ph connect --port 8080 --open # Start on port 8080 and open browser\n"; /** * Help text for the connect build command */ export declare const connectBuildHelp = "\nCommand Overview:\n The Connect build command creates a production build with the project's local and\n external packages included.\n\nOptions:\n --outDir Output directory. Defaults to 'dist'.\n\n --base Base path for the app. Default is \"/\".\n\n --mode Vite mode to use (e.g., development, production).\n\n --config-file Path to the powerhouse.config.js file.\n\n --vite-config-file Path to the vite config file.\n\n --project-root The root directory of the project. Default is current directory.\n\nExamples:\n $ ph connect build # Build with defaults\n $ ph connect build --outDir build # Output to 'build' directory\n $ ph connect build --base /app # Set base path to '/app'\n $ ph connect build --mode production # Use production mode\n $ ph connect build --config-file custom.config.js # Use custom configuration\n $ ph connect build --vite-config-file vite.config.js # Use custom vite config\n $ ph connect build --project-root /path/to/project # Set project root\n"; /** * Help text for the connect preview command */ export declare const connectPreviewHelp = "\nCommand Overview:\n The Connect preview command previews a built Connect project.\n NOTE: You must run `ph connect build` first.\n\nOptions:\n --outDir Output directory. Defaults to 'dist'.\n\n --port Port to run the server on. Default is 3000.\n\n --host Expose the server to the network.\n\n --open Open browser on startup.\n\n --strictPort Exit if specified port is already in use.\n\n --base Base path for the app. Default is \"/\".\n\n --mode Vite mode to use (e.g., development, production).\n\n --config-file Path to the powerhouse.config.js file.\n\n --vite-config-file Path to the vite config file.\n\n --project-root The root directory of the project. Default is current directory.\n\nExamples:\n $ ph connect preview # Preview with defaults\n $ ph connect preview --outDir build # Preview from 'build' directory\n $ ph connect preview --port 8080 # Preview on port 8080\n $ ph connect preview --host # Expose to network\n $ ph connect preview --open # Open browser automatically\n $ ph connect preview --strictPort # Exit if port is in use\n $ ph connect preview --base /app # Set base path to '/app'\n $ ph connect preview --mode production # Use production mode\n $ ph connect preview --config-file custom.config.js # Use custom configuration\n $ ph connect preview --vite-config-file vite.config.js # Use custom vite config\n $ ph connect preview --project-root /path/to/project # Set project root\n"; /** * Help text for the generate command */ export declare const generateHelp = "\nCommand Overview:\n The generate command creates code from document models. It helps you build editors, \n processors, and other components based on your document model files.\n\n This command:\n 1. Reads document model definitions\n 2. Generates code for specified components (editors, processors, etc.)\n 3. Supports customization of output and generation options\n 4. Can watch files for changes and regenerate code automatically\n\nArguments:\n [document-model-file] Optional. Path to the document model file to generate code from.\n If not provided, the command will look for document models in\n the default location.\n\nOptions:\n -i, --interactive Run the command in interactive mode, which will guide you\n through the generation process with prompts and options.\n \n --editors Path to the directory where editors should be generated or found.\n \n -e, --editor Name of the editor to generate or use.\n \n --file Specific file path to the document model.\n \n --processors Path to the directory where processors should be generated or found.\n \n -p, --processor Name of the processor to generate.\n \n --processor-type Type of processor to generate. 'relationalDb' or 'analytics'\n \n -s, --subgraph Name of the subgraph to use or create.\n \n --document-models Path to the document models directory.\n \n --document-types Document types supported by the editor, in the format\n 'namespace/type' (e.g., 'powerhouse/todo').\n \n -is, --import-script Name of the import script to generate.\n \n -sf, --skip-format Skip formatting the generated code.\n \n -w, --watch Watch for changes in the document model and regenerate code\n when changes are detected.\n \n -d, --drive-editor Generate a drive editor with the specified name.\n\n --migration-file Path to the migration file when running 'ph generate\n \n --schema-file Path to the output file. Defaults to 'schema.ts' at the same directory of the migration file.\n\nExamples:\n $ ph generate # Generate code using defaults\n $ ph generate my-document-model.zip # Generate from a specific model zip file\n $ ph generate -i # Run in interactive mode\n $ ph generate --editor ToDoList --document-types powerhouse/todo # Generate a ToDoList editor for todo documents\n $ ph generate -p MyProcessor --processor-type relationalDb # Generate a specific processor\n $ ph generate --watch # Generate and watch for changes\n $ ph generate --drive-editor custom-drive-explorer # Generate a custom drive editor\n $ ph generate -s MySubgraph # Generate with a specific subgraph\n $ ph generate --skip-format # Generate without formatting\n $ ph generate --migration-file ./migrations.ts # Generate types for an RelationalDB Processor\n"; /** * Help text for the install command */ export declare const installHelp = "\nCommand Overview:\n The install command adds Powerhouse dependencies to your project. It handles installation\n of packages, updates configuration files, and ensures proper setup of dependencies.\n\n This command:\n 1. Installs specified Powerhouse dependencies using your package manager\n 2. Updates powerhouse.config.json to include the new dependencies\n 3. Supports various installation options and configurations\n 4. Works with npm, yarn, pnpm, and bun package managers\n\nArguments:\n [dependencies...] Names of the dependencies to install. You can provide multiple\n dependency names separated by spaces.\n\nOptions:\n -g, --global Install the dependencies globally rather than in the current project.\n \n --debug Show additional logs during the installation process for troubleshooting.\n \n -w, --workspace Install the dependencies in the workspace (use this option for monorepos).\n This ensures packages are installed with proper workspace configuration.\n \n --package-manager Force a specific package manager to use. Supported values are:\n \"npm\", \"yarn\", \"pnpm\", \"bun\". If not specified, the command will\n detect the appropriate package manager from lockfiles.\n\nExamples:\n $ ph install @powerhousedao/core # Install a single dependency\n $ ph install @powerhousedao/core @powerhousedao/utils # Install multiple dependencies\n $ ph install @powerhousedao/cli -g # Install globally\n $ ph install @powerhousedao/document-model -w # Install in workspace (monorepo)\n $ ph install @powerhousedao/core --package-manager yarn # Force using yarn\n $ ph install @powerhousedao/editor --debug # Show verbose logs during installation\n\nAliases:\n $ ph add # Alias for install\n $ ph i # Shorthand for install\n"; /** * Help text for the uninstall command */ export declare const uninstallHelp = "\nCommand Overview:\n The uninstall command removes Powerhouse dependencies from your project. It handles the\n removal of packages, updates configuration files, and ensures proper cleanup.\n\n This command:\n 1. Uninstalls specified Powerhouse dependencies using your package manager\n 2. Updates powerhouse.config.json to remove the dependencies\n 3. Supports various uninstallation options and configurations\n 4. Works with npm, yarn, pnpm, and bun package managers\n\nArguments:\n [dependencies...] Names of the dependencies to uninstall. You can provide multiple\n dependency names separated by spaces.\n\nOptions:\n -g, --global Uninstall the dependencies from the global installation\n rather than from the current project.\n \n --debug Show additional logs during the uninstallation process\n for troubleshooting and to trace the command execution.\n \n -w, --workspace Uninstall the dependencies from the workspace (use this option\n for monorepos). This ensures packages are removed while\n respecting workspace configurations.\n \n --package-manager Force a specific package manager to use. Supported values are:\n \"npm\", \"yarn\", \"pnpm\", \"bun\". If not specified, the command will\n detect the appropriate package manager from lockfiles.\n\nExamples:\n $ ph uninstall @powerhousedao/core # Uninstall a single dependency\n $ ph uninstall @powerhousedao/core @powerhousedao/utils # Uninstall multiple dependencies\n $ ph uninstall @powerhousedao/cli -g # Uninstall globally\n $ ph uninstall @powerhousedao/document-model -w # Uninstall from workspace (monorepo)\n $ ph uninstall @powerhousedao/core --package-manager yarn # Force using yarn\n $ ph uninstall @powerhousedao/editor --debug # Show verbose logs during uninstallation\n\nAliases:\n $ ph remove # Alias for uninstall\n"; /** * Help text for the list command */ export declare const listHelp = "\nCommand Overview:\n The list command displays information about installed Powerhouse packages in your project.\n It reads the powerhouse.config.json file and shows the packages that are currently installed.\n\n This command:\n 1. Examines your project configuration\n 2. Lists all installed Powerhouse packages\n 3. Provides a clear overview of your project's dependencies\n 4. Helps you manage and track your Powerhouse components\n\nOptions:\n --debug Show additional logs during the listing process. This provides\n more detailed information about the command execution and can\n be helpful for troubleshooting.\n\nExamples:\n $ ph list # List all installed packages\n $ ph list --debug # List packages with detailed debug information\n\nAliases:\n $ ph l # Shorthand for list\n\nNotes:\n - The command reads from powerhouse.config.json in your project root\n - If no packages are found, the command will inform you that no packages are installed\n - Each package is displayed by its package name\n"; /** * Help text for the dev command */ export declare const devHelp = "\nCommand Overview:\n The dev command sets up a development environment for working with Powerhouse projects.\n It starts a local development server with a Switchboard, enabling real-time document\n model editing and processing.\n\n This command:\n 1. Starts a local development server\n 2. Sets up a Switchboard for document processing\n 3. Enables real-time updates and code generation\n 4. Configures necessary services for development\n\nOptions:\n --generate Generate code automatically when document models are updated.\n This keeps your code in sync with model changes.\n \n --switchboard-port Specify the port to use for the Switchboard service.\n The Switchboard handles document processing and communication.\n \n --https-key-file Path to the SSL key file if using HTTPS for secure connections.\n \n --https-cert-file Path to the SSL certificate file if using HTTPS.\n \n --config-file Path to the powerhouse.config.js file. This allows you to\n customize the behavior of the development environment.\n \n -w, --watch Watch for local changes to document models and processors,\n and automatically update the Switchboard accordingly.\n\nExamples:\n $ ph dev # Start dev environment with defaults\n $ ph dev --generate # Auto-generate code on model changes\n $ ph dev --switchboard-port 5000 # Use custom port for Switchboard\n $ ph dev --config-file custom.powerhouse.config.js # Use custom configuration\n $ ph dev --watch # Watch for changes and auto-update\n $ ph dev --https-key-file key.pem --https-cert-file cert.pem # Use HTTPS\n"; /** * Help text for the vetra command */ export declare const vetraHelp = "\nCommand Overview:\n The vetra command sets up a Vetra development environment for working with Vetra projects.\n It starts a Vetra Switchboard and optionally Connect Studio, enabling document collaboration \n and real-time processing with a \"Vetra\" drive or connection to remote drives.\n\n This command:\n 1. Starts a Vetra Switchboard with a \"Vetra\" drive for document storage\n 2. Optionally connects to remote drives instead of creating a local drive\n 3. Starts Connect Studio pointing to the Switchboard for user interaction (unless disabled)\n 4. Enables real-time updates, collaboration, and code generation\n\nOptions:\n --logs Enable verbose logging for all services. This provides detailed\n output from Switchboard and Connect during startup and operation.\n \n --switchboard-port Specify the port to use for the Vetra Switchboard service.\n Default is 4001. The Switchboard handles document storage.\n \n --connect-port Specify the port to use for Connect Studio.\n Default is 3000. Connect provides the user interface.\n \n --https-key-file Path to the SSL key file if using HTTPS for secure connections.\n \n --https-cert-file Path to the SSL certificate file if using HTTPS.\n \n --config-file Path to the powerhouse.config.js file. This allows you to\n customize the behavior of the Vetra development environment.\n \n -w, --watch Enable dynamic loading for document-models and editors in\n connect-studio and switchboard. When enabled, the system will\n watch for changes in these directories and reload them dynamically.\n \n --remote-drive URL of remote drive to connect to. When specified, the switchboard\n connects to this remote drive instead of creating a local Vetra drive.\n \n --disable-connect Skip Connect initialization (only start switchboard and reactor).\n Use this when you only need the backend services running.\n \n --interactive Enable interactive mode for code generation. When enabled, the system\n will prompt for user confirmation before generating code. This is useful\n for development when you want control over when code regeneration happens.\n\nExamples:\n $ ph vetra # Start Vetra environment with defaults\n $ ph vetra --switchboard-port 5000 --connect-port 3001 # Use custom ports\n $ ph vetra --config-file custom.powerhouse.config.js # Use custom configuration\n $ ph vetra --watch # Enable dynamic loading for development\n $ ph vetra -w # Enable dynamic loading (short form)\n $ ph vetra --logs # Enable detailed logging\n $ ph vetra --remote-drive http://localhost:4001/d/docs # Connect to remote drive\n $ ph vetra --disable-connect # Start only backend services\n $ ph vetra --interactive # Enable interactive code generation mode\n $ ph vetra --https-key-file key.pem --https-cert-file cert.pem # Use HTTPS\n"; /** * Help text for the inspect command */ export declare const inspectHelp = "\nCommand Overview:\n The inspect command examines and provides detailed information about a Powerhouse package.\n It helps you understand the structure, dependencies, and configuration of packages in\n your project.\n\n This command:\n 1. Analyzes the specified package\n 2. Retrieves detailed information about its structure and configuration\n 3. Displays package metadata, dependencies, and other relevant information\n 4. Helps troubleshoot package-related issues\n\nArguments:\n Required. The name of the package to inspect. This should be\n the name of a Powerhouse package or component.\n\nOptions:\n --debug Show additional logs during the inspection process. This is\n useful for troubleshooting or getting more detailed information\n about how the inspection is performed.\n\nExamples:\n $ ph inspect @powerhousedao/core # Inspect the core package\n $ ph inspect @powerhousedao/document-model # Inspect the document-model package\n $ ph inspect my-custom-component # Inspect a custom component\n $ ph inspect @powerhousedao/editor --debug # Inspect with detailed logs\n\nAliases:\n $ ph is # Shorthand for inspect\n\nNotes:\n - This command is useful for debugging and understanding package configurations\n - Information displayed includes package structure, dependencies, and metadata\n - The command requires the package to be installed in your project\n"; /** * Help text for the service command */ export declare const serviceHelp = "\nCommand Overview:\n The service command manages Powerhouse services, allowing you to start, stop, check status,\n and more. It provides a centralized way to control the lifecycle of services in your project.\n\n This command:\n 1. Controls service lifecycle (start, stop, status, etc.)\n 2. Manages multiple services from a single interface\n 3. Provides detailed information about running services\n 4. Uses PM2 under the hood for process management\n\nArguments:\n The action to perform. Available actions:\n - start: Launch the specified service\n - stop: Terminate the specified service\n - status: Check the current status of services\n - list: List all managed services (default)\n - startup: Configure services to start on system boot\n - unstartup: Remove services from system startup\n \n [service] Optional. The service to act upon. Available services:\n - switchboard: The document processing engine\n - connect: The Connect Studio interface\n - all: Act on all services (default)\n\nExamples:\n $ ph service setup # Setup services\n $ ph service start # Start the services\n $ ph service stop # Stop the services\n $ ph service status # Check status of all services\n \n\nNotes:\n - Services are managed using PM2, a process manager for Node.js applications\n - The 'status' action shows uptime, memory usage, CPU usage, and other metrics\n - The 'list' action is the default when no action is specified\n - The 'all' service is the default when no service is specified\n"; /** * Help text for the switchboard command */ export declare const switchboardHelp = "\nCommand Overview:\n The switchboard command starts a local Switchboard instance, which acts as the document\n processing engine for Powerhouse projects. It provides the infrastructure for document\n models, processors, and real-time updates.\n\n This command:\n 1. Starts a local switchboard server\n 2. Loads document models and processors\n 3. Provides an API for document operations\n 4. Enables real-time document processing\n\nOptions:\n --port Port to host the API. Default is 4001.\n \n --config-file Path to the powerhouse.config.js file. Default is \n './powerhouse.config.json'. This configures the switchboard behavior.\n \n --dev Enable development mode to load local packages from the current directory.\n This allows the switchboard to discover and load document models, processors,\n and subgraphs from your local development environment.\n \n --db-path Path to the database for storing document data.\n \n --https-key-file Path to the SSL key file if using HTTPS for secure connections.\n \n --https-cert-file Path to the SSL certificate file if using HTTPS.\n \n --packages List of packages to be loaded. If defined, packages specified\n in the config file are ignored.\n \n --base-path Base path for the API endpoints. Sets the BASE_PATH environment \n variable used by the server to prefix all routes.\n\nExamples:\n $ ph switchboard # Start switchboard with default settings\n $ ph switchboard --port 5000 # Use custom port 5000\n $ ph switchboard --dev # Enable dev mode to load local packages\n $ ph switchboard --config-file custom.json # Use custom configuration file\n $ ph switchboard --packages pkg1 pkg2 # Load specific packages\n $ ph switchboard --base-path /switchboard # Set API base path to /switchboard\n"; /** * Help text for the reactor command */ export declare const reactorHelp = "\nCommand Overview:\n The reactor command starts a local Switchboard instance,\n which acts as the document processing engine for Powerhouse projects. It provides\n the infrastructure for document models, processors, and real-time updates.\n\n This command:\n 1. Starts a local reactor server\n 2. Loads document models and processors\n 3. Provides an API for document operations\n 4. Supports real-time updates and code generation\n\nOptions:\n --port Port to host the API. Default is 4001.\n \n --config-file Path to the powerhouse.config.js file. Default is \n './powerhouse.config.json'. This configures the reactor behavior.\n \n --generate Generate code automatically when document models are updated.\n \n --db-path Path to the database for storing document data.\n \n --https-key-file Path to the SSL key file if using HTTPS for secure connections.\n \n --https-cert-file Path to the SSL certificate file if using HTTPS.\n \n -w, --watch Watch for local changes to document models and processors,\n and automatically update the reactor accordingly.\n \n --packages List of packages to be loaded. If defined, packages specified\n in the config file are ignored.\n\nExamples:\n $ ph reactor # Start reactor with default settings\n $ ph reactor --port 5000 # Use custom port 5000\n $ ph reactor --generate # Enable auto code generation\n $ ph reactor --watch # Watch for local file changes\n $ ph reactor --config-file custom.json # Use custom configuration file\n $ ph reactor --packages pkg1 pkg2 # Load specific packages\n"; /** * Help text for the version command */ export declare const versionHelp = "\nCommand Overview:\n The version command displays the current version of the Powerhouse CLI tool.\n It helps you track which version you're using and ensure compatibility.\n\n This command:\n 1. Retrieves version information from package.json\n 2. Displays the version number of the CLI tool\n 3. Can be used to verify successful installation or updates\n\nOptions:\n --debug Show additional logs during version retrieval. This provides\n more detailed information about how the version is determined,\n which can be helpful for troubleshooting.\n\nExamples:\n $ ph version # Display the CLI version\n $ ph version --debug # Show version with debug information\n\nAliases:\n $ ph v # Shorthand for version\n\nNotes:\n - The version follows semantic versioning (MAJOR.MINOR.PATCH)\n - Using the correct CLI version is important for compatibility with your project\n - Version information is read from the package.json file of the CLI\n"; //# sourceMappingURL=help.d.ts.map