genclass 0.2.3 → 0.3.1
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/CHANGELOG.md +62 -0
- package/README.md +128 -13
- package/dist/genclass.mjs +3792 -1362
- package/package.json +2 -2
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,67 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.3.1
|
|
4
|
+
|
|
5
|
+
- **`genclass login` renews a sign-in that 0.3.0 asks to renew.** A sign-in approved before 0.3.0 can show
|
|
6
|
+
dashboards but not the plan, alerts, stored events or questions, and the command says "run npx genclass login
|
|
7
|
+
once". `login` only looked at whether the sign-in could show dashboards, so for such a sign-in it answered
|
|
8
|
+
"already signed in", which was a dead end for anyone not at a prompt that signs in on Enter. It now asks the
|
|
9
|
+
server the newest thing a terminal is approved for, and signs in again when the answer is "sign in again". Found
|
|
10
|
+
the first time 0.3.0 met a real older sign-in in production.
|
|
11
|
+
|
|
12
|
+
## 0.3.0
|
|
13
|
+
|
|
14
|
+
The command becomes the whole product in a terminal. Until now it set GenClass up and ended; what the dashboard
|
|
15
|
+
shows, and everything an account can do, needed the browser.
|
|
16
|
+
|
|
17
|
+
- **It stays open.** When the walk is done, or left with `q`, the command asks what next: type a command
|
|
18
|
+
(`problems`, `analytics`, `fix`, ...) or a sentence, which is a question about your app. `q` leaves. Inside it a
|
|
19
|
+
view is not headed again by the card. A command typed whole, as a screen printed it (`npx genclass fix`), works
|
|
20
|
+
there too.
|
|
21
|
+
- **Just `genclass`.** `npx genclass` runs without installing, so `genclass` alone was "command not found". The
|
|
22
|
+
first time the home opens, the command offers to install itself (`npm install -g genclass`, shown first, asked
|
|
23
|
+
once, never in CI or with `--yes`). Once `genclass` is on the PATH every screen says `genclass` instead of
|
|
24
|
+
`npx genclass`.
|
|
25
|
+
- **Every part of the dashboard.** `problems` (by kind, by page, each kind on each page, the measured visual
|
|
26
|
+
checks, what GenClass stopped on the visitor's screen, the change on the period before), `analytics` (visits,
|
|
27
|
+
page views, time on a page, pages, sources and campaigns, devices, browsers, systems, countries, new and
|
|
28
|
+
returning, clicks, rage clicks and dead clicks, paths, entry and exit pages, funnels; one part in full with
|
|
29
|
+
`analytics pages` and so on), `events` (the latest 50 as stored, with mode and trigger under `--all`), `health`
|
|
30
|
+
(model loads, where it ran, decision time, what was not checked, load errors, the visual checks' coverage, runtime
|
|
31
|
+
versions; `--all` adds every breakdown), `report` (the dashboard's Copy as Markdown), `export` (every stored
|
|
32
|
+
event as JSON Lines or CSV, page by page into one file). All of them fit a 58-column window, take `--range`,
|
|
33
|
+
`--app`, `--all` and `--json`, and follow the plan's rules like the browser does.
|
|
34
|
+
- **`fix`: the problems, handed to your coding agent.** The list, a pick (a number, a kind, or all), and Enter starts
|
|
35
|
+
Claude Code, Codex, Cursor's agent or Gemini CLI in the project with the dashboard's own prompt for it: what, where,
|
|
36
|
+
the usual fix, and the steps that reproduce it and prove the fix with GenClass's MCP server. `c` copies, `p`
|
|
37
|
+
prints, `--print` prints and nothing else. GenClass changes no code and starts nothing without a key press.
|
|
38
|
+
- **`ask`: talk to it.** A question in plain words is answered by genclass.dev's model from the app's dashboard
|
|
39
|
+
numbers; a follow-up carries the turn before it. Only the question leaves the machine; the first time, the command
|
|
40
|
+
says what goes to the model and waits for Enter. It shares a plan's daily model runs with `suggest`.
|
|
41
|
+
- **The account's side.** `connections` (where alerts go: Slack, Sentry, PostHog, Datadog, a webhook; add, test,
|
|
42
|
+
turn off, remove, with what is typed never shown; plus the GitHub App, the coding agent and the private link),
|
|
43
|
+
`agent` (how the agent is connected here and what it did with the findings) and `agent link` (gives the agent the
|
|
44
|
+
live site's numbers, in your own agent settings, not in the repository), `funnels` (add and remove), `apps`
|
|
45
|
+
(list, new), `plan` (limits, what is used, what the plan leaves out, and Enter to start the paid plan), `team`
|
|
46
|
+
(who is on it, an invite link).
|
|
47
|
+
- **A plan is chosen at the start of the setup.** For an account on Free the step after the sign-in shows the paid
|
|
48
|
+
plan, large, with its price and what it adds; Enter opens its checkout in the browser (one click less: the page
|
|
49
|
+
goes straight to Stripe), `f` is "Try free for now (limited)". Asked once per project.
|
|
50
|
+
- **What a terminal may do is listed where it is approved.** The sign-in page now lists it line by line, and what
|
|
51
|
+
it never can: change how you sign in, pay, remove people, delete an app or the account. A sign-in from before
|
|
52
|
+
this version was approved for less: the first command that needs more says so and signs in again on Enter.
|
|
53
|
+
- Notes and lists no longer run two columns past a 58-column window; a share of almost all is no longer rounded up
|
|
54
|
+
to "100%"; two apps with the same name can be told apart (`--app <id>`).
|
|
55
|
+
|
|
56
|
+
## 0.2.4
|
|
57
|
+
|
|
58
|
+
- **A repository that was renamed on GitHub is found under its new name.** A checkout cloned before a rename still
|
|
59
|
+
carries the old name in its remote, and genclass.dev knows the repository by the current one, so the GitHub App
|
|
60
|
+
step said "not on acme/shop-old yet" for an app that was installed and reviewing. When the server answers "not
|
|
61
|
+
installed", the command asks github.com where the old address leads now (one HEAD request, public repositories
|
|
62
|
+
only) and asks again under that name. The step's details say the new name and the line that updates the remote.
|
|
63
|
+
Found on GenClass's own repository the first time the step was run against GitHub.
|
|
64
|
+
|
|
3
65
|
## 0.2.3
|
|
4
66
|
|
|
5
67
|
From using the command on a real site the morning after 0.2.2, and from watching its owner use it:
|
package/README.md
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
# genclass
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
GenClass in your terminal: one command that sets it up, shows what it finds on your live site, has it fixed, and
|
|
4
|
+
answers questions about your app.
|
|
4
5
|
|
|
5
6
|
```bash
|
|
6
7
|
npx genclass
|
|
@@ -10,7 +11,7 @@ Run it in your web app's folder. It shows where the project stands and walks you
|
|
|
10
11
|
per step. Stop at any point and run it again: it continues from what is true now.
|
|
11
12
|
|
|
12
13
|
```text
|
|
13
|
-
╭─ GenClass ────────────────────────────────────────────── v0.
|
|
14
|
+
╭─ GenClass ────────────────────────────────────────────── v0.3.0 ─╮
|
|
14
15
|
│ │
|
|
15
16
|
│ Welcome back, Ada! │
|
|
16
17
|
│ │
|
|
@@ -38,21 +39,48 @@ per step. Stop at any point and run it again: it continues from what is true now
|
|
|
38
39
|
▎ One new file, .github/workflows/genclass.yml.
|
|
39
40
|
|
|
40
41
|
────────────────────────────────────────────────────────────────────
|
|
41
|
-
❯ Enter to continue · d every part · s skip · q
|
|
42
|
+
❯ Enter to continue · d every part · s skip · q later
|
|
42
43
|
```
|
|
43
44
|
|
|
44
45
|
The view stays that short. Press `d` (or run `npx genclass status --all`) to see every part with what is known about
|
|
45
46
|
it, and `d` again to fold it back.
|
|
46
47
|
|
|
48
|
+
## It stays open
|
|
49
|
+
|
|
50
|
+
When the walk is done (or you press `q` to leave it for later), the command does not end. It asks what next:
|
|
51
|
+
|
|
52
|
+
```text
|
|
53
|
+
What next? A command, or a question about your app.
|
|
54
|
+
dashboard what GenClass found on your live site
|
|
55
|
+
problems every problem, by kind and page
|
|
56
|
+
analytics visitors, pages, sources, clicks
|
|
57
|
+
events the latest events, one per line
|
|
58
|
+
fix hand a problem to your coding agent
|
|
59
|
+
ask ask about your app (or just type it)
|
|
60
|
+
connections alerts, GitHub, your coding agent
|
|
61
|
+
suggest what your app is missing
|
|
62
|
+
help every command q leave
|
|
63
|
+
|
|
64
|
+
❯ which page loses the most visitors?
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
Type a command, or a sentence: a sentence is a question about your app. `q` leaves. Everything here is also a
|
|
68
|
+
command of its own (`npx genclass problems`), so scripts and coding agents use the same things.
|
|
69
|
+
|
|
70
|
+
**Just `genclass`.** `npx` runs the command without installing it, so `genclass` alone is not a command yet. The
|
|
71
|
+
first time the home opens it offers to install it (`npm install -g genclass`, shown before it runs, asked once).
|
|
72
|
+
After that you type `genclass`, and every screen says `genclass` instead of `npx genclass`.
|
|
73
|
+
|
|
47
74
|
## Every part, in order
|
|
48
75
|
|
|
49
76
|
| Part | What the step does | What it changes |
|
|
50
77
|
|---|---|---|
|
|
51
78
|
| Account | Opens genclass.dev in your browser; you approve a short code there. | A session file in your user config folder. Nothing is typed in the terminal. |
|
|
79
|
+
| Plan | On Free, shows the paid plan first: Enter opens its checkout in your browser, `f` goes on with Free for now. Asked once per project. | Nothing in your project. The payment is on Stripe's page; the command never sees a card. |
|
|
52
80
|
| Runtime | Adds GenClass to the app: one import (or script tag) and the package. It watches the page in your users' browsers for lost edits, double submits and old data shown over new, and only reports, to the console and your dashboard. Nothing is drawn on your pages. | Your entry file and `package.json`; you see the change first. `genclass remove` undoes it. |
|
|
53
81
|
| Dashboard | Waits for your live site to be opened once. GenClass sends nothing from localhost. | Nothing. |
|
|
54
82
|
| Test workflow | Runs your Playwright tests once more per pull request with slow and reordered responses. | One new file, `.github/workflows/genclass.yml`, which you commit. |
|
|
55
|
-
| GitHub App | Comments on a pull request when a page ends up wrong, with the steps to see it. The command opens GitHub's install page and waits for the answer. | Nothing in your project. The app cannot read or change your code. |
|
|
83
|
+
| GitHub App | Comments on a pull request when a page ends up wrong, with the steps to see it. The command opens GitHub's install page and waits for the answer. A repository that was renamed on GitHub is looked up under its new name. | Nothing in your project. The app cannot read or change your code. |
|
|
56
84
|
| Coding agent | Gives Claude Code, Cursor and other agents GenClass's tools and its skill: ask what went wrong, replay it, check the fix. | `.mcp.json` (or `.cursor/mcp.json`) and `.claude/skills/genclass/SKILL.md`. |
|
|
57
85
|
| Suggestions | Tells you what your app is missing, most important first. | Nothing in your project. |
|
|
58
86
|
|
|
@@ -94,10 +122,81 @@ suggestions run left to do.
|
|
|
94
122
|
Suggestions 7 to do, 2 urgent · checked 2 days ago · npx genclass suggest
|
|
95
123
|
```
|
|
96
124
|
|
|
97
|
-
`--range 24h`, `7d` or `30d` picks the period, `--all` shows every row,
|
|
98
|
-
`--open` the browser dashboard, `--json` the same as data. These are the
|
|
99
|
-
shows, cut by the same plan rules.
|
|
100
|
-
|
|
125
|
+
`--range 24h`, `7d` or `30d` (a plan with more history: `90d`, `1y`) picks the period, `--all` shows every row,
|
|
126
|
+
`--app <name>` another app of your account, `--open` the browser dashboard, `--json` the same as data. These are the
|
|
127
|
+
numbers your dashboard on genclass.dev shows, cut by the same plan rules.
|
|
128
|
+
|
|
129
|
+
Each part of the browser dashboard has its own view, short first, `--all` for every row:
|
|
130
|
+
|
|
131
|
+
| | |
|
|
132
|
+
|---|---|
|
|
133
|
+
| `npx genclass problems` | what was found, by kind and by page, the measured visual checks, what GenClass stopped on the visitor's screen, how it compares with the period before |
|
|
134
|
+
| `npx genclass analytics` | visitors: visits, page views, time on a page, where people come from, devices and countries, what gets clicked again and again. One part in full: `analytics pages`, `sources`, `devices`, `clicks`, `paths`, `funnels` (Team) |
|
|
135
|
+
| `npx genclass events` | the latest events one per line: when, kind, how sure the model was, the page, and what GenClass did |
|
|
136
|
+
| `npx genclass health` | how GenClass itself runs on your pages: model loads, where it ran, decision time, what was not checked, runtime versions |
|
|
137
|
+
| `npx genclass report` | the period as Markdown, to paste or pipe (`--out report.md` writes a file) |
|
|
138
|
+
| `npx genclass export` | every stored event as a file, JSON Lines or `--format csv`, `--from` and `--to` as days (Team) |
|
|
139
|
+
|
|
140
|
+
## Have it fixed
|
|
141
|
+
|
|
142
|
+
```bash
|
|
143
|
+
npx genclass fix
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
It lists what GenClass found on your live site, you pick one (or Enter for all of them), and it starts your coding
|
|
147
|
+
agent in the project with a prompt: what was found, where, how it is usually fixed, and the steps that reproduce it
|
|
148
|
+
and prove the fix with GenClass's MCP server. Claude Code, Codex, Cursor's agent and Gemini CLI are started when
|
|
149
|
+
their command is installed; otherwise the prompt is copied (`c`) or printed (`p`).
|
|
150
|
+
|
|
151
|
+
GenClass changes no code. The agent does, in your own session with it, where you see and approve what it does.
|
|
152
|
+
Nothing starts without a key press. `npx genclass fix stale --print` prints the prompt for one kind and nothing
|
|
153
|
+
else, which is how an agent asks for it itself.
|
|
154
|
+
|
|
155
|
+
## Ask
|
|
156
|
+
|
|
157
|
+
```bash
|
|
158
|
+
npx genclass ask "what is going wrong on my site?"
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
A question in your own words, answered by GenClass's model from what the runtime found on your live site: pages,
|
|
162
|
+
kinds of problem and counts, and with visitor analytics the sources and what people click. In the home, just type
|
|
163
|
+
the question; a follow-up ("and on which page?") carries the turn before it.
|
|
164
|
+
|
|
165
|
+
**What leaves your machine:** the question. The numbers are read on genclass.dev, where they already are, and go to
|
|
166
|
+
the model (OpenAI's API) with it. No code, no file of your project. Neither the question nor the answer is stored.
|
|
167
|
+
The command says this before the first question and waits for Enter. Ask and suggest share a plan's model runs a
|
|
168
|
+
day (3 on Free, 30 on Team).
|
|
169
|
+
|
|
170
|
+
## Connections
|
|
171
|
+
|
|
172
|
+
```bash
|
|
173
|
+
npx genclass connections
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
Where your app's new problems are sent (Slack, Sentry, PostHog, Datadog, or a webhook of your own), what the GitHub
|
|
177
|
+
App is doing on the repository, whether your coding agent is connected, and whether the app has a private link.
|
|
178
|
+
|
|
179
|
+
- `npx genclass connections add slack` sets a destination up (Team). What you type is not shown, goes to
|
|
180
|
+
genclass.dev over HTTPS, is stored encrypted there and is not kept on your machine. Then `test`, `off`, `on`,
|
|
181
|
+
`remove` in place of `add`.
|
|
182
|
+
- `npx genclass agent` shows how your coding agent is connected and what it did with the findings (found,
|
|
183
|
+
reproduced, fix proven, closed). `npx genclass agent link` gives it the live site's numbers: it makes the app's
|
|
184
|
+
private dashboard link and hands it to GenClass's MCP server in your own agent settings, never in a file of the
|
|
185
|
+
repository.
|
|
186
|
+
- `npx genclass funnels add "Checkout" /cart /checkout /thanks` adds a funnel (Team); `funnels remove "Checkout"`
|
|
187
|
+
removes it.
|
|
188
|
+
|
|
189
|
+
## Account
|
|
190
|
+
|
|
191
|
+
`npx genclass apps` lists your apps (`apps new "Name"` makes one). `npx genclass plan` shows your plan, its limits
|
|
192
|
+
and what is used; on Free it shows the paid plan and Enter opens its checkout. `npx genclass team` shows who is on
|
|
193
|
+
the plan (`team invite` makes a single-use invite link).
|
|
194
|
+
|
|
195
|
+
**What a terminal may do** is listed on the page where you approve its sign-in, and nothing else: read your apps'
|
|
196
|
+
dashboards, analytics and stored events, ask the model, change where alerts go, funnels and the private link, show
|
|
197
|
+
the plan and the team and make an invite link. It cannot change how you sign in, pay for anything, remove people,
|
|
198
|
+
or delete an app or your account: those stay in the browser, and the command prints the address. A sign-in from
|
|
199
|
+
before 0.3.0 was approved for less, so the first command that needs more asks you to sign in once more.
|
|
101
200
|
|
|
102
201
|
## Suggestions
|
|
103
202
|
|
|
@@ -130,20 +229,33 @@ prompt) is shown for the first three items on Free and for all of them on Team,
|
|
|
130
229
|
|
|
131
230
|
## Commands
|
|
132
231
|
|
|
133
|
-
`npx` runs the command without installing it. To type just `genclass`, install it once: `npm install -g genclass
|
|
232
|
+
`npx` runs the command without installing it. To type just `genclass`, install it once: `npm install -g genclass`
|
|
233
|
+
(the command offers to, the first time its home opens).
|
|
134
234
|
|
|
135
235
|
| | |
|
|
136
236
|
|---|---|
|
|
137
|
-
| `npx genclass` | where the project stands; on a terminal, the next step |
|
|
237
|
+
| `npx genclass` | where the project stands; on a terminal, the next step, then the home |
|
|
138
238
|
| `npx genclass setup` | the guided setup (`--yes`: no questions) |
|
|
139
239
|
| `npx genclass status` | what is done and what is next (`--all`: every part; `--json`) |
|
|
140
|
-
| `npx genclass
|
|
141
|
-
| `npx genclass
|
|
240
|
+
| `npx genclass dashboard` | your app in the terminal (`--open` the browser dashboard) |
|
|
241
|
+
| `npx genclass problems` | every problem found, by kind and page, and what GenClass did |
|
|
242
|
+
| `npx genclass analytics [part]` | visitors; parts: `pages`, `sources`, `devices`, `clicks`, `paths`, `funnels` |
|
|
243
|
+
| `npx genclass events` | the latest events, one per line |
|
|
244
|
+
| `npx genclass health` | how GenClass itself runs on your pages |
|
|
245
|
+
| `npx genclass report` | the period as Markdown (`--out <file>`) |
|
|
246
|
+
| `npx genclass export` | every stored event as a file (`--from`, `--to`, `--format csv`, `--out`) |
|
|
247
|
+
| `npx genclass fix [number, kind or all]` | hand a problem to your coding agent (`--print`, `--copy`, `--agent <name>`) |
|
|
248
|
+
| `npx genclass ask "..."` | a question about your app, answered from its numbers |
|
|
249
|
+
| `npx genclass suggest [url]` | what your app is missing (`--yes`, `--no-model`, `--all`) |
|
|
142
250
|
| `npx genclass scan <url>` | 23 visual checks on one page |
|
|
251
|
+
| `npx genclass connections` | alerts, GitHub App, coding agent (`add`, `test`, `on`, `off`, `remove` a destination) |
|
|
252
|
+
| `npx genclass agent` | your coding agent and what it did (`agent link`) |
|
|
253
|
+
| `npx genclass funnels` | funnels (`add "Name" /a /b`, `remove "Name"`) |
|
|
254
|
+
| `npx genclass apps`, `plan`, `team` | your apps, your plan, the people on it |
|
|
143
255
|
| `npx genclass login`, `logout`, `whoami` | your account |
|
|
144
256
|
| `npx genclass remove` | take GenClass out of the app again |
|
|
145
257
|
|
|
146
|
-
Options
|
|
258
|
+
Options: `--app <name>`, `--range 24h|7d|30d|90d|1y`, `--all`, `--json`, `--cwd <dir>`, `--yes`, `--no-browser`.
|
|
147
259
|
|
|
148
260
|
## For coding agents
|
|
149
261
|
|
|
@@ -154,6 +266,9 @@ npx genclass status --json # where things stand, and "next": the command to
|
|
|
154
266
|
npx genclass setup --yes # does every step that needs no person; prints the links for the ones that do
|
|
155
267
|
npx genclass suggest --json # the checks that failed, with evidence, in order
|
|
156
268
|
npx genclass dashboard --json # what GenClass found on the live site
|
|
269
|
+
npx genclass problems --json # the same by kind and page; also analytics, events, health, agent
|
|
270
|
+
npx genclass fix --print # the prompt to fix what was found (fix stale --print: one kind)
|
|
271
|
+
npx genclass report # the period as Markdown
|
|
157
272
|
```
|
|
158
273
|
|
|
159
274
|
Two steps need the person: approving the sign-in and installing the GitHub App. Both happen in their browser, and
|