agents-reverse-engineer 0.2.2 → 0.2.3

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 (5) hide show
  1. package/README.md +8 -8
  2. package/dist/integration/templates.d.ts.map +1 -1
  3. package/dist/integration/templates.js +107 -0
  4. package/dist/integration/templates.js.map +1 -1
  5. package/package.json +1 -1
package/README.md CHANGED
@@ -12,7 +12,7 @@
12
12
  <br>
13
13
 
14
14
  ```bash
15
- npx agents-reverse-engineer
15
+ npx agents-reverse-engineer@latest
16
16
  ```
17
17
 
18
18
  **Interactive installer with runtime and location selection.**
@@ -60,7 +60,7 @@ Developers using AI coding assistants (Claude Code, OpenCode, Gemini CLI, or any
60
60
  ### 1. Install Commands
61
61
 
62
62
  ```bash
63
- npx agents-reverse-engineer
63
+ npx agents-reverse-engineer@latest
64
64
  ```
65
65
 
66
66
  The interactive installer prompts you to:
@@ -98,24 +98,24 @@ The assistant creates the plan and generates all documentation.
98
98
 
99
99
  ```bash
100
100
  # Install for Claude Code globally
101
- npx agents-reverse-engineer --runtime claude -g
101
+ npx agents-reverse-engineer@latest --runtime claude -g
102
102
 
103
103
  # Install for all runtimes locally
104
- npx agents-reverse-engineer --runtime all -l
104
+ npx agents-reverse-engineer@latest --runtime all -l
105
105
  ```
106
106
 
107
107
  ### Uninstall
108
108
 
109
109
  ```bash
110
- npx agents-reverse-engineer install -u
110
+ npx agents-reverse-engineer@latest install -u
111
111
  ```
112
112
 
113
113
  Removes all installed files and hooks.
114
114
 
115
- ### Staying Updated
115
+ ### Checking Version
116
116
 
117
117
  ```bash
118
- npx agents-reverse-engineer@latest
118
+ npx agents-reverse-engineer@latest --version
119
119
  ```
120
120
 
121
121
  ---
@@ -125,7 +125,7 @@ npx agents-reverse-engineer@latest
125
125
  ### 1. Install Commands
126
126
 
127
127
  ```bash
128
- npx agents-reverse-engineer
128
+ npx agents-reverse-engineer@latest
129
129
  ```
130
130
 
131
131
  Interactive installer installs commands and hooks for your chosen runtime(s).
package/dist/integration/templates.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"templates.d.ts","sourceRoot":"","sources":["../../src/integration/templates.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AAEtD;;;;;;;;;GASG;AACH,wBAAgB,kBAAkB,IAAI,mBAAmB,EAAE,CA2P1D;AAED;;;;;;;;GAQG;AACH,wBAAgB,oBAAoB,IAAI,mBAAmB,EAAE,CA2F5D;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,kBAAkB,IAAI,mBAAmB,EAAE,CAsF1D;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,eAAe,IAAI,MAAM,CAyCxC"}
1
+ {"version":3,"file":"templates.d.ts","sourceRoot":"","sources":["../../src/integration/templates.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AAEtD;;;;;;;;;GASG;AACH,wBAAgB,kBAAkB,IAAI,mBAAmB,EAAE,CAyS1D;AAED;;;;;;;;GAQG;AACH,wBAAgB,oBAAoB,IAAI,mBAAmB,EAAE,CA0H5D;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,kBAAkB,IAAI,mBAAmB,EAAE,CAoH1D;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,eAAe,IAAI,MAAM,CAyCxC"}
package/dist/integration/templates.js CHANGED
@@ -261,6 +261,52 @@ Report:
261
261
 
262
262
  Suggest running \`/are:discover\` to start fresh.
263
263
  </execution>
264
+ `,
265
+ },
266
+ {
267
+ filename: 'help.md',
268
+ path: '.claude/commands/are/help.md',
269
+ content: `---
270
+ name: are:help
271
+ description: Show available ARE commands and usage guide
272
+ ---
273
+
274
+ Show help for agents-reverse-engineer commands.
275
+
276
+ <execution>
277
+ Display the following help information:
278
+
279
+ ## agents-reverse-engineer (ARE) Commands
280
+
281
+ | Command | Description |
282
+ |---------|-------------|
283
+ | \`/are:help\` | Show this help message |
284
+ | \`/are:init\` | Initialize configuration file |
285
+ | \`/are:discover\` | Discover files and create GENERATION-PLAN.md |
286
+ | \`/are:generate\` | Generate documentation from the plan |
287
+ | \`/are:update\` | Update docs for changed files only |
288
+ | \`/are:clean\` | Remove all generated documentation |
289
+
290
+ ## Typical Workflow
291
+
292
+ 1. **\`/are:init\`** — Create \`.agents-reverse-engineer/config.yaml\`
293
+ 2. **\`/are:discover\`** — Scan codebase, create \`GENERATION-PLAN.md\`
294
+ 3. **\`/are:generate\`** — Execute plan, generate \`.sum\` and \`AGENTS.md\` files
295
+ 4. **\`/are:update\`** — After code changes, update only what changed
296
+
297
+ ## Generated Files
298
+
299
+ - \`*.sum\` — Per-file summaries (purpose, exports, dependencies)
300
+ - \`AGENTS.md\` — Per-directory overviews
301
+ - \`CLAUDE.md\` — Project entry point
302
+ - \`ARCHITECTURE.md\` — System design overview
303
+ - \`STACK.md\` — Technology stack
304
+
305
+ ## More Info
306
+
307
+ - Docs: https://github.com/GeoloeG-IsT/agents-reverse-engineer
308
+ - Update: \`npx agents-reverse-engineer@latest\`
309
+ </execution>
264
310
  `,
265
311
  },
266
312
  ];
