@grum-os/cli 0.3.51 → 0.3.53
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 +24 -9
- package/content.md5 +1 -1
- package/grum.mjs +684 -377
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -16,12 +16,13 @@ Open a terminal in the repository, and run with no arguments:
|
|
|
16
16
|
npx @grum-os/cli
|
|
17
17
|
```
|
|
18
18
|
|
|
19
|
-
Grum opens a wizard. The arrow keys move, Enter selects, and 1
|
|
19
|
+
Grum opens a wizard. The arrow keys move, Enter selects, and 1 to 4 jump straight to a row. `q` quits the menu. After you pick a row, `c` cancels that command and returns to the menu.
|
|
20
20
|
|
|
21
21
|
```text
|
|
22
|
-
1
|
|
23
|
-
2
|
|
24
|
-
3
|
|
22
|
+
1 Check Check your changes against the design contract
|
|
23
|
+
2 Quick wins Pick and run the latest scan's quick wins
|
|
24
|
+
3 Setup Sign in, link this repository, set up Cursor
|
|
25
|
+
4 Login Sign in to Grum
|
|
25
26
|
```
|
|
26
27
|
|
|
27
28
|
Choose **setup**. Grum walks through the rest:
|
|
@@ -32,11 +33,24 @@ Choose **setup**. Grum walks through the rest:
|
|
|
32
33
|
|
|
33
34
|
Then choose **check**. New drift is listed with a one-line fix, and Grum offers to send each item for review. You do not need to type a command for any of that.
|
|
34
35
|
|
|
35
|
-
Once you are signed in, the
|
|
36
|
+
Once you are signed in, the last row is **Logout**. Run `grum` again and choose **setup** to change the link or turn Cursor off. Enter keeps each current setting.
|
|
36
37
|
|
|
37
38
|
## Rescan a workspace
|
|
38
39
|
|
|
39
|
-
After changing code, run `grum scan` in the linked repository to start a fresh server-side scan and follow its progress in the terminal. Add `--root <dir>` when the workspace is a folder inside a monorepo. The scan runs in Grum and may take a few minutes. Ctrl+C stops waiting, but the scan keeps running. Only workspace owners can start scans.
|
|
40
|
+
After changing code, run `grum scan` in the linked repository to start a fresh server-side scan and follow its progress in the terminal. Add `--root <dir>` when the workspace is a folder inside a monorepo. The scan runs in Grum and may take a few minutes. Ctrl+C stops waiting, but the scan keeps running. Only workspace owners can start scans. When the scan finishes, Grum lists its [quick wins](#quick-wins).
|
|
41
|
+
|
|
42
|
+
## Quick wins
|
|
43
|
+
|
|
44
|
+
After setup and after each scan, Grum lists a few quick wins: the changes from the latest scan that make the biggest difference with little effort, such as missing design guidelines or hand-typed values that already match a token. They are the same items as the Quick wins list in Grum, without the ones your team dismissed there.
|
|
45
|
+
|
|
46
|
+
Choose **quick wins** in the menu (or run `grum wins`) to pick which ones to do, then where to send them: Claude Code or Codex start right there with the prompt, Cursor opens with it in the chat box, or copy or print it. Several picks go as one prompt, done one at a time. When one holds a draft (for example, when to use each button style), the agent shows it to you to correct first.
|
|
47
|
+
|
|
48
|
+
```sh
|
|
49
|
+
grum wins # pick and send them
|
|
50
|
+
grum wins 2 # print the prompt for the second one
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
In Claude Code and Cursor, type `/quick-wins`, or just ask for "quick wins". Codex has no project commands, so ask it for "quick wins". The agent shows the list and asks which ones to do.
|
|
40
54
|
|
|
41
55
|
## Set up with your agent
|
|
42
56
|
|
|
@@ -177,7 +191,7 @@ grum request "color:raw:#3C3C3C" \
|
|
|
177
191
|
|
|
178
192
|
Captures default to the local app. Use `grum request <key> [<key>...] --live` to capture the configured live site after a release. Grum uses the route identified by the finding's source file when it can, otherwise the site's configured URL. This leaves the saved local-app URL unchanged and adds no confirmation prompt. The target URL is printed before capture.
|
|
179
193
|
|
|
180
|
-
`--url` is the page where the element renders, or an HTML file in the repo (`./index.html`) when there is no dev server. An explicit `--url` takes priority over `--live`, including when a shared component needs a specific page. A page behind a login is captured through the
|
|
194
|
+
`--url` is the page where the element renders, or an HTML file in the repo (`./index.html`) when there is no dev server. An explicit `--url` takes priority over `--live`, including when a shared component needs a specific page. A page behind a login is captured through the browser extension in your own browser session. `--browser chrome` or `--browser safari` picks the browser. `--no-capture` sends the request with no picture. For a modal finding, `--open-modal-id <id>` and `--open-trigger-id <id>` explicitly identify the requested modal and its opener. The existing **Scan for review** action opens the requested modal if needed, then captures it. If the modal is already visible, it captures without clicking the opener. It clicks only one unique, visible, enabled button with that id, then captures only after the requested modal is observed open. Submit controls, missing or duplicate ids, and clients without opening support are refused; manual opening and scan retry remain available.
|
|
181
195
|
|
|
182
196
|
```sh
|
|
183
197
|
grum capture reset
|
|
@@ -191,7 +205,7 @@ Clears the capture-browser sign-in saved for this repository.
|
|
|
191
205
|
grum contract
|
|
192
206
|
```
|
|
193
207
|
|
|
194
|
-
Prints the contract packet agents read before writing UI: tokens by category (with a separate dark value when there is one), button components and looks, approved text inputs, checkboxes, radios, switches, selects, action menus and tabs, team guidelines, and review decisions.
|
|
208
|
+
Prints the contract packet agents read before writing UI: tokens by category (with a separate dark value when there is one), button components and looks, approved text inputs, checkboxes, radios, switches, selects, action menus and tabs, team guidelines, quick wins, and review decisions.
|
|
195
209
|
|
|
196
210
|
## Fail the check
|
|
197
211
|
|
|
@@ -257,13 +271,14 @@ The menu covers check, setup, and sign-in. These are the same actions as flags,
|
|
|
257
271
|
| `grum doctor [--agent <agent> --json]` | Check setup readiness without changing anything. |
|
|
258
272
|
| `grum scan [--root <dir>]` | Start a fresh scan for the linked workspace and follow its progress. |
|
|
259
273
|
| `grum check [flags]` | Check the working tree. See the flags below. |
|
|
260
|
-
| `grum request <key> [<key>...] [--reason "..."] [--url <page>] [--live] [--browser chrome | safari] [--no-capture]`
|
|
274
|
+
| `grum request <key> [<key>...] [--reason "..."] [--url <page>] [--live] [--browser chrome | safari] [--open-modal-id <id> --open-trigger-id <id>] [--no-capture]` | Ask the owners to allow drift items; items on one page capture together. |
|
|
261
275
|
| `grum add-token ...` / `grum add-button ...` | For owners, add a token or approved button design to the contract. |
|
|
262
276
|
| `grum add-icon <ref> [--name <name>]` | For owners, add an icon `grum check --json` lists under `discovered.icons`, from this checkout's source. |
|
|
263
277
|
| `grum snooze <key> [<key>...]` | Pause questions about existing drift on this branch for the configured period. |
|
|
264
278
|
| `grum uninstall [--yes]` | Remove Grum from this repository and this computer. See [Uninstall](#uninstall). |
|
|
265
279
|
| `grum capture reset` | Clear this repository's saved capture-browser sign-ins. |
|
|
266
280
|
| `grum contract` | Print the contract packet. |
|
|
281
|
+
| `grum wins [<number>]` | Pick quick wins and send them to your agent, or print one's prompt. See [Quick wins](#quick-wins). |
|
|
267
282
|
| `grum feedback "<what happened>" [--kind <kind>]` | Tell the Grum team about a question, confusion or problem. `<kind>` is `question`, `confused`, `problem` or `idea`. If Grum can't be reached it waits and goes with the next send. |
|
|
268
283
|
| `grum init cursor [--remove] [--force] [--local-only] [--pre-commit]` | Write or remove the Cursor files without the menu. `--pre-commit` adds the commit check. `--no-pre-commit` removes it. |
|
|
269
284
|
| `grum init codex [--remove] [--force] [--local-only] [--pre-commit]` | The same for Codex: `.codex/config.toml`, `.codex/hooks.json` and the `AGENTS.md` block. |
|
package/content.md5
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
|
|
1
|
+
09b4f300f627f37b3f606da766d2ee90
|