create-growthub-local

Install and run a local Growthub instance — GTM or DX surface — in one command.

Usage

Go-to-Market surface:

npm create growthub-local@latest -- --profile gtm

DX (Developer Experience) surface:

npm create growthub-local@latest -- --profile dx

Both commands install the local runtime into a growthub-local/ folder in your current directory, onboard a fresh instance, and start the server.

Options

| Flag | Description | |---|---| | --profile gtm\|dx | Required. Selects the surface to install. | | --run | Start the server immediately after install. | | --data-dir <path> | Custom directory for instance data (default: ./growthub-local). | | --config <path> | Path to a custom config file. |

What happens

1. Installs @growthub/cli and provisions a local instance
2. Starts an embedded PostgreSQL database on an auto-selected port
3. Serves the local UI at http://localhost:3100 (GTM) or http://localhost:3101 (DX)
4. Opens the Growthub Connection card — complete auth to bridge to hosted Growthub

Starting again after install

cd growthub-local
npx growthub start

Upgrading

cd growthub-local
npx growthub upgrade

Upgrades the CLI and server in place. Runs any pending migrations. No data loss.

Running two surfaces

Each surface needs its own directory:

mkdir gtm-fresh && cd gtm-fresh
npm create growthub-local@latest -- --profile gtm --run

mkdir dx-fresh && cd dx-fresh
npm create growthub-local@latest -- --profile dx --run

Each instance gets an isolated database and port. They share no state.

Requirements

• Node.js 20 or later
• npm 7 or later (for npm create)

Links

• GitHub
• Contributing
• Issues