@@ -362,6 +408,37 @@ This creates \`.agents-reverse-engineer.yaml\` configuration file.
362
408
 
363
409
  To install commands and hooks, use the interactive installer:
364
410
  \`npx agents-reverse-engineer install\`
411
+ `,
412
+ },
413
+ {
414
+ filename: 'are-help.md',
415
+ path: '.opencode/commands/are-help.md',
416
+ content: `---
417
+ description: Show available ARE commands and usage guide
418
+ agent: build
419
+ ---
420
+
421
+ ## agents-reverse-engineer (ARE) Commands
422
+
423
+ | Command | Description |
424
+ |---------|-------------|
425
+ | \`/are-help\` | Show this help message |
426
+ | \`/are-init\` | Initialize configuration file |
427
+ | \`/are-discover\` | Discover files and create GENERATION-PLAN.md |
428
+ | \`/are-generate\` | Generate documentation from the plan |
429
+ | \`/are-update\` | Update docs for changed files only |
430
+ | \`/are-clean\` | Remove all generated documentation |
431
+
432
+ ## Typical Workflow
433
+
434
+ 1. **\`/are-init\`** — Create \`.agents-reverse-engineer/config.yaml\`
435
+ 2. **\`/are-discover\`** — Scan codebase, create \`GENERATION-PLAN.md\`
436
+ 3. **\`/are-generate\`** — Execute plan, generate \`.sum\` and \`AGENTS.md\` files
437
+ 4. **\`/are-update\`** — After code changes, update only what changed
438
+
439
+ ## More Info
440
+
441
+ Docs: https://github.com/GeoloeG-IsT/agents-reverse-engineer
365
442
  `,
366
443
  },
367
444
  ];
@@ -460,6 +537,36 @@ This creates \`.agents-reverse-engineer.yaml\` configuration file.
460
537
 
461
538
  To install commands and hooks, use the interactive installer:
462
539
  \`npx agents-reverse-engineer install\`
540
+ `,
541
+ },
542
+ {
543
+ filename: 'are-help.md',
544
+ path: '.gemini/commands/are-help.md',
545
+ content: `---
546
+ description: Show available ARE commands and usage guide
547
+ ---
548
+
549
+ ## agents-reverse-engineer (ARE) Commands
550
+
551
+ | Command | Description |
552
+ |---------|-------------|
553
+ | \`/are-help\` | Show this help message |
554
+ | \`/are-init\` | Initialize configuration file |
555
+ | \`/are-discover\` | Discover files and create GENERATION-PLAN.md |
556
+ | \`/are-generate\` | Generate documentation from the plan |
557
+ | \`/are-update\` | Update docs for changed files only |
558
+ | \`/are-clean\` | Remove all generated documentation |
559
+
560
+ ## Typical Workflow
561
+
562
+ 1. **\`/are-init\`** — Create \`.agents-reverse-engineer/config.yaml\`
563
+ 2. **\`/are-discover\`** — Scan codebase, create \`GENERATION-PLAN.md\`
564
+ 3. **\`/are-generate\`** — Execute plan, generate \`.sum\` and \`AGENTS.md\` files
565
+ 4. **\`/are-update\`** — After code changes, update only what changed
566
+
567
+ ## More Info
568
+
569
+ Docs: https://github.com/GeoloeG-IsT/agents-reverse-engineer
463
570
  `,
464
571
  },
