@powerhousedao/ph-cli 0.40.83-dev.0 → 0.40.83-dev.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/README.md CHANGED
@@ -1,18 +1,72 @@
1
1
  # Powerhouse CLI (ph-cli)
2
2
 
3
- A command-line interface tool for Powerhouse DAO that helps you manage and interact with Powerhouse packages and services.
3
+ [![npm version](https://img.shields.io/npm/v/ph-cli.svg)](https://www.npmjs.com/package/ph-cli)
4
+ [![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
5
+ [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](CONTRIBUTING.md)
6
+
7
+ A powerful command-line interface tool for Powerhouse DAO that streamlines the development and management of Powerhouse packages and services. The CLI provides a unified interface for common development tasks, package management, and service operations.
8
+
9
+ ## Table of Contents
10
+
11
+ - [Features](#features)
12
+ - [Installation](#installation)
13
+ - [Quick Start](#quick-start)
14
+ - [Commands](#commands)
15
+ - [Connect](#ph-connect)
16
+ - [Generate](#ph-generate)
17
+ - [Install](#ph-install)
18
+ - [Uninstall](#ph-uninstall)
19
+ - [List](#ph-list)
20
+ - [Inspect](#ph-inspect)
21
+ - [Service](#ph-service)
22
+ - [Version](#ph-version)
23
+ - [Help](#ph-help)
24
+ - [Configuration](#configuration)
25
+ - [Troubleshooting](#troubleshooting)
26
+ - [Contributing](#contributing)
27
+ - [License](#license)
28
+
29
+ ## Features
30
+
31
+ - 🚀 Fast and efficient package management
32
+ - 🔧 Powerful code generation capabilities
33
+ - 🌐 Connect Studio development environment
34
+ - 📦 Workspace-aware package operations
35
+ - 🔍 Package inspection and dependency management
36
+ - 🛠 Service management and monitoring
37
+ - 📝 Comprehensive documentation and help system
4
38
 
5
39
  ## Installation
6
40
 
7
41
  ```bash
8
- npm install ph-cli
42
+ # Install globally
43
+ npm install -g ph-cli
44
+
45
+ # Install as a dev dependency
46
+ npm install --save-dev ph-cli
47
+ ```
48
+
49
+ ## Quick Start
50
+
51
+ ```bash
52
+ # Initialize a new Powerhouse project
53
+ ph init
54
+
55
+ # Start the development environment
56
+ ph connect
57
+
58
+ # Install required dependencies
59
+ ph install @powerhousedao/core
60
+
61
+ # Generate code from models
62
+ ph generate --interactive
9
63
  ```
10
64
 
11
- ## Available Commands
65
+ ## Commands
12
66
 
13
67
  ### `ph connect`
14
68
 
15
- Starts Connect Studio, a development environment for Powerhouse.
69
+ Starts Connect Studio, a development environment for Powerhouse. This command launches a local development server with hot-reloading and debugging capabilities.
16
70
 
17
71
  #### Options:
18
72
  - `-p, --port <port>`: Port to run the server on (default: 3000)
@@ -21,6 +75,7 @@ Starts Connect Studio, a development environment for Powerhouse.
21
75
  - `--open`: Open the browser automatically
22
76
  - `--config-file <configFile>`: Path to the powerhouse.config.js file
23
77
 
78
+ #### Examples:
24
79
  ```bash
25
80
  # Start Connect Studio on default port (3000)
26
81
  ph connect
@@ -40,7 +95,7 @@ ph connect --config-file ./my-config.js
40
95
 
41
96
  ### `ph generate`
42
97
 
43
- Generate code from document models with various options.
98
+ Generate code from document models with various options. This command supports multiple generation types including editors, processors, subgraphs, and import scripts.
44
99
 
45
100
  #### Options:
46
101
  - `-i, --interactive`: Run the command in interactive mode
@@ -58,6 +113,7 @@ Generate code from document models with various options.
58
113
  - `-w, --watch`: Watch the generated code
59
114
  - `-d, --drive-editor <name>`: Generate a drive editor with the specified name
60
115
 
116
+ #### Examples:
61
117
  ```bash
62
118
  # Generate code from a specific file
63
119
  ph generate path/to/model.json
@@ -86,7 +142,7 @@ ph generate --watch
86
142
 
87
143
  ### `ph install` (or `ph add`, `ph i`)
88
144
 
89
- Install Powerhouse dependencies.
145
+ Install Powerhouse dependencies with support for global and workspace-specific installations.
90
146
 
91
147
  #### Options:
92
148
  - `-g, --global`: Install the dependency globally
@@ -94,6 +150,7 @@ Install Powerhouse dependencies.
94
150
  - `-w, --workspace`: Install the dependency in the workspace (use this option for monorepos)
95
151
  - `--package-manager <packageManager>`: Force package manager to use
96
152
 
153
+ #### Examples:
97
154
  ```bash
98
155
  # Install a package
99
156
  ph install @powerhousedao/package-name
@@ -110,7 +167,7 @@ ph install @powerhousedao/package1 @powerhousedao/package2
110
167
 
111
168
  ### `ph uninstall` (or `ph remove`)
112
169
 
113
- Remove Powerhouse dependencies.
170
+ Remove Powerhouse dependencies from your project.
114
171
 
115
172
  #### Options:
116
173
  - `-g, --global`: Remove the dependency globally
@@ -118,6 +175,7 @@ Remove Powerhouse dependencies.
118
175
  - `-w, --workspace`: Remove the dependency in the workspace (use this option for monorepos)
119
176
  - `--package-manager <packageManager>`: Force package manager to use
120
177
 
178
+ #### Examples:
121
179
  ```bash
122
180
  # Remove a package
123
181
  ph uninstall @powerhousedao/package-name
@@ -131,11 +189,12 @@ ph uninstall -w @powerhousedao/package-name
131
189
 
132
190
  ### `ph list` (or `ph l`)
133
191
 
134
- List all installed Powerhouse packages in your project.
192
+ List all installed Powerhouse packages in your project with detailed information.
135
193
 
136
194
  #### Options:
137
195
  - `--debug`: Show additional logs
138
196
 
197
+ #### Examples:
139
198
  ```bash
140
199
  # List packages
141
200
  ph list
@@ -146,11 +205,12 @@ ph list --debug
146
205
 
147
206
  ### `ph inspect` (or `ph is`)
148
207
 
149
- Inspect a specific package.
208
+ Inspect a specific package for detailed information about its dependencies, configuration, and usage.
150
209
 
151
210
  #### Options:
152
211
  - `--debug`: Show additional logs
153
212
 
213
+ #### Examples:
154
214
  ```bash
155
215
  # Inspect a package
156
216
  ph inspect @powerhousedao/package-name
@@ -161,12 +221,13 @@ ph inspect --debug @powerhousedao/package-name
161
221
 
162
222
  ### `ph service`
163
223
 
164
- Manage Powerhouse services.
224
+ Manage Powerhouse services with various operations.
165
225
 
166
226
  #### Options:
167
227
  - `action`: The action to perform (default: "list")
168
228
  - `service`: The service to manage (default: "all")
169
229
 
230
+ #### Examples:
170
231
  ```bash
171
232
  # List all services
172
233
  ph service list
@@ -177,19 +238,21 @@ ph service list service-name
177
238
 
178
239
  ### `ph version` (or `ph v`)
179
240
 
180
- Display the current version of the PH CLI.
241
+ Display the current version of the PH CLI and related information.
181
242
 
182
243
  #### Options:
183
244
  - `--debug`: Show additional logs
184
245
 
246
+ #### Examples:
185
247
  ```bash
186
248
  ph version
187
249
  ```
188
250
 
189
251
  ### `ph help`
190
252
 
191
- Display help information about the CLI and its commands.
253
+ Display comprehensive help information about the CLI and its commands.
192
254
 
255
+ #### Examples:
193
256
  ```bash
194
257
  # Show general help
195
258
  ph help
@@ -198,17 +261,58 @@ ph help
198
261
  ph help <command>
199
262
  ```
200
263
 
201
- ## Global Options
264
+ ## Configuration
265
+
266
+ The CLI can be configured using a `powerhouse.config.js` file in your project root. Here's an example configuration:
267
+
268
+ ```javascript
269
+ module.exports = {
270
+ port: 3000,
271
+ host: false,
272
+ https: false,
273
+ packageManager: 'npm',
274
+ workspace: {
275
+ enabled: true,
276
+ root: './packages'
277
+ }
278
+ };
279
+ ```
280
+
281
+ ## Troubleshooting
282
+
283
+ ### Common Issues
284
+
285
+ 1. **Command not found**
286
+ - Ensure ph-cli is installed globally or locally
287
+ - Check your PATH environment variable
288
+
289
+ 2. **Permission errors**
290
+ - Use sudo for global installations
291
+ - Check directory permissions
202
292
 
203
- Most commands support the following global options:
293
+ 3. **Package installation failures**
294
+ - Clear npm cache: `npm cache clean --force`
295
+ - Check network connectivity
296
+ - Verify package name and version
204
297
 
205
- - `--debug`: Show additional debug logs
206
- - `--package-manager <manager>`: Force the use of a specific package manager
298
+ ### Debug Mode
299
+
300
+ Most commands support a `--debug` flag for additional logging:
301
+
302
+ ```bash
303
+ ph install --debug @powerhousedao/package-name
304
+ ```
207
305
 
208
306
  ## Contributing
209
307
 
210
- Please refer to the project's contribution guidelines for details on our code of conduct and the process for submitting pull requests.
308
+ We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details on:
309
+
310
+ - Code of Conduct
311
+ - Development Process
312
+ - Pull Request Process
313
+ - Style Guide
314
+ - Testing Requirements
211
315
 
212
316
  ## License
213
317
 
214
- This project is licensed under the terms specified in the LICENSE file.
318
+ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
package/dist/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@powerhousedao/ph-cli",
3
- "version": "0.40.83-dev.0",
3
+ "version": "0.40.83-dev.1",
4
4
  "description": "",
5
5
  "license": "AGPL-3.0-only",
6
6
  "type": "module",
@@ -1,4 +1,4 @@
1
- import { type Command } from "commander";
1
+ import { Command } from "commander";
2
2
  import { type ConnectOptions } from "../services/connect.js";
3
3
  import { type CommandActionType } from "../types.js";
4
4
  export declare const connect: CommandActionType<[
@@ -1 +1 @@
1
- {"version":3,"file":"connect.d.ts","sourceRoot":"","sources":["../../../src/commands/connect.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,WAAW,CAAC;AAEzC,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAC7D,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,aAAa,CAAC;AASrD,eAAO,MAAM,OAAO,EAAE,iBAAiB,CACrC;IAAC,cAAc;CAAC,EAChB,OAAO,CAAC,IAAI,CAAC,CAGd,CAAC;AAEF,wBAAgB,cAAc,CAAC,OAAO,EAAE,OAAO,QAmB9C"}
1
+ {"version":3,"file":"connect.d.ts","sourceRoot":"","sources":["../../../src/commands/connect.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAMpC,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAC7D,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,aAAa,CAAC;AASrD,eAAO,MAAM,OAAO,EAAE,iBAAiB,CACrC;IAAC,cAAc;CAAC,EAChB,OAAO,CAAC,IAAI,CAAC,CAGd,CAAC;AA2CF,wBAAgB,cAAc,CAAC,OAAO,EAAE,OAAO,QAY9C"}
@@ -1,4 +1,6 @@
1
- import { connectHelp } from "../help.js";
1
+ import { buildConnect, previewConnect, } from "@powerhousedao/builder-tools/connect-build";
2
+ import { Command } from "commander";
3
+ import { connectBuildHelp, connectPreviewHelp, connectStudioHelp, } from "../help.js";
2
4
  import { setCustomHelp } from "../utils.js";
3
5
  async function startConnect(options) {
4
6
  const Connect = await import("../services/connect.js");
@@ -8,17 +10,45 @@ async function startConnect(options) {
8
10
  export const connect = async (options) => {
9
11
  return startConnect(options);
10
12
  };
13
+ const studioCommand = new Command("studio")
14
+ .description("Starts Connect Studio (default)")
15
+ .option("-p, --port <port>", "Port to run the server on", "3000")
16
+ .option("-h, --host", "Expose the server to the network")
17
+ .option("--https", "Enable HTTPS")
18
+ .option("--open", "Open the browser")
19
+ .option("--config-file <configFile>", "Path to the powerhouse.config.js file")
20
+ .action(async (...args) => {
21
+ await connect(...args);
22
+ });
23
+ setCustomHelp(studioCommand, connectStudioHelp);
24
+ const buildCommand = new Command("build")
25
+ .description("Build Connect project")
26
+ .option("--project-root <path>", "The root directory of the project", process.cwd())
27
+ .option("--assets-dir-name <name>", "The name of the assets directory")
28
+ .option("--external-packages-file-name <name>", "The name of the external packages file")
29
+ .option("--styles-file-name <name>", "The name of the styles file")
30
+ .option("--connect-path <path>", "The path to the Connect dist directory")
31
+ .action(async (...args) => {
32
+ await buildConnect(...args);
33
+ });
34
+ setCustomHelp(buildCommand, connectBuildHelp);
35
+ const previewCommand = new Command("preview")
36
+ .description("Preview built Connect project")
37
+ .option("--project-root <path>", "The root directory of the project")
38
+ .option("-p, --port <port>", "The port to run the server on", "4173")
39
+ .option("--open", "Open the browser")
40
+ .action(async (...args) => {
41
+ await previewConnect(...args);
42
+ });
43
+ setCustomHelp(previewCommand, connectPreviewHelp);
11
44
  export function connectCommand(program) {
12
45
  const cmd = program
13
46
  .command("connect")
14
- .description("Starts Connect Studio")
15
- .option("-p, --port <port>", "Port to run the server on", "3000")
16
- .option("-h, --host", "Expose the server to the network")
17
- .option("--https", "Enable HTTPS")
18
- .option("--open", "Open the browser")
19
- .option("--config-file <configFile>", "Path to the powerhouse.config.js file");
20
- // Use the setCustomHelp utility to apply custom help formatting
21
- setCustomHelp(cmd, connectHelp);
47
+ .description("Powerhouse Connect commands")
48
+ .addCommand(studioCommand)
49
+ .addCommand(buildCommand)
50
+ .addCommand(previewCommand);
51
+ // Set studio as the default command
22
52
  cmd.action(async (...args) => {
23
53
  await connect(...args);
24
54
  });
@@ -1 +1 @@
1
- {"version":3,"file":"connect.js","sourceRoot":"","sources":["../../../src/commands/connect.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAGzC,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAE5C,KAAK,UAAU,YAAY,CAAC,OAAuB;IACjD,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,wBAAwB,CAAC,CAAC;IACvD,MAAM,EAAE,YAAY,EAAE,GAAG,OAAO,CAAC;IACjC,OAAO,YAAY,CAAC,OAAO,CAAC,CAAC;AAC/B,CAAC;AAED,MAAM,CAAC,MAAM,OAAO,GAGhB,KAAK,EAAE,OAAO,EAAE,EAAE;IACpB,OAAO,YAAY,CAAC,OAAO,CAAC,CAAC;AAC/B,CAAC,CAAC;AAEF,MAAM,UAAU,cAAc,CAAC,OAAgB;IAC7C,MAAM,GAAG,GAAG,OAAO;SAChB,OAAO,CAAC,SAAS,CAAC;SAClB,WAAW,CAAC,uBAAuB,CAAC;SACpC,MAAM,CAAC,mBAAmB,EAAE,2BAA2B,EAAE,MAAM,CAAC;SAChE,MAAM,CAAC,YAAY,EAAE,kCAAkC,CAAC;SACxD,MAAM,CAAC,SAAS,EAAE,cAAc,CAAC;SACjC,MAAM,CAAC,QAAQ,EAAE,kBAAkB,CAAC;SACpC,MAAM,CACL,4BAA4B,EAC5B,uCAAuC,CACxC,CAAC;IAEJ,gEAAgE;IAChE,aAAa,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;IAEhC,GAAG,CAAC,MAAM,CAAC,KAAK,EAAE,GAAG,IAAsB,EAAE,EAAE;QAC7C,MAAM,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC;IACzB,CAAC,CAAC,CAAC;AACL,CAAC;AAED,IAAI,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,OAAO,EAAE,CAAC;IACnC,MAAM,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACtC,MAAM,OAAO,GAAG,UAAU,CAAC,CAAC,CAAE,IAAI,CAAC,KAAK,CAAC,UAAU,CAAoB,CAAC,CAAC,CAAC,EAAE,CAAC;IAC7E,YAAY,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,CAAU,EAAE,EAAE;QACzC,MAAM,CAAC,CAAC;IACV,CAAC,CAAC,CAAC;AACL,CAAC"}
1
+ {"version":3,"file":"connect.js","sourceRoot":"","sources":["../../../src/commands/connect.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,EACZ,cAAc,GAGf,MAAM,4CAA4C,CAAC;AACpD,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EACL,gBAAgB,EAChB,kBAAkB,EAClB,iBAAiB,GAClB,MAAM,YAAY,CAAC;AAGpB,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAE5C,KAAK,UAAU,YAAY,CAAC,OAAuB;IACjD,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,wBAAwB,CAAC,CAAC;IACvD,MAAM,EAAE,YAAY,EAAE,GAAG,OAAO,CAAC;IACjC,OAAO,YAAY,CAAC,OAAO,CAAC,CAAC;AAC/B,CAAC;AAED,MAAM,CAAC,MAAM,OAAO,GAGhB,KAAK,EAAE,OAAO,EAAE,EAAE;IACpB,OAAO,YAAY,CAAC,OAAO,CAAC,CAAC;AAC/B,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,IAAI,OAAO,CAAC,QAAQ,CAAC;KACxC,WAAW,CAAC,iCAAiC,CAAC;KAC9C,MAAM,CAAC,mBAAmB,EAAE,2BAA2B,EAAE,MAAM,CAAC;KAChE,MAAM,CAAC,YAAY,EAAE,kCAAkC,CAAC;KACxD,MAAM,CAAC,SAAS,EAAE,cAAc,CAAC;KACjC,MAAM,CAAC,QAAQ,EAAE,kBAAkB,CAAC;KACpC,MAAM,CAAC,4BAA4B,EAAE,uCAAuC,CAAC;KAC7E,MAAM,CAAC,KAAK,EAAE,GAAG,IAAsB,EAAE,EAAE;IAC1C,MAAM,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC;AACzB,CAAC,CAAC,CAAC;AACL,aAAa,CAAC,aAAa,EAAE,iBAAiB,CAAC,CAAC;AAEhD,MAAM,YAAY,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC;KACtC,WAAW,CAAC,uBAAuB,CAAC;KACpC,MAAM,CACL,uBAAuB,EACvB,mCAAmC,EACnC,OAAO,CAAC,GAAG,EAAE,CACd;KACA,MAAM,CAAC,0BAA0B,EAAE,kCAAkC,CAAC;KACtE,MAAM,CACL,sCAAsC,EACtC,wCAAwC,CACzC;KACA,MAAM,CAAC,2BAA2B,EAAE,6BAA6B,CAAC;KAClE,MAAM,CAAC,uBAAuB,EAAE,wCAAwC,CAAC;KACzE,MAAM,CAAC,KAAK,EAAE,GAAG,IAA2B,EAAE,EAAE;IAC/C,MAAM,YAAY,CAAC,GAAG,IAAI,CAAC,CAAC;AAC9B,CAAC,CAAC,CAAC;AACL,aAAa,CAAC,YAAY,EAAE,gBAAgB,CAAC,CAAC;AAE9C,MAAM,cAAc,GAAG,IAAI,OAAO,CAAC,SAAS,CAAC;KAC1C,WAAW,CAAC,+BAA+B,CAAC;KAC5C,MAAM,CAAC,uBAAuB,EAAE,mCAAmC,CAAC;KACpE,MAAM,CAAC,mBAAmB,EAAE,+BAA+B,EAAE,MAAM,CAAC;KACpE,MAAM,CAAC,QAAQ,EAAE,kBAAkB,CAAC;KACpC,MAAM,CAAC,KAAK,EAAE,GAAG,IAA6B,EAAE,EAAE;IACjD,MAAM,cAAc,CAAC,GAAG,IAAI,CAAC,CAAC;AAChC,CAAC,CAAC,CAAC;AACL,aAAa,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;AAElD,MAAM,UAAU,cAAc,CAAC,OAAgB;IAC7C,MAAM,GAAG,GAAG,OAAO;SAChB,OAAO,CAAC,SAAS,CAAC;SAClB,WAAW,CAAC,6BAA6B,CAAC;SAC1C,UAAU,CAAC,aAAa,CAAC;SACzB,UAAU,CAAC,YAAY,CAAC;SACxB,UAAU,CAAC,cAAc,CAAC,CAAC;IAE9B,oCAAoC;IACpC,GAAG,CAAC,MAAM,CAAC,KAAK,EAAE,GAAG,IAAsB,EAAE,EAAE;QAC7C,MAAM,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC;IACzB,CAAC,CAAC,CAAC;AACL,CAAC;AAED,IAAI,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,OAAO,EAAE,CAAC;IACnC,MAAM,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACtC,MAAM,OAAO,GAAG,UAAU,CAAC,CAAC,CAAE,IAAI,CAAC,KAAK,CAAC,UAAU,CAAoB,CAAC,CAAC,CAAC,EAAE,CAAC;IAC7E,YAAY,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,CAAU,EAAE,EAAE;QACzC,MAAM,CAAC,CAAC;IACV,CAAC,CAAC,CAAC;AACL,CAAC"}
@@ -1,7 +1,15 @@
1
1
  /**
2
- * Help text for the connect command
2
+ * Help text for the connect studio command
3
3
  */
4
- export declare const connectHelp = "\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 -p, --port <port> Port to run the server on. Default is 3000.\n \n -h, --host Expose the server to the network. By default, the server\n only accepts connections from localhost.\n \n --https Enable HTTPS for secure connections. You may need to provide\n certificate files for this option to work properly.\n \n --open Automatically open the browser window after starting the server.\n \n --config-file <path> Path to the powerhouse.config.js file. This allows you to\n customize the behavior of Connect Studio.\n\nExamples:\n $ ph connect # Start Connect Studio on default port 3000\n $ ph connect -p 8080 # Start on port 8080\n $ ph connect -h # Expose to network (not just localhost)\n $ ph connect --https # Enable HTTPS\n $ ph connect --open # Open browser automatically\n $ ph connect --config-file custom.config.js # Use custom configuration\n $ ph connect -p 8080 --open # Start on port 8080 and open browser\n";
4
+ 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 -p, --port <port> Port to run the server on. Default is 3000.\n \n -h, --host Expose the server to the network. By default, the server\n only accepts connections from localhost.\n \n --https Enable HTTPS for secure connections. You may need to provide\n certificate files for this option to work properly.\n \n --open Automatically open the browser window after starting the server.\n \n --config-file <path> Path to the powerhouse.config.js file. This allows you to\n customize the behavior of Connect Studio.\n\nExamples:\n $ ph connect # Start Connect Studio on default port 3000\n $ ph connect -p 8080 # Start on port 8080\n $ ph connect -h # Expose to network (not just localhost)\n $ ph connect --https # Enable HTTPS\n $ ph connect --open # Open browser automatically\n $ ph connect --config-file custom.config.js # Use custom configuration\n $ ph connect -p 8080 --open # Start on port 8080 and open browser\n";
5
+ /**
6
+ * Help text for the connect build command
7
+ */
8
+ export declare const connectBuildHelp = "\nCommand Overview:\n The Connect build command creates a connect build with the project's local and external packages included.\n\nOptions:\n --project-root <path> The root directory of the project. Default is \"process.cwd()\".\n --assets-dir-name <name> The name of the assets directory. Default is \"assets\".\n --external-packages-file-name <name> The name of the external packages file. Default is \"external-packages.js\".\n --styles-file-name <name> The name of the styles file. Default is \"style.css\".\n --connect-path <path> The path to the Connect dist directory. Calls \"resolveConnect()\" if not provided.\n";
9
+ /**
10
+ * Help text for the connect preview command
11
+ */
12
+ 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 --project-root <path> The root directory of the project. Default is \"process.cwd()\".\n --port <port> The port to run the server on. Default is 4173.\n --open Open the browser. Default is true.\n";
5
13
  /**
6
14
  * Help text for the generate command
7
15
  */
@@ -1 +1 @@
1
- {"version":3,"file":"help.d.ts","sourceRoot":"","sources":["../../src/help.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,WAAW,itDAkCvB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,YAAY,kpGA0DxB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,WAAW,+jEAsCvB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,aAAa,4pEAwCzB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,QAAQ,ypCA2BpB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,OAAO,m7DAoCnB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,WAAW,miDAkCvB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,WAAW,+mEAuCvB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,eAAe,ixDAoC3B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,WAAW,s6DAuCvB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,WAAW,2kCA0BvB,CAAC"}
1
+ {"version":3,"file":"help.d.ts","sourceRoot":"","sources":["../../src/help.ts"],"names":[],"mappings":"AAMA;;GAEG;AACH,eAAO,MAAM,iBAAiB,itDAkC7B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,gBAAgB,2nBAU5B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,kBAAkB,yXAS9B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,YAAY,kpGA0DxB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,WAAW,+jEAsCvB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,aAAa,4pEAwCzB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,QAAQ,ypCA2BpB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,OAAO,m7DAoCnB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,WAAW,miDAkCvB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,WAAW,+mEAuCvB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,eAAe,ixDAoC3B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,WAAW,s6DAuCvB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,WAAW,2kCA0BvB,CAAC"}
package/dist/src/help.js CHANGED
@@ -1,7 +1,8 @@
1
+ import { DEFAULT_ASSETS_DIR_NAME, DEFAULT_EXTERNAL_PACKAGES_FILE_NAME, DEFAULT_STYLES_FILE_NAME, } from "@powerhousedao/builder-tools/connect-build";
1
2
  /**
2
- * Help text for the connect command
3
+ * Help text for the connect studio command
3
4
  */
4
- export const connectHelp = `
5
+ export const connectStudioHelp = `
5
6
  Command Overview:
6
7
  The connect command starts the Connect Studio, a development environment for building
7
8
  and testing Powerhouse applications. It provides a visual interface for working with
@@ -36,6 +37,33 @@ Examples:
36
37
  $ ph connect --config-file custom.config.js # Use custom configuration
37
38
  $ ph connect -p 8080 --open # Start on port 8080 and open browser
38
39
  `;
40
+ /**
41
+ * Help text for the connect build command
42
+ */
43
+ export const connectBuildHelp = `
44
+ Command Overview:
45
+ The Connect build command creates a connect build with the project's local and external packages included.
46
+
47
+ Options:
48
+ --project-root <path> The root directory of the project. Default is "process.cwd()".
49
+ --assets-dir-name <name> The name of the assets directory. Default is "${DEFAULT_ASSETS_DIR_NAME}".
50
+ --external-packages-file-name <name> The name of the external packages file. Default is "${DEFAULT_EXTERNAL_PACKAGES_FILE_NAME}".
51
+ --styles-file-name <name> The name of the styles file. Default is "${DEFAULT_STYLES_FILE_NAME}".
52
+ --connect-path <path> The path to the Connect dist directory. Calls "resolveConnect()" if not provided.
53
+ `;
54
+ /**
55
+ * Help text for the connect preview command
56
+ */
57
+ export const connectPreviewHelp = `
58
+ Command Overview:
59
+ The Connect preview command previews a built Connect project.
60
+ NOTE: You must run \`ph connect build\` first.
61
+
62
+ Options:
63
+ --project-root <path> The root directory of the project. Default is "process.cwd()".
64
+ --port <port> The port to run the server on. Default is 4173.
65
+ --open Open the browser. Default is true.
66
+ `;
39
67
  /**
40
68
  * Help text for the generate command
41
69
  */
@@ -1 +1 @@
1
- {"version":3,"file":"help.js","sourceRoot":"","sources":["../../src/help.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAkC1B,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA0D3B,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAsC1B,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAwC5B,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;CA2BvB,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAoCtB,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAkC1B,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAuC1B,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAoC9B,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAuC1B,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;CA0B1B,CAAC"}
1
+ {"version":3,"file":"help.js","sourceRoot":"","sources":["../../src/help.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,uBAAuB,EACvB,mCAAmC,EACnC,wBAAwB,GACzB,MAAM,4CAA4C,CAAC;AAEpD;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAkChC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG;;;;;;2EAM2C,uBAAuB;6FACL,mCAAmC;uEACzD,wBAAwB;;CAE9F,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG;;;;;;;;;CASjC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA0D3B,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAsC1B,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAwC5B,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;CA2BvB,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAoCtB,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAkC1B,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAuC1B,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAoC9B,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAuC1B,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;CA0B1B,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AACzE,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,WAAW,CAAC;AAKzC,eAAO,MAAM,sBAAsB,2BAA2B,CAAC;AAC/D,eAAO,MAAM,qBAAqB,QAA8B,CAAC;AACjE,eAAO,MAAM,0BAA0B,UAAiC,CAAC;AAEzE,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAoC3B,CAAC;AAEF,KAAK,cAAc,GAAG,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC;AAE/C,MAAM,MAAM,cAAc,GAAG,KAAK,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC;AAE7D,MAAM,MAAM,WAAW,GAAG;IACxB,QAAQ,EAAE,OAAO,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,wBAAgB,qBAAqB,YAEpC;AAED,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,MAAM,WAI9C;AAED,wBAAgB,mBAAmB,CACjC,GAAG,EAAE,MAAM,EACX,cAAc,GAAE,cAAsC,iBAevD;AAED,wBAAgB,cAAc,CAAC,KAAK,CAAC,EAAE,OAAO,GAAG,WAAW,CAoB3D;AAED,wBAAgB,6BAA6B,CAAC,GAAG,EAAE,MAAM,GAAG,cAAc,CAUzE;AAED,wBAAgB,yBAAyB,CAAC,GAAG,EAAE,MAAM,GAAG,cAAc,CAYrE;AAED,wBAAgB,mBAAmB,CACjC,eAAe,EAAE,gBAAgB,CAAC,UAAU,CAAM,EAClD,YAAY,EAAE;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,EAAE,EAC3E,IAAI,GAAE,SAAS,GAAG,WAAuB,GACxC,gBAAgB,CAAC,UAAU,CAAC,CAmB9B;AAGD,wBAAgB,gBAAgB,CAC9B,YAAY,EAAE;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,EAAE,EAC3E,WAAW,EAAE,MAAM,EACnB,IAAI,GAAE,SAAS,GAAG,WAAuB,QAoB1C;AAED;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,sBAAsB,cACtB,MAAM,cACL,MAAM,KACjB,MAAM,GAAG,IAeX,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAiBzE;AAED,OAAO,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAC"}
1
+ {"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AACzE,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,WAAW,CAAC;AAKzC,eAAO,MAAM,sBAAsB,2BAA2B,CAAC;AAC/D,eAAO,MAAM,qBAAqB,QAA8B,CAAC;AACjE,eAAO,MAAM,0BAA0B,UAAiC,CAAC;AAEzE,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAoC3B,CAAC;AAEF,KAAK,cAAc,GAAG,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC;AAE/C,MAAM,MAAM,cAAc,GAAG,KAAK,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC;AAE7D,MAAM,MAAM,WAAW,GAAG;IACxB,QAAQ,EAAE,OAAO,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,wBAAgB,qBAAqB,YAEpC;AAED,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,MAAM,WAI9C;AAED,wBAAgB,mBAAmB,CACjC,GAAG,EAAE,MAAM,EACX,cAAc,GAAE,cAAsC,iBAevD;AAED,wBAAgB,cAAc,CAAC,KAAK,CAAC,EAAE,OAAO,GAAG,WAAW,CAoB3D;AAED,wBAAgB,6BAA6B,CAAC,GAAG,EAAE,MAAM,GAAG,cAAc,CAUzE;AAED,wBAAgB,yBAAyB,CAAC,GAAG,EAAE,MAAM,GAAG,cAAc,CAYrE;AAED,wBAAgB,mBAAmB,CACjC,eAAe,EAAE,gBAAgB,CAAC,UAAU,CAAM,EAClD,YAAY,EAAE;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,EAAE,EAC3E,IAAI,GAAE,SAAS,GAAG,WAAuB,GACxC,gBAAgB,CAAC,UAAU,CAAC,CAmB9B;AAGD,wBAAgB,gBAAgB,CAC9B,YAAY,EAAE;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,EAAE,EAC3E,WAAW,EAAE,MAAM,EACnB,IAAI,GAAE,SAAS,GAAG,WAAuB,QAoB1C;AAED;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,sBAAsB,GACjC,WAAW,MAAM,EACjB,YAAY,MAAM,KACjB,MAAM,GAAG,IAeX,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAiBzE;AAED,OAAO,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAC"}
@@ -1,2 +1,2 @@
1
- export declare const version = "0.40.83-dev.0";
1
+ export declare const version = "0.40.83-dev.1";
2
2
  //# sourceMappingURL=version.d.ts.map
@@ -1,3 +1,3 @@
1
1
  // This file is auto-generated. DO NOT EDIT.
2
- export const version = "0.40.83-dev.0";
2
+ export const version = "0.40.83-dev.1";
3
3
  //# sourceMappingURL=version.js.map