@growthub/cli 0.3.55 → 0.3.56
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 +56 -156
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,12 +1,6 @@
|
|
|
1
1
|
# @growthub/cli
|
|
2
2
|
|
|
3
|
-
`@growthub/cli` is the
|
|
4
|
-
|
|
5
|
-
- full local app discovery and onboarding
|
|
6
|
-
- worker kit discovery, export, inspection, and validation
|
|
7
|
-
- shared template discovery and extraction
|
|
8
|
-
- hosted workflows, capabilities, dynamic pipelines, and artifacts
|
|
9
|
-
- hosted Growthub auth + machine profile bridge
|
|
3
|
+
`@growthub/cli` is the public CLI for Growthub Local.
|
|
10
4
|
|
|
11
5
|
## Install
|
|
12
6
|
|
|
@@ -14,201 +8,107 @@
|
|
|
14
8
|
npm install -g @growthub/cli
|
|
15
9
|
```
|
|
16
10
|
|
|
17
|
-
|
|
11
|
+
Or use the guided installer:
|
|
18
12
|
|
|
19
13
|
```bash
|
|
20
14
|
npm create growthub-local@latest
|
|
21
15
|
```
|
|
22
16
|
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
```bash
|
|
26
|
-
npm create growthub-local@latest -- --profile gtm
|
|
27
|
-
npm create growthub-local@latest -- --profile dx
|
|
28
|
-
```
|
|
29
|
-
|
|
30
|
-
## CLI Editions
|
|
17
|
+
## At a Glance
|
|
31
18
|
|
|
32
|
-
The
|
|
19
|
+
The CLI ships these user flows:
|
|
33
20
|
|
|
34
|
-
|
|
21
|
+
- `Agent Harness` (Paperclip Local App, Open Agents, Qwen Code CLI)
|
|
22
|
+
- `Worker Kits`
|
|
23
|
+
- `Templates`
|
|
24
|
+
- `Workflows`
|
|
25
|
+
- `Local Intelligence`
|
|
26
|
+
- `Hosted Auth Bridge`
|
|
35
27
|
|
|
36
|
-
|
|
28
|
+
## Quick Commands
|
|
37
29
|
|
|
38
30
|
```bash
|
|
31
|
+
# Discovery
|
|
39
32
|
growthub
|
|
40
|
-
growthub list
|
|
41
33
|
growthub discover
|
|
34
|
+
|
|
35
|
+
# Agent Harness
|
|
42
36
|
growthub onboard
|
|
43
37
|
growthub run
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
User flow:
|
|
47
|
-
|
|
48
|
-
1. Open the discovery hub.
|
|
49
|
-
2. Choose `Full Local App`.
|
|
50
|
-
3. Create a new `gtm` or `dx` profile, or load an existing local profile.
|
|
51
|
-
4. Complete onboarding.
|
|
52
|
-
5. Start the local server and finish the hosted authentication bridge.
|
|
38
|
+
growthub open-agents
|
|
39
|
+
growthub qwen-code
|
|
53
40
|
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
Use this when you want a working-directory-ready environment for an agent.
|
|
57
|
-
|
|
58
|
-
### Discovery
|
|
59
|
-
|
|
60
|
-
```bash
|
|
61
|
-
# Interactive discovery hub
|
|
62
|
-
growthub list
|
|
63
|
-
|
|
64
|
-
# Interactive browser — type filter → kit selector → actions
|
|
41
|
+
# Worker Kits
|
|
65
42
|
growthub kit
|
|
66
|
-
|
|
67
|
-
# All kits grouped by family with descriptions and inline commands
|
|
68
43
|
growthub kit list
|
|
44
|
+
growthub kit inspect <kit-id>
|
|
45
|
+
growthub kit download <kit-id>
|
|
46
|
+
growthub kit validate <path>
|
|
69
47
|
|
|
70
|
-
#
|
|
71
|
-
growthub
|
|
72
|
-
growthub
|
|
48
|
+
# Templates
|
|
49
|
+
growthub template
|
|
50
|
+
growthub template list
|
|
51
|
+
growthub template get <slug>
|
|
73
52
|
|
|
74
|
-
#
|
|
75
|
-
growthub
|
|
53
|
+
# Workflows
|
|
54
|
+
growthub workflow
|
|
55
|
+
growthub workflow saved
|
|
56
|
+
growthub pipeline assemble
|
|
76
57
|
|
|
77
|
-
#
|
|
78
|
-
growthub
|
|
58
|
+
# Hosted Auth Bridge
|
|
59
|
+
growthub auth login
|
|
60
|
+
growthub auth whoami
|
|
61
|
+
growthub auth logout
|
|
79
62
|
```
|
|
80
63
|
|
|
81
|
-
|
|
64
|
+
## Worker Kit Command Surface
|
|
82
65
|
|
|
83
66
|
```bash
|
|
67
|
+
growthub kit list
|
|
84
68
|
growthub kit inspect creative-strategist-v1
|
|
85
69
|
growthub kit inspect growthub-open-higgsfield-studio-v1
|
|
86
|
-
growthub kit inspect growthub-email-marketing-v1 --json
|
|
87
|
-
|
|
88
70
|
growthub kit download creative-strategist-v1
|
|
89
71
|
growthub kit download growthub-open-higgsfield-studio-v1
|
|
90
|
-
growthub kit download higgsfield --yes
|
|
91
|
-
|
|
92
72
|
growthub kit path creative-strategist-v1
|
|
93
73
|
growthub kit validate /absolute/path/to/kit
|
|
94
74
|
```
|
|
95
75
|
|
|
96
|
-
### After download
|
|
97
|
-
|
|
98
|
-
1. Point Growthub local or your local adapter `Working directory` at the exported folder.
|
|
99
|
-
2. Add runtime-only environment variables required by the kit.
|
|
100
|
-
3. Start a new session so the operator contract loads from `CLAUDE.md`.
|
|
101
|
-
|
|
102
|
-
### Available bundled kits
|
|
103
|
-
|
|
104
|
-
| Kit | Family | Description |
|
|
105
|
-
|---|---|---|
|
|
106
|
-
| `creative-strategist-v1` | workflow | Video creative briefs and campaign strategy |
|
|
107
|
-
| `growthub-email-marketing-v1` | operator | Brand-aware email campaigns, sequences, and campaign planning |
|
|
108
|
-
| `growthub-open-higgsfield-studio-v1` | studio | Open Higgsfield visual production workflows |
|
|
109
|
-
|
|
110
76
|
### How local adapters use worker kits
|
|
111
77
|
|
|
112
|
-
|
|
78
|
+
1. Download or resolve a kit path from the CLI.
|
|
79
|
+
2. Point the agent working directory at the exported folder.
|
|
80
|
+
3. Start a new session so the kit contract loads from `CLAUDE.md`.
|
|
113
81
|
|
|
114
|
-
|
|
115
|
-
2. Point the agent `Working directory` at the exported folder.
|
|
116
|
-
3. Start a new session so the agent reads the kit contract from `CLAUDE.md`.
|
|
82
|
+
## Harness Notes
|
|
117
83
|
|
|
118
|
-
###
|
|
84
|
+
### Open Agents
|
|
119
85
|
|
|
120
|
-
|
|
86
|
+
- upstream: [vercel-labs/open-agents](https://github.com/vercel-labs/open-agents)
|
|
87
|
+
- secure auth mode support: `none`, `api-key`, `vercel-managed`
|
|
88
|
+
- prompt/chat commands: `growthub open-agents prompt`, `growthub open-agents chat`
|
|
121
89
|
|
|
122
|
-
|
|
123
|
-
growthub template
|
|
124
|
-
growthub template list
|
|
125
|
-
growthub template list --type ad-formats
|
|
126
|
-
growthub template list --type scene-modules --subtype hooks
|
|
127
|
-
growthub template get villain-animation
|
|
128
|
-
growthub template get meme-overlay --out ~/kit/hooks/
|
|
129
|
-
growthub template get villain-animation --json
|
|
130
|
-
```
|
|
90
|
+
### Qwen Code CLI
|
|
131
91
|
|
|
132
|
-
|
|
92
|
+
- upstream: [QwenLM/qwen-code](https://github.com/QwenLM/qwen-code)
|
|
93
|
+
- secure local key setup from `growthub qwen-code` configure flow
|
|
94
|
+
- prompt/chat session commands: `growthub qwen-code prompt`, `growthub qwen-code session`
|
|
133
95
|
|
|
134
|
-
|
|
135
|
-
2. Preview the selected artifact.
|
|
136
|
-
3. Print it, copy it to a local workspace, or use the slug in another workflow.
|
|
96
|
+
## Extension Model
|
|
137
97
|
|
|
138
|
-
|
|
98
|
+
Content extensions:
|
|
139
99
|
|
|
140
|
-
|
|
100
|
+
- worker kits: `cli/assets/worker-kits/`
|
|
101
|
+
- shared templates: `cli/assets/shared-templates/`
|
|
141
102
|
|
|
142
|
-
|
|
143
|
-
growthub workflow
|
|
144
|
-
growthub workflow saved
|
|
145
|
-
growthub pipeline assemble
|
|
146
|
-
```
|
|
147
|
-
|
|
148
|
-
### 5. Hosted Auth Bridge
|
|
149
|
-
|
|
150
|
-
Use this when you want the hosted Growthub account to remain the top-level identity while syncing safe local-machine metadata into the CLI runtime.
|
|
151
|
-
|
|
152
|
-
```bash
|
|
153
|
-
growthub auth login
|
|
154
|
-
growthub auth whoami
|
|
155
|
-
growthub auth logout
|
|
156
|
-
growthub profile status
|
|
157
|
-
growthub profile pull
|
|
158
|
-
growthub profile push
|
|
159
|
-
```
|
|
160
|
-
|
|
161
|
-
Contract:
|
|
162
|
-
|
|
163
|
-
1. Hosted Growthub auth remains the source of truth for the user identity.
|
|
164
|
-
2. Local workspace config stays local-first and is not overwritten by hosted state.
|
|
165
|
-
3. Hosted machine linkage is stored separately from `instances/<id>/config.json`.
|
|
166
|
-
4. `growthub` and `paperclipai` remain intentional side-by-side surfaces rather than auto-loading one another.
|
|
167
|
-
|
|
168
|
-
## Workflows Discovery V1
|
|
169
|
-
|
|
170
|
-
The public CLI now supports a hosted workflow discovery flow inside the interactive hub for all Growthub Auth Users:
|
|
171
|
-
|
|
172
|
-
```bash
|
|
173
|
-
growthub discover
|
|
174
|
-
growthub workflow
|
|
175
|
-
growthub workflow saved
|
|
176
|
-
```
|
|
177
|
-
|
|
178
|
-
Use this when you want to:
|
|
179
|
-
|
|
180
|
-
- inspect CMS node contracts from the interactive contracts browser
|
|
181
|
-
- list hosted saved workflows and inspect detail
|
|
182
|
-
- create/save hosted workflows through Dynamic Pipelines
|
|
183
|
-
- execute a hosted saved workflow from the CLI
|
|
184
|
-
- manage workflow lifecycle actions (archive/delete) from CLI
|
|
185
|
-
|
|
186
|
-
The full public usage and architecture notes live here:
|
|
103
|
+
Governance/reference docs:
|
|
187
104
|
|
|
105
|
+
- [Worker Kits](../docs/WORKER_KITS.md)
|
|
188
106
|
- [CLI Workflows Discovery V1](../docs/CLI_WORKFLOWS_DISCOVERY_V1.md)
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
The CLI has two extension surfaces for content:
|
|
193
|
-
|
|
194
|
-
- worker kits in `cli/assets/worker-kits/`
|
|
195
|
-
- shared templates in `cli/assets/shared-templates/`
|
|
196
|
-
|
|
197
|
-
Use shared templates for reusable cross-kit primitives. Use worker kits for full opinionated environments with prompts, standards, examples, and runtime assumptions.
|
|
198
|
-
|
|
199
|
-
For the agent-facing extension workflow, see [docs/CLI_TEMPLATE_CONTRIBUTION_EXTENSION_WORKFLOWS.md](../docs/CLI_TEMPLATE_CONTRIBUTION_EXTENSION_WORKFLOWS.md).
|
|
200
|
-
|
|
201
|
-
## Development Notes
|
|
202
|
-
|
|
203
|
-
- `@growthub/cli` version: `0.3.49`
|
|
204
|
-
- Node.js: `>=20`
|
|
205
|
-
- Source of truth repo: [Growthub Local](https://github.com/Growthub-ai/growthub-local)
|
|
107
|
+
- [Agent Harness Auth Primitive](../docs/AGENT_HARNESS_AUTH_PRIMITIVE.md)
|
|
108
|
+
- [Kernel Packet Registry](../docs/kernel-packets/README.md)
|
|
206
109
|
|
|
207
110
|
## Links
|
|
208
111
|
|
|
209
|
-
- [
|
|
112
|
+
- [Growthub Local Repository](https://github.com/Growthub-ai/growthub-local)
|
|
113
|
+
- [Root README](https://github.com/Growthub-ai/growthub-local#readme)
|
|
210
114
|
- [Contributing](https://github.com/Growthub-ai/growthub-local/blob/main/CONTRIBUTING.md)
|
|
211
|
-
- [Growthub Authentication Bridge](https://github.com/Growthub-ai/growthub-local/blob/main/docs/GROWTHUB_AUTH_BRIDGE.md)
|
|
212
|
-
- [CLI Workflows Discovery V1](https://github.com/Growthub-ai/growthub-local/blob/main/docs/CLI_WORKFLOWS_DISCOVERY_V1.md)
|
|
213
|
-
- [Worker Kits](https://github.com/Growthub-ai/growthub-local/blob/main/docs/WORKER_KITS.md)
|
|
214
|
-
- [CLI Template Contribution Extension Workflows](https://github.com/Growthub-ai/growthub-local/blob/main/docs/CLI_TEMPLATE_CONTRIBUTION_EXTENSION_WORKFLOWS.md)
|