465
572
  ];
package/dist/integration/templates.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"templates.js","sourceRoot":"","sources":["../../src/integration/templates.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH;;;;;;;;;GASG;AACH,MAAM,UAAU,kBAAkB;IAChC,OAAO;QACL;YACE,QAAQ,EAAE,aAAa;YACvB,IAAI,EAAE,kCAAkC;YACxC,OAAO,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAoGd;SACI;QACD;YACE,QAAQ,EAAE,WAAW;YACrB,IAAI,EAAE,gCAAgC;YACtC,OAAO,EAAE;;;;;;;;;;;;;;;;;;;;;;CAsBd;SACI;QACD;YACE,QAAQ,EAAE,SAAS;YACnB,IAAI,EAAE,8BAA8B;YACpC,OAAO,EAAE;;;;;;;;;;;;;;;;;;;;;;CAsBd;SACI;QACD;YACE,QAAQ,EAAE,aAAa;YACvB,IAAI,EAAE,kCAAkC;YACxC,OAAO,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA6Bd;SACI;QACD;YACE,QAAQ,EAAE,UAAU;YACpB,IAAI,EAAE,+BAA+B;YACrC,OAAO,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAkDd;SACI;KACF,CAAC;AACJ,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,oBAAoB;IAClC,OAAO;QACL;YACE,QAAQ,EAAE,iBAAiB;YAC3B,IAAI,EAAE,oCAAoC;YAC1C,OAAO,EAAE;;;;;;;;;;;;;CAad;SACI;QACD;YACE,QAAQ,EAAE,eAAe;YACzB,IAAI,EAAE,kCAAkC;YACxC,OAAO,EAAE;;;;;;;;;;;;;CAad;SACI;QACD;YACE,QAAQ,EAAE,iBAAiB;YAC3B,IAAI,EAAE,oCAAoC;YAC1C,OAAO,EAAE;;;;;;;;;;;;;CAad;SACI;QACD;YACE,QAAQ,EAAE,cAAc;YACxB,IAAI,EAAE,iCAAiC;YACvC,OAAO,EAAE;;;;;;;;;;;CAWd;SACI;QACD;YACE,QAAQ,EAAE,aAAa;YACvB,IAAI,EAAE,gCAAgC;YACtC,OAAO,EAAE;;;;;;;;;;;;;CAad;SACI;KACF,CAAC;AACJ,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,kBAAkB;IAChC,OAAO;QACL;YACE,QAAQ,EAAE,iBAAiB;YAC3B,IAAI,EAAE,kCAAkC;YACxC,OAAO,EAAE;;;;;;;;;;;;CAYd;SACI;QACD;YACE,QAAQ,EAAE,eAAe;YACzB,IAAI,EAAE,gCAAgC;YACtC,OAAO,EAAE;;;;;;;;;;;;CAYd;SACI;QACD;YACE,QAAQ,EAAE,iBAAiB;YAC3B,IAAI,EAAE,kCAAkC;YACxC,OAAO,EAAE;;;;;;;;;;;;CAYd;SACI;QACD;YACE,QAAQ,EAAE,cAAc;YACxB,IAAI,EAAE,+BAA+B;YACrC,OAAO,EAAE;;;;;;;;;;CAUd;SACI;QACD;YACE,QAAQ,EAAE,aAAa;YACvB,IAAI,EAAE,8BAA8B;YACpC,OAAO,EAAE;;;;;;;;;;;;CAYd;SACI;KACF,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,eAAe;IAC7B,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAuCR,CAAC;AACF,CAAC"}
1
+ {"version":3,"file":"templates.js","sourceRoot":"","sources":["../../src/integration/templates.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH;;;;;;;;;GASG;AACH,MAAM,UAAU,kBAAkB;IAChC,OAAO;QACL;YACE,QAAQ,EAAE,aAAa;YACvB,IAAI,EAAE,kCAAkC;YACxC,OAAO,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAoGd;SACI;QACD;YACE,QAAQ,EAAE,WAAW;YACrB,IAAI,EAAE,gCAAgC;YACtC,OAAO,EAAE;;;;;;;;;;;;;;;;;;;;;;CAsBd;SACI;QACD;YACE,QAAQ,EAAE,SAAS;YACnB,IAAI,EAAE,8BAA8B;YACpC,OAAO,EAAE;;;;;;;;;;;;;;;;;;;;;;CAsBd;SACI;QACD;YACE,QAAQ,EAAE,aAAa;YACvB,IAAI,EAAE,kCAAkC;YACxC,OAAO,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA6Bd;SACI;QACD;YACE,QAAQ,EAAE,UAAU;YACpB,IAAI,EAAE,+BAA+B;YACrC,OAAO,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAkDd;SACI;QACD;YACE,QAAQ,EAAE,SAAS;YACnB,IAAI,EAAE,8BAA8B;YACpC,OAAO,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAyCd;SACI;KACF,CAAC;AACJ,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,oBAAoB;IAClC,OAAO;QACL;YACE,QAAQ,EAAE,iBAAiB;YAC3B,IAAI,EAAE,oCAAoC;YAC1C,OAAO,EAAE;;;;;;;;;;;;;CAad;SACI;QACD;YACE,QAAQ,EAAE,eAAe;YACzB,IAAI,EAAE,kCAAkC;YACxC,OAAO,EAAE;;;;;;;;;;;;;CAad;SACI;QACD;YACE,QAAQ,EAAE,iBAAiB;YAC3B,IAAI,EAAE,oCAAoC;YAC1C,OAAO,EAAE;;;;;;;;;;;;;CAad;SACI;QACD;YACE,QAAQ,EAAE,cAAc;YACxB,IAAI,EAAE,iCAAiC;YACvC,OAAO,EAAE;;;;;;;;;;;CAWd;SACI;QACD;YACE,QAAQ,EAAE,aAAa;YACvB,IAAI,EAAE,gCAAgC;YACtC,OAAO,EAAE;;;;;;;;;;;;;CAad;SACI;QACD;YACE,QAAQ,EAAE,aAAa;YACvB,IAAI,EAAE,gCAAgC;YACtC,OAAO,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;CA0Bd;SACI;KACF,CAAC;AACJ,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,kBAAkB;IAChC,OAAO;QACL;YACE,QAAQ,EAAE,iBAAiB;YAC3B,IAAI,EAAE,kCAAkC;YACxC,OAAO,EAAE;;;;;;;;;;;;CAYd;SACI;QACD;YACE,QAAQ,EAAE,eAAe;YACzB,IAAI,EAAE,gCAAgC;YACtC,OAAO,EAAE;;;;;;;;;;;;CAYd;SACI;QACD;YACE,QAAQ,EAAE,iBAAiB;YAC3B,IAAI,EAAE,kCAAkC;YACxC,OAAO,EAAE;;;;;;;;;;;;CAYd;SACI;QACD;YACE,QAAQ,EAAE,cAAc;YACxB,IAAI,EAAE,+BAA+B;YACrC,OAAO,EAAE;;;;;;;;;;CAUd;SACI;QACD;YACE,QAAQ,EAAE,aAAa;YACvB,IAAI,EAAE,8BAA8B;YACpC,OAAO,EAAE;;;;;;;;;;;;CAYd;SACI;QACD;YACE,QAAQ,EAAE,aAAa;YACvB,IAAI,EAAE,8BAA8B;YACpC,OAAO,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;CAyBd;SACI;KACF,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,eAAe;IAC7B,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAuCR,CAAC;AACF,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "agents-reverse-engineer",
3
- "version": "0.2.2",
3
+ "version": "0.2.3",
4
4
  "description": "CLI tool for reverse-engineering codebase documentation for AI agents",
5
5
  "type": "module",
6
6
  "bin": {