@ibgib/web-gib 0.0.22 → 0.0.23

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 +22 -11
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -35,22 +35,33 @@ npx web-gib-init-agents
35
35
  ```
36
36
 
37
37
  **Option 2 (For Monorepos & Workspaces)**
38
- If `@ibgib/web-gib` is a dependency on a sub-app (e.g. `apps/my-app`) instead of the workspace root, `npx` at the root will fail to locate the binary. To initialize the `.agents` folder at your monorepo root, you have two choices:
38
+ If `@ibgib/web-gib` is a dependency on a sub-app (e.g. `apps/my-app`) instead of the workspace root, package manager "hoisting" rules may prevent the executable from appearing at your root level.
39
39
 
40
- *Choice A:* Add it as a passthrough script in your monorepo's root `package.json` (Recommended):
41
- ```json
42
- "scripts": {
43
- "init-agents": "web-gib-init-agents"
44
- }
45
- ```
46
- Then execute it from the root:
40
+ To properly initialize the `.agents` folder at your monorepo's root, pull from one of the following commands:
41
+
42
+ *Choice A (Execute via npx):* Let `npx` automatically resolve and execute the binary hook from the package registry:
47
43
  ```bash
48
- npm run init-agents
44
+ npx -p @ibgib/web-gib web-gib-init-agents
49
45
  ```
50
46
 
51
- *Choice B:* Force `npx` to resolve the package locally:
47
+ *Choice B (Execute script directly):* Bypass the broken `.bin` symlink entirely and execute the raw script locally from within the nested workspace dependency:
52
48
  ```bash
53
- npx -p @ibgib/web-gib web-gib-init-agents
49
+ node ./apps/my-app/node_modules/@ibgib/web-gib/tools/init-agents.js
50
+ ```
51
+
52
+ **Recommendation for Monorepos:**
53
+ To streamline future updates, it is highly recommended to map whichever execution method you prefer directly into your root `package.json` scripts:
54
+
55
+ ```json
56
+ "scripts": {
57
+ "init-agents": "npx -p @ibgib/web-gib web-gib-init-agents"
58
+ }
59
+ ```
60
+ Or for the direct script approach:
61
+ ```json
62
+ "scripts": {
63
+ "init-agents": "node ./apps/my-app/node_modules/@ibgib/web-gib/tools/init-agents.js"
64
+ }
54
65
  ```
55
66
 
56
67
  ## UI Architecture: Custom @ibgib component framework
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ibgib/web-gib",
3
- "version": "0.0.22",
3
+ "version": "0.0.23",
4
4
  "description": "Framework for creating agentic ibGib web apps. Contains plumbing for ibgib components, agentic framework (currently only Gemini implemented), web-based IndexedDB storage substrate, and more.",
5
5
  "funding": {
6
6
  "type": "individual",