vybekiit 0.1.0 → 0.5.0

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 CHANGED
@@ -1,19 +1,31 @@
1
+ <p align="center">
2
+ <img src="https://raw.githubusercontent.com/VybeKiit/vybekiit/main/assets/brand/vybekiit-profile.svg" width="160" height="160" alt="VybeKiit logo">
3
+ </p>
4
+
1
5
  # vybekiit
2
6
 
3
- Scaffold a VybeKiit template into your own repo, then build it by describing what you
4
- want to your AI coding agent (Claude Code, Codex, or Cursor) it does the heavy lift.
7
+ Scaffold a VybeKiit kit workspace into your own folder, then build by describing what you
8
+ want to your AI coding agent (Claude Code, Codex, or Cursor). It does the heavy lift.
5
9
 
6
10
  ## Get started
7
11
 
12
+ After you purchase and accept the GitHub invite:
13
+
8
14
  ```sh
9
- npx vybekiit new web my-app
15
+ npx vybekiit setup
16
+ npx vybekiit create app --web
10
17
  ```
11
18
 
12
- This creates `my-app/` from the `web` template. Open the folder in your AI coding tool
13
- and tell it `"Set up my app."` — the agent reads its instructions and walks you through
14
- the rest one step at a time.
19
+ Or run `npx vybekiit` in a terminal for the interactive menu.
20
+
21
+ `create app --web|--mobile|--extension` builds a **kit workspace** (shared pieces + that
22
+ surface), not an app-only folder. Open the folder in your AI coding tool and say
23
+ `"Set up my app."` — the agent walks you through the rest one step at a time.
24
+
25
+ You do **not** need Download ZIP or the green Code button on GitHub for day-one setup.
15
26
 
16
- Before your first build, install and check the tools your app needs:
27
+ `setup` / `doctor` install and check the full toolchain (agents, `gh`, cloud CLIs, skills,
28
+ assistant tools):
17
29
 
18
30
  ```sh
19
31
  vybekiit doctor
@@ -24,7 +36,7 @@ vybekiit doctor
24
36
  | Layer | Tools |
25
37
  | ----- | ----- |
26
38
  | Agent | `claude` (Claude Code), `codex` (OpenAI Codex), `skills` (platform skills installer) |
27
- | Base | `gh` (download templates + GitHub login) |
39
+ | Base | `gh` (download kit + GitHub login) |
28
40
  | Default cloud | `supabase` (database), `wrangler` (hosting) |
29
41
  | When configured | `aws`, `gcloud` (Google sign-in), `vercel`, `eas` + `launch` (mobile) |
30
42
 
@@ -35,22 +47,34 @@ doctor installs and checks `gcloud` auth.
35
47
  ## Commands
36
48
 
37
49
  ```
38
- vybekiit new <template> [directory] Scaffold a template into your own repo
39
- vybekiit doctor Set up + check the tools your app needs
40
- vybekiit sync-agent-layer [template] Refresh agent instructions from the latest mirror
50
+ vybekiit setup Welcome + full doctor + next step
51
+ vybekiit create app --web|--mobile|--extension [dir]
52
+ vybekiit doctor Full toolchain pass
53
+ vybekiit sync-agent-layer [template] Refresh agent instructions
41
54
 
42
- -h, --help Show help
55
+ -h, --help Buyer help
56
+ --help --all Full command list
43
57
  -v, --version Show the CLI version
44
58
  ```
45
59
 
46
60
  Examples:
47
61
 
48
62
  ```sh
49
- vybekiit new web my-app
50
- vybekiit new web .
63
+ vybekiit setup
64
+ vybekiit create app --web my-app
65
+ vybekiit create app --mobile
51
66
  vybekiit doctor
52
67
  ```
53
68
 
69
+ `vybekiit new` is deprecated; use `create app` instead.
70
+
71
+ ## Maintainer contract
72
+
73
+ CLI command cores should return a structured result and let the entrypoint render once. Human output
74
+ goes to the normal terminal renderer; `--json` writes stable JSON to stdout; logs and status messages
75
+ stay on stderr or are suppressed for JSON mode. Prompt code belongs behind the interactive boundary
76
+ (`@clack/prompts`), never inside command core logic.
77
+
54
78
  ### Templates
55
79
 
56
80
  | Template | Stack | Status |
@@ -64,12 +88,13 @@ follows to set up, build, and ship your app.
64
88
 
65
89
  ## How delivery works
66
90
 
67
- Templates are proprietary and live in private per-template mirror repos; the published
68
- npm package ships **no** template files. When you run `vybekiit new`, the CLI clones the
69
- template you've purchased access to using GitHub's `gh` CLI one browser login, no
70
- tokens to create or paste. The copied project starts as a fresh repo (the mirror's git
71
- history is not carried over), and any `@vybekiit/*` workspace dependencies are rewritten
72
- to pinned npm versions so it builds on its own.
91
+ The paid product lives in gated private repos. The public npm package ships **no** template
92
+ files. When you run `create app`, the CLI uses GitHub's `gh` tool to download the gated
93
+ **kit** workspace (`VybeKiit/kit`: packages + templates), then writes your app folder.
94
+ One browser login via `gh auth login --web` no tokens to create or paste.
95
+
96
+ Template-only mirrors (`web` / `mobile` / `extension`) remain for advanced flows; day-one
97
+ buyers always get a kit workspace so shared pieces resolve locally.
73
98
 
74
99
  If you haven't signed in yet, the CLI tells you exactly what to run:
75
100
  `gh auth login --web`. `doctor` installs `gh` for you.
package/dist/bin.js ADDED
@@ -0,0 +1,7 @@
1
+ #!/usr/bin/env node
2
+ import {
3
+ runBinEntrypoint
4
+ } from "./chunk-HFT4CUOY.js";
5
+ export {
6
+ runBinEntrypoint
7
+ };