@growthub/create-growthub-local 0.1.57 → 0.1.59

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.
Files changed (2) hide show
  1. package/README.md +23 -68
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -2,88 +2,44 @@
2
2
 
3
3
  `create-growthub-local` is the guided installer for Growthub Local.
4
4
 
5
- It supports two installer paths:
6
-
7
- - profile-driven install for `gtm` or `dx`
8
- - interactive discovery mode when no profile is passed
9
-
10
- ## Usage
11
-
12
- ### Install GTM directly
5
+ ## Quickstart
13
6
 
14
7
  ```bash
15
- npm create growthub-local@latest -- --profile gtm
16
- ```
17
-
18
- ### Install DX directly
8
+ # Interactive (recommended)
9
+ npm create growthub-local@latest
19
10
 
20
- ```bash
11
+ # Direct profile install
12
+ npm create growthub-local@latest -- --profile gtm
21
13
  npm create growthub-local@latest -- --profile dx
22
14
  ```
23
15
 
24
- ### Open the interactive discovery hub
25
-
26
- ```bash
27
- npm create growthub-local@latest
28
- ```
29
-
30
- When no `--profile` is passed, the installer launches `growthub discover` so the user can choose between:
16
+ ## Installer Paths
31
17
 
32
- - full local app
33
- - worker kits
34
- - shared templates
35
-
36
- ## CLI Edition User Flows
37
-
38
- ### 1. Full Local App
39
-
40
- If `--profile gtm` or `--profile dx` is passed, the installer runs a direct onboarding path for that surface.
41
-
42
- Flow:
43
-
44
- 1. Resolve the bundled or installed `@growthub/cli` entrypoint.
45
- 2. Run `growthub onboard --yes`.
46
- 3. Save the new instance under the selected data directory.
47
- 4. Start the local runtime when `--run` is passed.
48
-
49
- ### 2. Interactive discovery mode
50
-
51
- If no profile is passed, the installer defers to `growthub discover`.
52
-
53
- Flow:
54
-
55
- 1. Launch the CLI discovery hub.
56
- 2. Choose `Full Local App`, `Worker Kits`, or `Templates`.
57
- 3. Continue inside the matching CLI workflow.
58
-
59
- This is the correct path when the user does not yet know whether they want a full app install, a worker kit export, or a shared template pull.
18
+ - **Profile mode** (`--profile gtm|dx`)
19
+ - runs direct onboarding for the selected local app profile
20
+ - **Discovery mode** (no profile)
21
+ - opens `growthub discover` so users can choose:
22
+ - Agent Harness
23
+ - Worker Kits
24
+ - Templates
60
25
 
61
26
  ## Options
62
27
 
63
28
  | Flag | Description |
64
29
  |---|---|
65
- | `--profile gtm\|dx` | Optional. If provided, install that local app surface directly. |
66
- | `--run` | Start the local runtime immediately after onboarding. |
67
- | `--data-dir <path>` | Override the install data directory. Default: `./growthub-local`. |
68
- | `--config <path>` | Use a custom config path. |
69
-
70
- ## What The Installer Actually Does
71
-
72
- 1. Resolves the `@growthub/cli` binary, preferring the local repo build when available.
73
- 2. Sets installer mode with `GROWTHUB_INSTALLER_MODE=true`.
74
- 3. If a profile is passed, sets `PAPERCLIP_SURFACE_PROFILE` and runs `growthub onboard --yes`.
75
- 4. If no profile is passed, runs `growthub discover`.
76
-
77
- ## Starting Again After Install
30
+ | `--profile gtm\|dx` | Optional direct install path for local app profiles |
31
+ | `--run` | Start local runtime immediately after onboarding |
32
+ | `--data-dir <path>` | Override install directory (default: `./growthub-local`) |
33
+ | `--config <path>` | Use a custom config path |
78
34
 
79
- If you installed a full local app:
35
+ ## After Install
80
36
 
81
37
  ```bash
82
38
  cd growthub-local
83
39
  npx growthub run
84
40
  ```
85
41
 
86
- If you want the interactive CLI again:
42
+ Open CLI discovery again:
87
43
 
88
44
  ```bash
89
45
  npx growthub
@@ -91,11 +47,10 @@ npx growthub
91
47
 
92
48
  ## Requirements
93
49
 
94
- - Node.js 20 or later
95
- - npm 7 or later
50
+ - Node.js 20+
51
+ - npm 7+
96
52
 
97
53
  ## Links
98
54
 
99
- - [GitHub](https://github.com/Growthub-ai/growthub-local)
100
- - [CLI package](https://github.com/Growthub-ai/growthub-local/tree/main/cli)
101
- - [Contributing](https://github.com/Growthub-ai/growthub-local/blob/main/CONTRIBUTING.md)
55
+ - [Growthub Local](https://github.com/Growthub-ai/growthub-local)
56
+ - [@growthub/cli package docs](https://github.com/Growthub-ai/growthub-local/tree/main/cli)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@growthub/create-growthub-local",
3
- "version": "0.1.57",
3
+ "version": "0.1.59",
4
4
  "description": "Growthub local installer for DX and GTM profiles",
5
5
  "license": "MIT",
6
6
  "type": "module",
@@ -23,7 +23,7 @@
23
23
  "node": ">=20"
24
24
  },
25
25
  "dependencies": {
26
- "@growthub/cli": "0.3.55"
26
+ "@growthub/cli": "0.3.57"
27
27
  },
28
28
  "keywords": [
29
29
  "growthub",