@growthub/create-growthub-local
v0.14.5
Published
Guided installer for Growthub Local and Agent Workspace as Code: create a governed workspace with matching CLI, fork metadata, and local-first lifecycle.
Maintainers
Readme
@growthub/create-growthub-local
@growthub/create-growthub-local is the guided installer for Growthub Local.
It creates a governed Workspace — the top-level Growthub product object and Agent Workspace as Code (AWaC) artifact — by exporting the official growthub-custom-workspace-starter-v1 kit and pinning the matching @growthub/cli version. Local value first; hosted authority is additive.
Quickstart
npm create @growthub/growthub-local@latestAfter install, open the no-code Workspace Builder:
cd <workspace>/apps/workspace
npm install
npm run devReference contracts:
Profile-first install
The installer offers profile selection before command/harness depth:
npm create @growthub/growthub-local@latest -- --profile gtm
npm create @growthub/growthub-local@latest -- --profile dx
npm create @growthub/growthub-local@latest -- --profile workspace --out ./my-workspaceHow this fits the governed workspace architecture
The installer is the safest entrypoint into the same lifecycle the CLI operates:
- choose a source profile or starter path
- export the governed Workspace app
- register the fork metadata and local policy
- open the Workspace Builder for dashboards, tabs, widgets, templates, data model objects, and settings
- continue with
@growthub/clifor status checks, fork sync, deploy preparation, worker kits, workflows, pipelines, and optional Growthub authority
The generated Workspace is not a loose app copy. It carries growthub.config.json plus .growthub-fork/ lifecycle state so export, fork safety, ongoing customization, and agent operation stay tied to one portable artifact.
First-run outcomes
After install, users land on Custom AI Governed Workspace first. The fastest paths are:
- import a GitHub repo into a governed workspace
- import a skills.sh skill into a governed workspace
- start from the workspace starter
- start from a worker kit
- connect Growthub account after local value is proven
- optionally activate upgrade path for hosted depth
Installer options
| Flag | Applies to | Description |
|---|---|---|
| --profile gtm\|dx\|workspace | all | Pick an install profile |
| --run | dx, gtm, discovery | Start Growthub immediately after config |
| --data-dir <path> | dx, gtm, discovery | Override install directory (default: ./growthub-local) |
| --config <path> | dx, gtm, discovery | Use a custom config path |
| --out <path> | workspace | Destination for workspace scaffold |
| --kit <kit-id> | workspace | Source kit id (default: growthub-custom-workspace-starter-v1) |
| --name <label> | workspace | Human label for fork registration |
| --upstream <owner/repo> | workspace | Optionally create remote GitHub fork |
| --destination-org <org> | workspace | Create fork under org |
| --fork-name <name> | workspace | Override GitHub fork name |
| --remote-sync-mode <mode> | workspace | Initial policy mode: off, branch, pr |
| --json | workspace | Emit machine-readable output |
Post-install examples
# Re-open the CLI discovery hub
npx growthub discover
# Re-open the first-run governed workspace path
npx growthub discover --start create-workspace
# Run local app runtime
npx growthub runOptional upgrade activation
Local value comes first. Activation is optional and additive:
Requirements
- Node.js 20+
- npm 7+
