@growthub/create-growthub-local 0.4.2 → 0.4.4

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 +39 -44
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -1,75 +1,69 @@
1
- # create-growthub-local
1
+ # @growthub/create-growthub-local
2
2
 
3
- `create-growthub-local` is the guided installer for Growthub Local.
3
+ `@growthub/create-growthub-local` is the guided installer for Growthub Local.
4
4
 
5
- It now handles three lanes in one command, so a fresh user can get either the
6
- Paperclip Local App or a Custom Workspace Starter workspace in a single step —
7
- no second `growthub starter init` call required.
5
+ It is designed for immediate value first: choose a profile, create a usable local environment, then optionally activate hosted lanes later.
8
6
 
9
7
  ## Quickstart
10
8
 
11
9
  ```bash
12
- # Interactive discovery hub (kits / templates / workflows / agent harness / settings)
13
10
  npm create growthub-local@latest
11
+ ```
12
+
13
+ ## Profile-first install
14
+
15
+ The installer offers profile selection before command/harness depth:
14
16
 
15
- # Paperclip Local App profiles
17
+ ```bash
16
18
  npm create growthub-local@latest -- --profile gtm
17
19
  npm create growthub-local@latest -- --profile dx
18
-
19
- # Custom Workspace Starter (zero second step — scaffolds + registers as a fork)
20
20
  npm create growthub-local@latest -- --profile workspace --out ./my-workspace
21
21
  ```
22
22
 
23
- ## Installer Paths
23
+ ## First-run outcomes
24
24
 
25
- - **Paperclip Local App** (`--profile gtm|dx`)
26
- - runs `growthub onboard --yes` for the selected surface profile
27
- - **Custom Workspace Starter** (`--profile workspace`)
28
- - runs `growthub starter init --out <path>` against the bundled
29
- `growthub-custom-workspace-starter-v1` kit
30
- - composes the already-shipping primitives — `copyBundledKitSource`,
31
- `registerKitFork`, `writeKitForkPolicy`, `appendKitForkTraceEvent`,
32
- and (optionally) `createFork` via the first-party GitHub integration
33
- - no cross-package coupling beyond the existing `@growthub/cli` dep pin
34
- - **Discovery mode** (no profile)
35
- - opens `growthub discover` so users can pick Worker Kits, Templates,
36
- Workflows, Local Intelligence, Agent Harness, Settings, or Help
25
+ After install, users typically choose one of these six outcomes:
37
26
 
38
- ## Options
27
+ 1. import a GitHub repo into a governed workspace
28
+ 2. import a skills.sh skill into a governed workspace
29
+ 3. start from a custom workspace starter
30
+ 4. download a worker kit
31
+ 5. connect Growthub account after local value is proven
32
+ 6. optionally activate upgrade path for hosted depth
33
+
34
+ ## Installer options
39
35
 
40
36
  | Flag | Applies to | Description |
41
37
  |---|---|---|
42
- | `--profile gtm\|dx\|workspace` | all | Pick an install lane |
43
- | `--run` | `dx`, `gtm`, discovery | Start Growthub immediately after saving config |
38
+ | `--profile gtm\|dx\|workspace` | all | Pick an install profile |
39
+ | `--run` | `dx`, `gtm`, discovery | Start Growthub immediately after config |
44
40
  | `--data-dir <path>` | `dx`, `gtm`, discovery | Override install directory (default: `./growthub-local`) |
45
41
  | `--config <path>` | `dx`, `gtm`, discovery | Use a custom config path |
46
- | `--out <path>` | `workspace` | Destination directory for the new workspace |
42
+ | `--out <path>` | `workspace` | Destination for workspace scaffold |
47
43
  | `--kit <kit-id>` | `workspace` | Source kit id (default: `growthub-custom-workspace-starter-v1`) |
48
- | `--name <label>` | `workspace` | Human label for the fork |
49
- | `--upstream <owner/repo>` | `workspace` | When set, also creates a remote GitHub fork |
50
- | `--destination-org <org>` | `workspace` | Create the GitHub fork under an org |
51
- | `--fork-name <name>` | `workspace` | Override the GitHub fork name |
52
- | `--remote-sync-mode <mode>` | `workspace` | Initial `policy.remoteSyncMode` `off` (default), `branch`, `pr` |
53
- | `--json` | `workspace` | Emit machine-readable output from `growthub starter init` |
44
+ | `--name <label>` | `workspace` | Human label for fork registration |
45
+ | `--upstream <owner/repo>` | `workspace` | Optionally create remote GitHub fork |
46
+ | `--destination-org <org>` | `workspace` | Create fork under org |
47
+ | `--fork-name <name>` | `workspace` | Override GitHub fork name |
48
+ | `--remote-sync-mode <mode>` | `workspace` | Initial policy mode: `off`, `branch`, `pr` |
49
+ | `--json` | `workspace` | Emit machine-readable output |
54
50
 
55
- ## After install — Paperclip Local App
51
+ ## Post-install examples
56
52
 
57
53
  ```bash
58
- cd growthub-local
54
+ # Re-open the CLI discovery hub
55
+ npx growthub discover
56
+
57
+ # Run local app runtime
59
58
  npx growthub run
60
59
  ```
61
60
 
62
- ## After install — Custom Workspace Starter
61
+ ## Optional upgrade activation
63
62
 
64
- ```bash
65
- cd my-workspace
63
+ Local value comes first. Activation is optional and additive:
66
64
 
67
- # Inspect your new fork (registration + policy + trace)
68
- npx growthub kit fork status <fork-id>
69
-
70
- # Re-open the discovery hub any time
71
- npx growthub
72
- ```
65
+ [![Activate on Growthub](https://img.shields.io/badge/Activate-Growthub-111827?style=for-the-badge)](https://www.growthub.ai/)
66
+ [![First Month](https://img.shields.io/badge/First%20Month-%241-22c55e?style=for-the-badge)](https://www.growthub.ai/)
73
67
 
74
68
  ## Requirements
75
69
 
@@ -78,5 +72,6 @@ npx growthub
78
72
 
79
73
  ## Links
80
74
 
81
- - [Growthub Local](https://github.com/Growthub-ai/growthub-local)
75
+ - [Growthub Local README](https://github.com/Growthub-ai/growthub-local#readme)
82
76
  - [@growthub/cli package docs](https://github.com/Growthub-ai/growthub-local/tree/main/cli)
77
+ - [Contributing](https://github.com/Growthub-ai/growthub-local/blob/main/CONTRIBUTING.md)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@growthub/create-growthub-local",
3
- "version": "0.4.2",
3
+ "version": "0.4.4",
4
4
  "description": "Growthub Local is a control plane for forked worker kits. The CLI is the executor, the hosted app is the identity authority, the worker kit is the unit of portable agent infrastructure, and the fork is the operator's personal branch of that infrastructure — policy-governed, trace-backed, and self-healing.",
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.7.3"
26
+ "@growthub/cli": "0.7.5"
27
27
  },
28
28
  "keywords": [
29
29
  "growthub",