@powerhousedao/academy 4.1.0-dev.9 → 5.0.0-staging.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +294 -0
- package/docs/academy/02-MasteryTrack/04-WorkWithData/03-UsingSubgraphs.md +72 -419
- package/docs/academy/02-MasteryTrack/04-WorkWithData/05-RelationalDbProcessor.md +36 -33
- package/docs/academy/04-APIReferences/00-PowerhouseCLI.md +41 -23
- package/docs/academy/04-APIReferences/01-ReactHooks.md +612 -152
- package/package.json +1 -1
|
@@ -611,6 +611,10 @@ Options:
|
|
|
611
611
|
--config-file <path> Path to the powerhouse.config.js file. Default is
|
|
612
612
|
'./powerhouse.config.json'. This configures the switchboard behavior.
|
|
613
613
|
|
|
614
|
+
--dev Enable development mode to load local packages from the current directory.
|
|
615
|
+
This allows the switchboard to discover and load document models, processors,
|
|
616
|
+
and subgraphs from your local development environment.
|
|
617
|
+
|
|
614
618
|
--db-path <DB_PATH> Path to the database for storing document data.
|
|
615
619
|
|
|
616
620
|
--https-key-file <path> Path to the SSL key file if using HTTPS for secure connections.
|
|
@@ -626,6 +630,7 @@ Options:
|
|
|
626
630
|
Examples:
|
|
627
631
|
$ ph switchboard # Start switchboard with default settings
|
|
628
632
|
$ ph switchboard --port 5000 # Use custom port 5000
|
|
633
|
+
$ ph switchboard --dev # Enable dev mode to load local packages
|
|
629
634
|
$ ph switchboard --config-file custom.json # Use custom configuration file
|
|
630
635
|
$ ph switchboard --packages pkg1 pkg2 # Load specific packages
|
|
631
636
|
$ ph switchboard --base-path /switchboard # Set API base path to /switchboard
|
|
@@ -709,42 +714,55 @@ Notes:
|
|
|
709
714
|
|
|
710
715
|
```
|
|
711
716
|
Command Overview:
|
|
712
|
-
The vetra command sets up a
|
|
713
|
-
It starts
|
|
714
|
-
|
|
717
|
+
The vetra command sets up a Vetra development environment for working with Vetra projects.
|
|
718
|
+
It starts a Vetra Switchboard and optionally Connect Studio, enabling document collaboration
|
|
719
|
+
and real-time processing with a "Vetra" drive or connection to remote drives.
|
|
715
720
|
|
|
716
721
|
This command:
|
|
717
722
|
1. Starts a Vetra Switchboard with a "Vetra" drive for document storage
|
|
718
|
-
2.
|
|
719
|
-
3. Starts Connect Studio pointing to the
|
|
720
|
-
4. Enables real-time updates, collaboration, and code generation
|
|
723
|
+
2. Optionally connects to remote drives instead of creating a local drive
|
|
724
|
+
3. Starts Connect Studio pointing to the Switchboard for user interaction (unless disabled)
|
|
725
|
+
4. Enables real-time updates, collaboration, and code generation
|
|
721
726
|
|
|
722
727
|
Options:
|
|
723
|
-
--
|
|
724
|
-
|
|
728
|
+
--logs Enable verbose logging for all services. This provides detailed
|
|
729
|
+
output from Switchboard and Connect during startup and operation.
|
|
725
730
|
|
|
726
|
-
--switchboard-port <port>
|
|
727
|
-
|
|
731
|
+
--switchboard-port <port> Specify the port to use for the Vetra Switchboard service.
|
|
732
|
+
Default is 4001. The Switchboard handles document storage.
|
|
728
733
|
|
|
729
|
-
--
|
|
730
|
-
|
|
734
|
+
--connect-port <port> Specify the port to use for Connect Studio.
|
|
735
|
+
Default is 3000. Connect provides the user interface.
|
|
731
736
|
|
|
732
|
-
--https-key-file <path>
|
|
737
|
+
--https-key-file <path> Path to the SSL key file if using HTTPS for secure connections.
|
|
733
738
|
|
|
734
|
-
--https-cert-file <path>
|
|
739
|
+
--https-cert-file <path> Path to the SSL certificate file if using HTTPS.
|
|
735
740
|
|
|
736
|
-
--config-file <path>
|
|
737
|
-
|
|
741
|
+
--config-file <path> Path to the powerhouse.config.js file. This allows you to
|
|
742
|
+
customize the behavior of the Vetra development environment.
|
|
738
743
|
|
|
739
|
-
-w, --watch
|
|
740
|
-
|
|
744
|
+
-w, --watch Watch for local changes to document models and processors,
|
|
745
|
+
and automatically update the Switchboard accordingly.
|
|
746
|
+
|
|
747
|
+
--remote-drive <url> URL of remote drive to connect to. When specified, the switchboard
|
|
748
|
+
connects to this remote drive instead of creating a local Vetra drive.
|
|
749
|
+
|
|
750
|
+
--disable-connect Skip Connect initialization (only start switchboard and reactor).
|
|
751
|
+
Use this when you only need the backend services running.
|
|
752
|
+
|
|
753
|
+
--interactive Enable interactive mode for code generation. When enabled, the system
|
|
754
|
+
will prompt for user confirmation before generating code. This is useful
|
|
755
|
+
for development when you want control over when code regeneration happens.
|
|
741
756
|
|
|
742
757
|
Examples:
|
|
743
|
-
$ ph vetra
|
|
744
|
-
$ ph vetra --
|
|
745
|
-
$ ph vetra --
|
|
746
|
-
$ ph vetra --
|
|
747
|
-
$ ph vetra --
|
|
758
|
+
$ ph vetra # Start Vetra environment with defaults
|
|
759
|
+
$ ph vetra --switchboard-port 5000 --connect-port 3001 # Use custom ports
|
|
760
|
+
$ ph vetra --config-file custom.powerhouse.config.js # Use custom configuration
|
|
761
|
+
$ ph vetra --watch # Watch for changes and auto-update
|
|
762
|
+
$ ph vetra --logs # Enable detailed logging
|
|
763
|
+
$ ph vetra --remote-drive http://localhost:4001/d/docs # Connect to remote drive
|
|
764
|
+
$ ph vetra --disable-connect # Start only backend services
|
|
765
|
+
$ ph vetra --interactive # Enable interactive code generation mode
|
|
748
766
|
$ ph vetra --https-key-file key.pem --https-cert-file cert.pem # Use HTTPS
|
|
749
767
|
```
|
|
750
768
|
|