gabbe-kit 1.0.3 → 1.1.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 +21 -0
- package/agents/AGENTS.md +33 -1
- package/agents/CONSTITUTION.md +1 -1
- package/agents/guides/ai/ai-agentic.md +2 -4
- package/agents/guides/ai/multi-agent-systems.md +1 -1
- package/agents/guides/patterns/ai-native-scenarios.md +2 -2
- package/agents/skills/coding/secure-coding.skill.md +1 -1
- package/agents/skills/core/audit-trail.skill.md +1 -1
- package/agents/skills/security/ai-safety-guardrails.skill.md +3 -3
- package/agents/templates/coordination/AGENTS_TEMPLATE.md +25 -1
- package/agents/templates/core/AUDIT_LOG_TEMPLATE.md +1 -1
- package/bin/install.js +36 -6
- package/docs/CLI_REFERENCE.md +43 -5
- package/docs/INSTALL.md +23 -10
- package/package.json +2 -2
- package/scripts/init.py +488 -8
package/docs/CLI_REFERENCE.md
CHANGED
|
@@ -438,7 +438,7 @@ gabbe registry add ./bundle --namespace ext # dry run
|
|
|
438
438
|
gabbe registry add https://example/skill.skill.md --apply
|
|
439
439
|
```
|
|
440
440
|
|
|
441
|
-
### `gabbe setup`
|
|
441
|
+
### `gabbe setup [--force]`
|
|
442
442
|
|
|
443
443
|
Run the interactive install wizard (`scripts/init.py`) to wire the kit into your
|
|
444
444
|
coding agents. (For a Python-independent install, use `npx gabbe-kit init` or
|
|
@@ -446,6 +446,42 @@ coding agents. (For a Python-independent install, use `npx gabbe-kit init` or
|
|
|
446
446
|
|
|
447
447
|
```bash
|
|
448
448
|
gabbe setup
|
|
449
|
+
gabbe setup --force # re-template even preserved files (each backed up first)
|
|
450
|
+
```
|
|
451
|
+
|
|
452
|
+
**Behavior:**
|
|
453
|
+
- **Never-clobber.** Any differing pre-existing file is backed up to `<name>.gabbe-bak`
|
|
454
|
+
before being refreshed; nothing you already had is silently overwritten. The
|
|
455
|
+
preserve-set (`AGENTS.md`, `CONSTITUTION.md`, `TASKS.md`, `policies.yml`, `config.json`)
|
|
456
|
+
is left untouched unless you pass `--force`, which re-templates them too (still backing
|
|
457
|
+
each up first).
|
|
458
|
+
- **Reversible.** The wizard writes `.gabbe/manifest.json` recording everything it created
|
|
459
|
+
(copied kit files, wiring symlinks, generated skill trees, config files), so
|
|
460
|
+
`gabbe uninstall` fully reverses a wizard install.
|
|
461
|
+
- **Brownfield autodetect.** In an existing codebase (detects `package.json`,
|
|
462
|
+
`pyproject.toml`, `go.mod`, `Cargo.toml`, `composer.json`, `pom.xml`, `Gemfile`, a `.git`
|
|
463
|
+
repo, etc.) the wizard adds a Mode question — greenfield vs **Upgrade / Refactor
|
|
464
|
+
existing** — prefills detected language / framework / package-manager / project-name as
|
|
465
|
+
defaults, and in refactor mode scaffolds a `BROWNFIELD_ONBOARDING.md` discovery brief
|
|
466
|
+
instead of greenfield mission docs. The greenfield flow is unchanged in an empty dir.
|
|
467
|
+
- **Placeholder population.** Derivable `[PLACEHOLDER:]` fields in `AGENTS.md`
|
|
468
|
+
(dev/test/lint/format/typecheck/coverage commands, `repo_url`, `ci_cd`,
|
|
469
|
+
`deployment_target`) are auto-filled; the rest are kept, tagged
|
|
470
|
+
`<!-- OPTIONAL: fill this in yourself -->`, and listed in an end-of-install warning so
|
|
471
|
+
blank fields are never shipped silently.
|
|
472
|
+
|
|
473
|
+
**Node installer (`npx gabbe-kit init`) flags** — the Python-independent equivalent
|
|
474
|
+
supports the same never-clobber/`--force` behavior plus non-interactive install:
|
|
475
|
+
|
|
476
|
+
| Flag | Description |
|
|
477
|
+
|---|---|
|
|
478
|
+
| `--yes` | Non-interactive; accept defaults without prompting |
|
|
479
|
+
| `--agents <list>` | Comma-separated agents to wire (e.g. `--agents claude,cursor`) |
|
|
480
|
+
| `--force` | Re-template even preserve-set files (each backed up to `<name>.gabbe-bak` first) |
|
|
481
|
+
|
|
482
|
+
```bash
|
|
483
|
+
npx gabbe-kit init --yes --agents claude,cursor
|
|
484
|
+
npx gabbe-kit init --force
|
|
449
485
|
```
|
|
450
486
|
|
|
451
487
|
---
|
|
@@ -498,10 +534,12 @@ gabbe update
|
|
|
498
534
|
### `gabbe uninstall [--agents LIST] [--dry-run] [--purge] [--global] [--dir PATH]`
|
|
499
535
|
|
|
500
536
|
Reverse a GABBE install using its `.gabbe/manifest.json`: removes exactly what was
|
|
501
|
-
installed, restores any `.bak` backups,
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
537
|
+
installed, restores any `.gabbe-bak`/`.bak` backups, preserves any file you edited after
|
|
538
|
+
install as `<name>.gabbe-bak` (rather than deleting it), prunes now-empty wiring dirs, and
|
|
539
|
+
never touches unrelated files. Wizard installs (`gabbe setup`) are manifest-tracked and so
|
|
540
|
+
fully reversible. `--agents` deselects specific agents only; `--dry-run` prints the plan
|
|
541
|
+
without changing anything; `--purge` also removes the `agents/` kit and `.gabbe/`.
|
|
542
|
+
Idempotent and isolated (never writes outside the target).
|
|
505
543
|
|
|
506
544
|
```bash
|
|
507
545
|
gabbe uninstall --dry-run
|
package/docs/INSTALL.md
CHANGED
|
@@ -4,11 +4,13 @@ GABBE installs are **isolated**: nothing is ever written outside the chosen targ
|
|
|
4
4
|
unless you pass `--global`.
|
|
5
5
|
|
|
6
6
|
> **Reversibility — scope.** Manifest-backed, precise `update`/`uninstall` (recorded
|
|
7
|
-
> in `.gabbe/manifest.json`) covers kits managed by the Python `gabbe` CLI
|
|
8
|
-
>
|
|
9
|
-
> manifest
|
|
10
|
-
>
|
|
11
|
-
>
|
|
7
|
+
> in `.gabbe/manifest.json`) covers kits managed by the Python `gabbe` CLI **and**
|
|
8
|
+
> the Python wizard (`gabbe setup` / `python scripts/init.py`), which now writes a
|
|
9
|
+
> manifest recording everything it created under the project (copied kit files,
|
|
10
|
+
> wiring symlinks, generated skill trees, config files). So `gabbe uninstall` fully
|
|
11
|
+
> reverses a wizard install too. The remaining Python-independent installers
|
|
12
|
+
> (`npx gabbe-kit init`, `curl … | sh`) copy the kit but do **not** write a manifest,
|
|
13
|
+
> so `gabbe uninstall` cannot auto-reverse them — remove those manually (delete the
|
|
12
14
|
> created `agents/`, `.agents/`, per-agent dirs, and root `AGENTS.md`), or run
|
|
13
15
|
> `gabbe update` from a checkout to begin manifest tracking.
|
|
14
16
|
|
|
@@ -21,6 +23,14 @@ unless you pass `--global`.
|
|
|
21
23
|
| Shell bootstrap | `curl -fsSL https://raw.githubusercontent.com/andreibesleaga/GABBE/main/install.sh \| sh` | picks the best available installer |
|
|
22
24
|
| Git checkout | `git clone … && python3 scripts/init.py` | the interactive wizard |
|
|
23
25
|
|
|
26
|
+
**Never-clobber + `--force`.** Both installers — the Node installer
|
|
27
|
+
(`npx gabbe-kit init`) and the Python wizard (`gabbe setup` / `python scripts/init.py`)
|
|
28
|
+
— back up ANY differing pre-existing file to `<name>.gabbe-bak` before refreshing it, so
|
|
29
|
+
nothing you already had is silently overwritten. The preserve-set (`AGENTS.md`,
|
|
30
|
+
`CONSTITUTION.md`, `TASKS.md`, `policies.yml`, `config.json`) is left as-is unless you
|
|
31
|
+
pass `--force` (e.g. `npx gabbe-kit init --force`), which opts into re-templating those
|
|
32
|
+
too — and still backs each one up first.
|
|
33
|
+
|
|
24
34
|
After installing, run `gabbe doctor` to print an environment + install report
|
|
25
35
|
(detected OS/arch, runtimes, agent clients, and per-check PASS/WARN). It also prints
|
|
26
36
|
**post-install next steps** — which MCP servers to enable and how. For the full
|
|
@@ -62,11 +72,14 @@ pwsh ./uninstall.ps1 -DryRun # Windows / PowerShell
|
|
|
62
72
|
```
|
|
63
73
|
|
|
64
74
|
Uninstall reads `.gabbe/manifest.json`, removes **exactly** what was installed,
|
|
65
|
-
restores any shadowed user files from their `.bak
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
75
|
+
restores any shadowed user files from their `.gabbe-bak`/`.bak` backup, preserves any
|
|
76
|
+
file you edited after install as `<name>.gabbe-bak` instead of deleting it, prunes
|
|
77
|
+
now-empty wiring directories, and is idempotent (safe to run twice). When a manifest is
|
|
78
|
+
present the result is byte-identical to the pre-install state. The wizard
|
|
79
|
+
(`gabbe setup` / `python scripts/init.py`) now writes a manifest, so its installs are
|
|
80
|
+
fully reversible too. **Note:** only `npx` / `curl` installs remain non-manifest-tracked
|
|
81
|
+
(see the scope note at the top); for those, delete the kit directories manually or run
|
|
82
|
+
`gabbe update` from a checkout first.
|
|
70
83
|
|
|
71
84
|
## Verification
|
|
72
85
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "gabbe-kit",
|
|
3
|
-
"version": "1.0
|
|
3
|
+
"version": "1.1.0",
|
|
4
4
|
"description": "GABBE - Generative Architectural Brain Base Engine. A Markdown agentic engineering kit installer (Python-independent). Wires AGENTS.md, skills, and per-agent rule files into any project.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"agentic",
|
|
@@ -30,7 +30,7 @@
|
|
|
30
30
|
"gabbe-kit": "bin/install.js"
|
|
31
31
|
},
|
|
32
32
|
"scripts": {
|
|
33
|
-
"test": "node bin/install.js --help"
|
|
33
|
+
"test": "node bin/install.js --help && node scripts/tests/test_node_install.js"
|
|
34
34
|
},
|
|
35
35
|
"files": [
|
|
36
36
|
"bin/",
|