gigaplan 0.1.0 → 0.1.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.
Files changed (2) hide show
  1. package/README.md +21 -23
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -7,6 +7,9 @@ sections with per-step inline comments, a review-coverage sidebar, and a
7
7
  finish-your-review panel (Approve / Approve with comments / Request changes),
8
8
  then hands the structured feedback back to the agent to act on.
9
9
 
10
+ [gigaplan on npm](https://www.npmjs.com/package/gigaplan) ·
11
+ [gigaplan on skills.sh](https://www.skills.sh/corradodellorusso/gigaplan/gigaplan)
12
+
10
13
  The UI follows the "Atelier / Terminal" design system (warm-paper light theme,
11
14
  phosphor-terminal dark theme, Bricolage Grotesque + JetBrains Mono type) —
12
15
  see `skills/gigaplan/SKILL.md` for the review workflow and `public/chrome.css`
@@ -14,49 +17,40 @@ for the theme itself.
14
17
 
15
18
  ## Getting started
16
19
 
17
- gigaplan isn't published to npm yet, so for now it runs from a local checkout
18
- of this repo:
20
+ No install needed try it against any Markdown file:
19
21
 
20
22
  ```
21
- npm install # also builds it — see the `prepare` script
22
- ```
23
-
24
- Try it against any Markdown file:
25
-
26
- ```
27
- node bin/gigaplan.js review path/to/plan.md
23
+ npx -y gigaplan review path/to/plan.md
28
24
  ```
29
25
 
30
26
  That opens your browser straight to the review page. Leave a few comments,
31
27
  pick a verdict, and submit — then, in a second terminal:
32
28
 
33
29
  ```
34
- node bin/gigaplan.js poll path/to/plan.md
30
+ npx -y gigaplan poll path/to/plan.md
35
31
  ```
36
32
 
37
33
  blocks until you do, then prints back exactly the compact-markdown feedback an
38
- agent would read. `gigaplan end path/to/plan.md` marks the session done
34
+ agent would read. `npx -y gigaplan end path/to/plan.md` marks the session done
39
35
  afterward (the shared local server itself stays running independently — see
40
36
  Configuration below).
41
37
 
42
- Optionally, run `npm link` once if you'd rather type the bare `gigaplan`
43
- command than the `node bin/gigaplan.js` prefix.
44
-
45
38
  ### Installing the skill
46
39
 
47
40
  The point of gigaplan is for an *agent* — any agent, not tied to one product —
48
41
  to drive this loop on your behalf: write the plan, open it for you, wait for
49
42
  your review, and revise based on your comments, looping until you approve it.
50
- Install `skills/gigaplan/SKILL.md` via skills.sh so it's picked up
51
- automatically, without you needing to invoke anything by name.
43
+ Install the skill so it's picked up automatically, without you needing to
44
+ invoke anything by name:
45
+
46
+ ```
47
+ npx skills add https://github.com/corradodellorusso/gigaplan --skill gigaplan
48
+ ```
49
+
52
50
  `skills/gigaplan/SKILL.md` documents the exact workflow and CLI contract an
53
51
  agent follows — read it if you want to know precisely what happens under the
54
52
  hood.
55
53
 
56
- Once gigaplan is published, `npx -y gigaplan ...` per command replaces the
57
- local-checkout commands above — no local build needed, matching what the
58
- skill already documents.
59
-
60
54
  ## How it works
61
55
 
62
56
  ```
@@ -85,9 +79,6 @@ gigaplan end <path> Mark the review session done (the shared local server s
85
79
  it shuts itself down after a period of inactivity).
86
80
  ```
87
81
 
88
- Locally (pre-publish), that's `node bin/gigaplan.js <command>` unless you've
89
- `npm link`-ed it (see Getting started).
90
-
91
82
  ## Configuration
92
83
 
93
84
  | Env var | Default | Purpose |
@@ -99,6 +90,13 @@ State (session records and the server's pid/port lock) lives in `~/.gigaplan/`.
99
90
 
100
91
  ## Contributing
101
92
 
93
+ Working from a local checkout instead of the published package:
94
+
95
+ ```
96
+ npm install # also builds it — see the `prepare` script
97
+ node bin/gigaplan.js review path/to/plan.md # or `npm link` once, then plain `gigaplan ...`
98
+ ```
99
+
102
100
  ```
103
101
  npm run typecheck # tsc --noEmit against both the server and client TypeScript
104
102
  npm test # node:test, run directly against .ts sources via tsx
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "gigaplan",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "Review agent-authored implementation plans in a GitHub-PR-style browser UI. Agents write plain Markdown; gigaplan renders, themes, and collects structured feedback.",
5
5
  "type": "module",
6
6
  "bin": {