@theihtisham/agent-shadow-brain 7.1.0 → 7.1.4
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/CHANGELOG.md +42 -0
- package/README.md +125 -450
- package/dist/activity-cli.d.ts +3 -0
- package/dist/activity-cli.d.ts.map +1 -0
- package/dist/activity-cli.js +78 -0
- package/dist/activity-cli.js.map +1 -0
- package/dist/adapters/index.d.ts +2 -1
- package/dist/adapters/index.d.ts.map +1 -1
- package/dist/adapters/index.js +3 -2
- package/dist/adapters/index.js.map +1 -1
- package/dist/brain/activity-journal.d.ts +82 -0
- package/dist/brain/activity-journal.d.ts.map +1 -0
- package/dist/brain/activity-journal.js +315 -0
- package/dist/brain/activity-journal.js.map +1 -0
- package/dist/brain/activity-reporting.d.ts +14 -0
- package/dist/brain/activity-reporting.d.ts.map +1 -0
- package/dist/brain/activity-reporting.js +17 -0
- package/dist/brain/activity-reporting.js.map +1 -0
- package/dist/brain/auto-update.js +1 -1
- package/dist/brain/brain-portability.js +1 -1
- package/dist/brain/client-config.d.ts +19 -0
- package/dist/brain/client-config.d.ts.map +1 -0
- package/dist/brain/client-config.js +40 -0
- package/dist/brain/client-config.js.map +1 -0
- package/dist/brain/client-integrations.d.ts +63 -0
- package/dist/brain/client-integrations.d.ts.map +1 -0
- package/dist/brain/client-integrations.js +79 -0
- package/dist/brain/client-integrations.js.map +1 -0
- package/dist/brain/context-assembly.d.ts +84 -0
- package/dist/brain/context-assembly.d.ts.map +1 -0
- package/dist/brain/context-assembly.js +529 -0
- package/dist/brain/context-assembly.js.map +1 -0
- package/dist/brain/context-request.d.ts +4 -0
- package/dist/brain/context-request.d.ts.map +1 -0
- package/dist/brain/context-request.js +22 -0
- package/dist/brain/context-request.js.map +1 -0
- package/dist/brain/context-retrieval.d.ts +88 -0
- package/dist/brain/context-retrieval.d.ts.map +1 -0
- package/dist/brain/context-retrieval.js +300 -0
- package/dist/brain/context-retrieval.js.map +1 -0
- package/dist/brain/feature-settings.d.ts +58 -0
- package/dist/brain/feature-settings.d.ts.map +1 -0
- package/dist/brain/feature-settings.js +242 -0
- package/dist/brain/feature-settings.js.map +1 -0
- package/dist/brain/file-identity.d.ts +4 -0
- package/dist/brain/file-identity.d.ts.map +1 -0
- package/dist/brain/file-identity.js +27 -0
- package/dist/brain/file-identity.js.map +1 -0
- package/dist/brain/global-brain.d.ts +18 -1
- package/dist/brain/global-brain.d.ts.map +1 -1
- package/dist/brain/global-brain.js +77 -10
- package/dist/brain/global-brain.js.map +1 -1
- package/dist/brain/mcp-server.d.ts +30 -1
- package/dist/brain/mcp-server.d.ts.map +1 -1
- package/dist/brain/mcp-server.js +378 -28
- package/dist/brain/mcp-server.js.map +1 -1
- package/dist/brain/mcp-stdio.d.ts +12 -0
- package/dist/brain/mcp-stdio.d.ts.map +1 -0
- package/dist/brain/mcp-stdio.js +140 -0
- package/dist/brain/mcp-stdio.js.map +1 -0
- package/dist/brain/memory-annotations.d.ts +97 -0
- package/dist/brain/memory-annotations.d.ts.map +1 -0
- package/dist/brain/memory-annotations.js +389 -0
- package/dist/brain/memory-annotations.js.map +1 -0
- package/dist/brain/memory-graph.d.ts.map +1 -1
- package/dist/brain/memory-graph.js +12 -23
- package/dist/brain/memory-graph.js.map +1 -1
- package/dist/brain/memory-inspection.d.ts +72 -0
- package/dist/brain/memory-inspection.d.ts.map +1 -0
- package/dist/brain/memory-inspection.js +131 -0
- package/dist/brain/memory-inspection.js.map +1 -0
- package/dist/brain/memory-mcp-content.d.ts +44 -0
- package/dist/brain/memory-mcp-content.d.ts.map +1 -0
- package/dist/brain/memory-mcp-content.js +91 -0
- package/dist/brain/memory-mcp-content.js.map +1 -0
- package/dist/brain/memory-sources.d.ts +8 -0
- package/dist/brain/memory-sources.d.ts.map +1 -0
- package/dist/brain/memory-sources.js +27 -0
- package/dist/brain/memory-sources.js.map +1 -0
- package/dist/brain/orchestrator.js +1 -1
- package/dist/brain/project-feedback.d.ts +63 -0
- package/dist/brain/project-feedback.d.ts.map +1 -0
- package/dist/brain/project-feedback.js +289 -0
- package/dist/brain/project-feedback.js.map +1 -0
- package/dist/brain/project-hub-contract.d.ts +326 -0
- package/dist/brain/project-hub-contract.d.ts.map +1 -0
- package/dist/brain/project-hub-contract.js +56 -0
- package/dist/brain/project-hub-contract.js.map +1 -0
- package/dist/brain/project-hub-mcp.d.ts +168 -0
- package/dist/brain/project-hub-mcp.d.ts.map +1 -0
- package/dist/brain/project-hub-mcp.js +41 -0
- package/dist/brain/project-hub-mcp.js.map +1 -0
- package/dist/brain/project-hub-pdf-worker.d.ts +13 -0
- package/dist/brain/project-hub-pdf-worker.d.ts.map +1 -0
- package/dist/brain/project-hub-pdf-worker.js +84 -0
- package/dist/brain/project-hub-pdf-worker.js.map +1 -0
- package/dist/brain/project-hub-store.d.ts +38 -0
- package/dist/brain/project-hub-store.d.ts.map +1 -0
- package/dist/brain/project-hub-store.js +189 -0
- package/dist/brain/project-hub-store.js.map +1 -0
- package/dist/brain/project-hub.d.ts +127 -0
- package/dist/brain/project-hub.d.ts.map +1 -0
- package/dist/brain/project-hub.js +381 -0
- package/dist/brain/project-hub.js.map +1 -0
- package/dist/brain/project-kit-inspection.d.ts +28 -0
- package/dist/brain/project-kit-inspection.d.ts.map +1 -0
- package/dist/brain/project-kit-inspection.js +200 -0
- package/dist/brain/project-kit-inspection.js.map +1 -0
- package/dist/brain/project-kit-paths.d.ts +13 -0
- package/dist/brain/project-kit-paths.d.ts.map +1 -0
- package/dist/brain/project-kit-paths.js +141 -0
- package/dist/brain/project-kit-paths.js.map +1 -0
- package/dist/brain/project-kit.d.ts +41 -0
- package/dist/brain/project-kit.d.ts.map +1 -0
- package/dist/brain/project-kit.js +255 -0
- package/dist/brain/project-kit.js.map +1 -0
- package/dist/brain/project-memory.d.ts +38 -0
- package/dist/brain/project-memory.d.ts.map +1 -0
- package/dist/brain/project-memory.js +76 -0
- package/dist/brain/project-memory.js.map +1 -0
- package/dist/brain/subconscious.d.ts +21 -24
- package/dist/brain/subconscious.d.ts.map +1 -1
- package/dist/brain/subconscious.js +82 -218
- package/dist/brain/subconscious.js.map +1 -1
- package/dist/brain/workflow-skills.d.ts +5 -5
- package/dist/brain/workflow-skills.d.ts.map +1 -1
- package/dist/brain/workflow-skills.js +3 -2
- package/dist/brain/workflow-skills.js.map +1 -1
- package/dist/cli.js +40 -4
- package/dist/cli.js.map +1 -1
- package/dist/context-cli.d.ts +3 -0
- package/dist/context-cli.d.ts.map +1 -0
- package/dist/context-cli.js +90 -0
- package/dist/context-cli.js.map +1 -0
- package/dist/curation-cli.d.ts +4 -0
- package/dist/curation-cli.d.ts.map +1 -0
- package/dist/curation-cli.js +118 -0
- package/dist/curation-cli.js.map +1 -0
- package/dist/dashboard/brain-hub-actions.d.ts +2 -0
- package/dist/dashboard/brain-hub-actions.d.ts.map +1 -0
- package/dist/dashboard/brain-hub-actions.js +137 -0
- package/dist/dashboard/brain-hub-actions.js.map +1 -0
- package/dist/dashboard/brain-hub-client.d.ts +2 -0
- package/dist/dashboard/brain-hub-client.d.ts.map +1 -0
- package/dist/dashboard/brain-hub-client.js +335 -0
- package/dist/dashboard/brain-hub-client.js.map +1 -0
- package/dist/dashboard/brain-hub-graph.d.ts +2 -0
- package/dist/dashboard/brain-hub-graph.d.ts.map +1 -0
- package/dist/dashboard/brain-hub-graph.js +176 -0
- package/dist/dashboard/brain-hub-graph.js.map +1 -0
- package/dist/dashboard/brain-hub-html.d.ts +2 -0
- package/dist/dashboard/brain-hub-html.d.ts.map +1 -0
- package/dist/dashboard/brain-hub-html.js +30 -0
- package/dist/dashboard/brain-hub-html.js.map +1 -0
- package/dist/dashboard/brain-hub-project-views.d.ts +2 -0
- package/dist/dashboard/brain-hub-project-views.d.ts.map +1 -0
- package/dist/dashboard/brain-hub-project-views.js +79 -0
- package/dist/dashboard/brain-hub-project-views.js.map +1 -0
- package/dist/dashboard/brain-hub-views.d.ts +2 -0
- package/dist/dashboard/brain-hub-views.d.ts.map +1 -0
- package/dist/dashboard/brain-hub-views.js +150 -0
- package/dist/dashboard/brain-hub-views.js.map +1 -0
- package/dist/dashboard/demo-workspace.d.ts +11 -0
- package/dist/dashboard/demo-workspace.d.ts.map +1 -0
- package/dist/dashboard/demo-workspace.js +178 -0
- package/dist/dashboard/demo-workspace.js.map +1 -0
- package/dist/dashboard/live-workspace-html.d.ts +2 -0
- package/dist/dashboard/live-workspace-html.d.ts.map +1 -0
- package/dist/dashboard/live-workspace-html.js +1042 -0
- package/dist/dashboard/live-workspace-html.js.map +1 -0
- package/dist/dashboard/project-feedback-html.d.ts +5 -0
- package/dist/dashboard/project-feedback-html.d.ts.map +1 -0
- package/dist/dashboard/project-feedback-html.js +216 -0
- package/dist/dashboard/project-feedback-html.js.map +1 -0
- package/dist/dashboard/project-hub-api.d.ts +5 -0
- package/dist/dashboard/project-hub-api.d.ts.map +1 -0
- package/dist/dashboard/project-hub-api.js +121 -0
- package/dist/dashboard/project-hub-api.js.map +1 -0
- package/dist/dashboard/project-kit-html.d.ts +4 -0
- package/dist/dashboard/project-kit-html.d.ts.map +1 -0
- package/dist/dashboard/project-kit-html.js +359 -0
- package/dist/dashboard/project-kit-html.js.map +1 -0
- package/dist/dashboard/project-workspace.d.ts +16 -0
- package/dist/dashboard/project-workspace.d.ts.map +1 -0
- package/dist/dashboard/project-workspace.js +106 -0
- package/dist/dashboard/project-workspace.js.map +1 -0
- package/dist/dashboard/server.d.ts +2 -0
- package/dist/dashboard/server.d.ts.map +1 -1
- package/dist/dashboard/server.js +65 -19
- package/dist/dashboard/server.js.map +1 -1
- package/dist/dashboard/v6-dashboard-html.d.ts +1 -1
- package/dist/dashboard/v6-dashboard-html.d.ts.map +1 -1
- package/dist/dashboard/v6-dashboard-html.js +34 -56
- package/dist/dashboard/v6-dashboard-html.js.map +1 -1
- package/dist/dashboard/workspace-api.d.ts +22 -0
- package/dist/dashboard/workspace-api.d.ts.map +1 -0
- package/dist/dashboard/workspace-api.js +429 -0
- package/dist/dashboard/workspace-api.js.map +1 -0
- package/dist/dashboard/workspace-html.d.ts +2 -0
- package/dist/dashboard/workspace-html.d.ts.map +1 -0
- package/dist/dashboard/workspace-html.js +2538 -0
- package/dist/dashboard/workspace-html.js.map +1 -0
- package/dist/dashboard/workspace-status.d.ts +50 -0
- package/dist/dashboard/workspace-status.d.ts.map +1 -0
- package/dist/dashboard/workspace-status.js +22 -0
- package/dist/dashboard/workspace-status.js.map +1 -0
- package/dist/index.d.ts +20 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +15 -0
- package/dist/index.js.map +1 -1
- package/dist/integration-cli.d.ts +3 -0
- package/dist/integration-cli.d.ts.map +1 -0
- package/dist/integration-cli.js +16 -0
- package/dist/integration-cli.js.map +1 -0
- package/dist/project-cli.d.ts +3 -0
- package/dist/project-cli.d.ts.map +1 -0
- package/dist/project-cli.js +100 -0
- package/dist/project-cli.js.map +1 -0
- package/dist/types.d.ts +12 -3
- package/dist/types.d.ts.map +1 -1
- package/docs/COMPARISON.md +22 -0
- package/docs/COMPONENTS.md +66 -0
- package/docs/CONTEXT_LAB.md +79 -0
- package/docs/FEATURES_AND_LIMITS.md +24 -0
- package/docs/INTEGRATIONS.md +68 -0
- package/docs/LEARNING.md +46 -0
- package/docs/PROJECT_KIT.md +93 -0
- package/docs/QUICKSTART.md +44 -0
- package/docs/README.md +33 -0
- package/docs/ROADMAP-v7.md +147 -0
- package/docs/SHARING.md +13 -0
- package/docs/SHOWCASE.md +87 -0
- package/docs/STATS.md +21 -0
- package/docs/TROUBLESHOOTING.md +42 -0
- package/docs/UPGRADE_PLAN_v7.0.0.md +203 -0
- package/docs/VIRAL-PLAYBOOK.md +259 -0
- package/docs/VISUAL_GUIDE_v7.1.4.md +70 -0
- package/docs/WORKFLOW_INTEGRATION.md +19 -1
- package/docs/WORKSPACE.md +37 -0
- package/docs/assets/7.1.4-collaboration-design-preview.png +0 -0
- package/docs/assets/7.1.4-comparison.png +0 -0
- package/docs/assets/7.1.4-context-lab.png +0 -0
- package/docs/assets/7.1.4-control-room-dense-preview.png +0 -0
- package/docs/assets/7.1.4-control-room-focus-preview.png +0 -0
- package/docs/assets/7.1.4-features.png +0 -0
- package/docs/assets/7.1.4-graph.png +0 -0
- package/docs/assets/7.1.4-hub-control-room.png +0 -0
- package/docs/assets/7.1.4-hub-empty.png +0 -0
- package/docs/assets/7.1.4-hub-knowledge.png +0 -0
- package/docs/assets/7.1.4-hub-learning.png +0 -0
- package/docs/assets/7.1.4-hub-mobile.png +0 -0
- package/docs/assets/7.1.4-hub-public-docs-source.png +0 -0
- package/docs/assets/7.1.4-hub-public-docs.gif +0 -0
- package/docs/assets/7.1.4-hub-public-docs.png +0 -0
- package/docs/assets/7.1.4-hub-setup.png +0 -0
- package/docs/assets/7.1.4-hub-walkthrough.gif +0 -0
- package/docs/assets/7.1.4-integrations.png +0 -0
- package/docs/assets/7.1.4-knowledge-design-preview.png +0 -0
- package/docs/assets/7.1.4-learning-design-preview.png +0 -0
- package/docs/assets/7.1.4-learning.png +0 -0
- package/docs/assets/7.1.4-live.png +0 -0
- package/docs/assets/7.1.4-memory-review.png +0 -0
- package/docs/assets/7.1.4-mobile.png +0 -0
- package/docs/assets/7.1.4-models-design-preview.png +0 -0
- package/docs/assets/7.1.4-outcome-ranking.png +0 -0
- package/docs/assets/7.1.4-overview.png +0 -0
- package/docs/assets/7.1.4-project-kit.png +0 -0
- package/docs/assets/7.1.4-project-skill-preview.png +0 -0
- package/docs/assets/7.1.4-replay.png +0 -0
- package/docs/assets/7.1.4-setup-design-preview.png +0 -0
- package/docs/assets/7.1.4-usage-design-preview.png +0 -0
- package/docs/assets/context-flow-v7.2.png +0 -0
- package/docs/assets/context-v7.1.3.png +0 -0
- package/docs/assets/features-v7.1.3.png +0 -0
- package/docs/assets/graph-v7.1.3.png +0 -0
- package/docs/assets/integrations-v7.1.3.png +0 -0
- package/docs/assets/live-v7.1.3.png +0 -0
- package/docs/assets/live-v7.1.4.gif +0 -0
- package/docs/assets/memory-detail-v7.1.3.png +0 -0
- package/docs/assets/overview-v7.1.3.png +0 -0
- package/docs/assets/workspace-graph-v7.2.png +0 -0
- package/docs/assets/workspace-overview-v7.2.png +0 -0
- package/docs/evaluation/CONTEXT_EVALUATION_v7.1.4.json +1818 -0
- package/docs/evaluation/CONTEXT_EVALUATION_v7.1.4.md +36 -0
- package/docs/launch/COMPONENT_MAP_v7.1.4.md +307 -0
- package/docs/launch/PROJECT_KIT_PLAN_v7.1.4.md +110 -0
- package/docs/launch/PROJECT_LEARNING_PLAN_v7.1.4.md +63 -0
- package/docs/launch/RELEASE_NOTES_v7.1.3.md +40 -0
- package/docs/launch/RELEASE_NOTES_v7.1.4.md +30 -0
- package/docs/launch/RELEASE_NOTES_v7.2.0.md +24 -0
- package/docs/launch/RESEARCH_AND_PLAN_v7.1.4.md +255 -0
- package/package.json +43 -126
- package/skills/shadow-research/SKILL.md +2 -0
- package/skills/shadow-workflow/SKILL.md +6 -0
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
# Project Kit: knowledge and skills for one workspace
|
|
2
|
+
|
|
3
|
+
Project Kit combines a local knowledge store, bounded project inspection, task-specific skill generation, and feedback from actual work. Everything belongs to the selected project. Opening another project does not import these memories or install the skill globally.
|
|
4
|
+
|
|
5
|
+
## 1. Open your project
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
shadow-brain project workspace .
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
Open the printed address and choose **Project Kit**. This mode needs no model provider and does not read coding-client profiles. Closing the portal keeps your saved files. The older `dash` command still opens the shared-store dashboard; it does not silently switch or merge stores.
|
|
12
|
+
|
|
13
|
+
| File or folder | Purpose |
|
|
14
|
+
| --- | --- |
|
|
15
|
+
| `.shadow-brain/project-memory.json` | Explicit project knowledge |
|
|
16
|
+
| `.shadow-brain/memory-annotations.json` | Reviews and recorded memory relationships |
|
|
17
|
+
| `.shadow-brain/feature-settings.json` | The five runtime controls |
|
|
18
|
+
| `.shadow-brain/activity-journal.json` | Bounded measured/reported activity metadata |
|
|
19
|
+
| `.shadow-brain/memory-feedback.json` | Reported outcomes and local learning control |
|
|
20
|
+
| `.shadow-brain/project-kit-skills` | Ownership receipts for generated skills |
|
|
21
|
+
| Selected host's project skill folder | Generated `SKILL.md` files |
|
|
22
|
+
|
|
23
|
+
Files are created when their feature needs to save data. Treat knowledge and skill content as project files: decide what belongs in version control before sharing the repository. Moving a project changes its path-derived project ID; this release does not automatically reassign earlier memory IDs to the new location.
|
|
24
|
+
|
|
25
|
+
## 2. Inspect what the project actually declares
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
shadow-brain project inspect .
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
Inspection reports observed stack markers, package-manager markers, and known check names. It scans at most 500 directory entries through depth three, with bounded allowlisted manifest reads. A script named `test` yields a suggested command; its body is not returned or executed. Lockfiles and configuration markers can identify a tool without reading their contents. The scanner skips linked paths, dependency/build trees and private configuration locations.
|
|
32
|
+
|
|
33
|
+
These are observations, not complete semantic understanding. Missing manifests, a large monorepo, custom scripts, or an unfamiliar stack can leave gaps. The profile shows coverage and warnings. Check the suggested command before running it.
|
|
34
|
+
|
|
35
|
+
## 3. Add knowledge you want the agent to retain
|
|
36
|
+
|
|
37
|
+
Use the knowledge form for a project constraint, decision, rule, or known lesson. An optional reference records where you found it; the service does not fetch that reference or certify the statement.
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
shadow-brain project knowledge . --title "Checkout retry contract" --content "Preserve the original idempotency key across retries." --source "docs/checkout.md"
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
The command returns the committed memory ID and project ID. The original text is stored with explicit user provenance. A reference is recorded only when you supply one, so adding a note without a source does not inflate source coverage.
|
|
44
|
+
|
|
45
|
+
Open **Context Lab**, select the project, and ask about checkout retries. The saved note is immediately available to scoped retrieval. You can inspect, contest, archive, or connect it through the existing memory tools.
|
|
46
|
+
|
|
47
|
+
## 4. Turn a requirement into a local skill
|
|
48
|
+
|
|
49
|
+
Describe the task, choose a client, and optionally supply knowledge. **Use in skill** reuses the knowledge you just added. Preview shows the exact destination and Markdown before Apply.
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
shadow-brain project skill . --target codex --name checkout-retries --requirement "Fix checkout retries and verify that each request commits once."
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
The output includes `planHash`. Repeat the same inputs with `--apply --expected-plan-hash HASH_FROM_PREVIEW` to write the reviewed plan. The generated skill includes your requirement, supplied knowledge, observed project evidence, and relevant declared checks. It is deterministic; no model or install script runs during generation.
|
|
56
|
+
|
|
57
|
+
| Client target | Generated path |
|
|
58
|
+
| --- | --- |
|
|
59
|
+
| `codex` | `.agents/skills/NAME/SKILL.md` |
|
|
60
|
+
| `claude-code` | `.claude/skills/NAME/SKILL.md` |
|
|
61
|
+
| `opencode` | `.opencode/skills/NAME/SKILL.md` |
|
|
62
|
+
| `deepseek-harness` | `.dsh/skills/NAME/SKILL.md` |
|
|
63
|
+
| `portable` | `.agents/skills/NAME/SKILL.md` |
|
|
64
|
+
|
|
65
|
+
Apply recomputes the preview, checks path safety and ownership, and refuses stale plans or files that were edited outside Project Kit. An unowned file is not overwritten, even if its name matches. Generated skills do not edit `AGENTS.md`, provider settings, or global skill directories. Host support and skill discovery still need to be checked in the client.
|
|
66
|
+
|
|
67
|
+
## 5. Connect the same local knowledge to your agent
|
|
68
|
+
|
|
69
|
+
```bash
|
|
70
|
+
shadow-brain project config . --target codex
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
Merge the printed recipe into the selected host's configuration. It includes the explicit project directory, project ID and local `--db` path. The connected MCP process then reads the same knowledge shown by the portal.
|
|
74
|
+
|
|
75
|
+
The local launch adds `project_inspect`, `project_knowledge`, `project_skill_preview`, `project_skill_apply`, and `project_feedback` to the regular memory tools. Preview/apply is a two-step operation. Saved text and observations remain reference material; they do not override current user instructions or the host's permissions.
|
|
76
|
+
|
|
77
|
+
## 6. Learn from reported outcomes
|
|
78
|
+
|
|
79
|
+
After a real task, record whether a selected memory helped. The **Memory outcomes** panel keeps the task, outcome, reason, optional evidence labels and reporter visible. A user report and an agent report remain distinguishable. Agents can call `project_feedback` after observing a concrete result; retrieval alone never creates positive feedback.
|
|
80
|
+
|
|
81
|
+
```bash
|
|
82
|
+
shadow-brain project feedback list .
|
|
83
|
+
shadow-brain project feedback record . --memory MEMORY_ID --task "Fix checkout retries" --rating useful --reason "The existing idempotency contract matched the passing retry regression check." --evidence "tests/checkout-retry.test.ts"
|
|
84
|
+
shadow-brain project feedback set off --project .
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
Use `useful`, `not-useful`, or `incorrect`. Record only an outcome you observed; the example reason is not a claim that your tests passed. Feedback is reported evidence, not an automatic truth verdict. The portal lets you remove a record or disable its influence while keeping the history available.
|
|
88
|
+
|
|
89
|
+
Adaptive retrieval applies a small signed adjustment only when the memory already matches the current task and the feedback task is relevant. Repeated identical reports are updated instead of counted again. User reports carry more weight than agent reports. Context Lab shows the applied signal and links to reported outcomes; diagnostic JSON retains record IDs. Legacy retrieval, unrelated projects, inactive memories, and empty-query browsing do not gain feedback influence.
|
|
90
|
+
|
|
91
|
+
This improves local reuse through outcome feedback. It does not train model weights, verify external sources, execute self-modifying code, or guarantee that an agent's next answer will be correct. [Learning rules and limits](LEARNING.md)
|
|
92
|
+
|
|
93
|
+
[Client integration](INTEGRATIONS.md) · [Context Lab](CONTEXT_LAB.md) · [Workspace guide](WORKSPACE.md)
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# Quickstart
|
|
2
|
+
|
|
3
|
+
This guide covers the 7.1.4 Brain Hub. Use Node.js 22.13 or later in the 22.x line, 24.x, or 26 and later.
|
|
4
|
+
|
|
5
|
+
## Install and open a project
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install -g @theihtisham/agent-shadow-brain@latest
|
|
9
|
+
shadow-brain --version
|
|
10
|
+
cd your-project
|
|
11
|
+
shadow-brain project workspace . --port 62595
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
Check that the CLI prints `7.1.4` for these steps. Keep the command running and open [the Brain Hub](http://127.0.0.1:62595/hub). The process writes project data inside the selected project’s `.shadow-brain` directory. On restart, run the same command from the same project directory. If you use `--port 0`, open the URL printed by the current process.
|
|
15
|
+
|
|
16
|
+
From a source checkout, use `npm ci` and `npm run build`, then replace `shadow-brain` with `node dist/cli.js` from the checkout. Pass the intended project directory as the workspace argument.
|
|
17
|
+
|
|
18
|
+

|
|
19
|
+
|
|
20
|
+
## Add your first evidence
|
|
21
|
+
|
|
22
|
+
1. In **Knowledge**, save explicit project knowledge or upload a PDF.
|
|
23
|
+
2. For a PDF, open an extracted page, read its citation, and approve the page you want to retrieve later. Scanned pages show that OCR is needed.
|
|
24
|
+
3. Open **Brain overview** and select a record. The node list offers the same selection with a keyboard.
|
|
25
|
+
4. In **Context**, describe the task and set a token budget. Build a pack or compare profiles, review selected sources, then copy the pack.
|
|
26
|
+
|
|
27
|
+

|
|
28
|
+
|
|
29
|
+
## Connect a host
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
shadow-brain project config . --target codex
|
|
33
|
+
shadow-brain skills install . --target codex
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
Merge the recipe into the selected host’s configuration. Preview the skill-file changes, then use `--apply` if you want them. Reconnect the host and confirm it can call a tool such as `project_inspect` or `context_pack`. Host file presence, recorded activity, and model evidence are shown separately. [Supported client recipes](INTEGRATIONS.md)
|
|
37
|
+
|
|
38
|
+
## Explore shared work
|
|
39
|
+
|
|
40
|
+
Create a room in **Collaboration**, add a task, and record a proposal or critique. A participant can claim the task, attach a project-relative artifact, and record a result. **Learning** turns recorded outcomes into candidates with explicit evaluation and promotion. [Workspace guide](WORKSPACE.md)
|
|
41
|
+
|
|
42
|
+
The classic workspace at `/workspace` provides detailed memory review, context selection, and retrieval feedback. `/live` opens the detailed journal. `shadow-brain demo workspace --port 0` runs a separate synthetic tour.
|
|
43
|
+
|
|
44
|
+
[Visual guide](VISUAL_GUIDE_v7.1.4.md) · [Troubleshooting](TROUBLESHOOTING.md)
|
package/docs/README.md
ADDED
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# Agent Shadow Brain documentation
|
|
2
|
+
|
|
3
|
+
Agent Shadow Brain 7.1.4 provides a local workspace, CLI, and standalone MCP service for project memory, task context, and generated project skills.
|
|
4
|
+
|
|
5
|
+
## Start and use the workspace
|
|
6
|
+
|
|
7
|
+
| Guide | Use it to |
|
|
8
|
+
| --- | --- |
|
|
9
|
+
| [Quickstart](QUICKSTART.md) | Install the exact version, launch the synthetic demo, and open your project workspace. |
|
|
10
|
+
| [Project Kit](PROJECT_KIT.md) | Inspect one project, save local knowledge, and preview and apply a tailored skill. |
|
|
11
|
+
| [Context Lab](CONTEXT_LAB.md) | Assemble, inspect, compare, and copy a task brief. |
|
|
12
|
+
| [Reported outcomes](LEARNING.md) | Record an observed result and inspect, pause, or remove its bounded influence on later retrieval. |
|
|
13
|
+
| [Workspace guide](WORKSPACE.md) | Review memory, work with typed links, check project health, and follow recorded activity. |
|
|
14
|
+
| [Features and limits](FEATURES_AND_LIMITS.md) | Distinguish implemented behavior from host prerequisites, estimates and unavailable metrics. |
|
|
15
|
+
| [Client integrations](INTEGRATIONS.md) | Configure MCP stdio, inspect project skill files, and understand which surfaces the client exposes. |
|
|
16
|
+
| [Workflow skills](WORKFLOW_INTEGRATION.md) | Preview or install the six focused project skills. |
|
|
17
|
+
| [Showcase](SHOWCASE.md) | See Project Kit, Context Lab, memory review, outcome feedback, and Live replay with synthetic data. |
|
|
18
|
+
|
|
19
|
+
## Architecture and evidence
|
|
20
|
+
|
|
21
|
+
- [Component guide](COMPONENTS.md) maps the shared paths and retained modules.
|
|
22
|
+
- [Agent memory approaches](COMPARISON.md) compares the documented architectures and tradeoffs of related systems.
|
|
23
|
+
- [Paired retrieval evaluation](evaluation/CONTEXT_EVALUATION_v7.1.4.md) reports 14 author-generated diagnostic cases against both profiles. [Raw results](evaluation/CONTEXT_EVALUATION_v7.1.4.json)
|
|
24
|
+
- [Research and acceptance plan](launch/RESEARCH_AND_PLAN_v7.1.4.md) records the research, implementation scope, and verification gates.
|
|
25
|
+
|
|
26
|
+
## Release and support
|
|
27
|
+
|
|
28
|
+
- [7.1.4 release notes](launch/RELEASE_NOTES_v7.1.4.md) cover compatibility, the demo, commands, and MCP access.
|
|
29
|
+
- [Changelog](../CHANGELOG.md) · [Historical versions](versions/README.md) · [7.0 migration notes](launch/RELEASE_NOTES_v7.0.0.md)
|
|
30
|
+
- [Troubleshooting](TROUBLESHOOTING.md) covers installation, storage, context, and local activity checks.
|
|
31
|
+
- [Open an issue](https://github.com/theihtishaam/agents-brain/issues) with the version, reproduction steps, and relevant diagnostics.
|
|
32
|
+
|
|
33
|
+
[Project README](../README.md)
|
|
@@ -0,0 +1,147 @@
|
|
|
1
|
+
# Shadow Brain — Roadmap to v7.0 and Beyond
|
|
2
|
+
|
|
3
|
+
> **Status:** Living document
|
|
4
|
+
> **Last updated:** 2026-05-12
|
|
5
|
+
> **Author:** @theihtisham
|
|
6
|
+
> **Companion docs:** `RELEASE_NOTES_v6.0.2.md`, `VIRAL-PLAYBOOK.md`
|
|
7
|
+
|
|
8
|
+
This is the strategic plan. v6.0.2 ("Singularity") shipped the substrate. v7.0 is where Shadow Brain becomes the default infrastructure for every AI coding agent on Earth.
|
|
9
|
+
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
## North Star
|
|
13
|
+
|
|
14
|
+
> **"Every line of code an AI agent writes anywhere should be able to draw on every relevant lesson your team has ever learned — instantly, locally, privately."**
|
|
15
|
+
|
|
16
|
+
That's it. The roadmap exists to compound toward that.
|
|
17
|
+
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
## v7.0 — "Multiplayer" (target: Q3 2026)
|
|
21
|
+
|
|
22
|
+
The theme is *plurality*. v6 made the brain smart; v7 makes it social.
|
|
23
|
+
|
|
24
|
+
### 🟥 Tier-S (no v7 without these)
|
|
25
|
+
|
|
26
|
+
#### S1. CRDT real-time team sync (Yjs)
|
|
27
|
+
Replace `team-sync` JSON-stomp protocol with **Yjs**. Two engineers on the same brain, concurrent edits, conflict-free. Figma-for-knowledge.
|
|
28
|
+
- Yjs Y.Doc per project
|
|
29
|
+
- WebSocket relay (default: free, self-hosted) + optional Cloudflare relay
|
|
30
|
+
- Encrypted-at-rest via existing `brain-encryption.ts`
|
|
31
|
+
- Backwards-compat shim for v6 team-sync clients
|
|
32
|
+
|
|
33
|
+
#### S2. VS Code Marketplace launch
|
|
34
|
+
The repo has `vscode-extension/` — it's not on the marketplace yet.
|
|
35
|
+
- Inline memory highlights ("Agent X learned this from file Y")
|
|
36
|
+
- Hover for entity provenance ("learned 2 weeks ago by Cursor, confirmed 3× by Claude")
|
|
37
|
+
- One-click "ask brain about this function"
|
|
38
|
+
- Codelens for files: "12 brain memories · 3 ADRs · 1 collision pending"
|
|
39
|
+
- Status bar: brain health · forgetting curve · last sync
|
|
40
|
+
- Publisher account: needs theihtisham@ Microsoft Partner Center setup
|
|
41
|
+
|
|
42
|
+
#### S3. SWE-Bench-Verified public leaderboard
|
|
43
|
+
v6.0.2 shipped the harness. v7 runs it for real.
|
|
44
|
+
- 50-problem SWE-Bench-Verified subset
|
|
45
|
+
- Brain off vs brain on for: Claude 4.7, GPT-5, DeepSeek V3, Llama 4
|
|
46
|
+
- Published dashboard at `brain.dev/leaderboard` (domain TBD)
|
|
47
|
+
- Numbers become the marketing — if brain delivers +20pp resolution, that's the headline
|
|
48
|
+
|
|
49
|
+
#### S4. Brain Exchange seeded with 10 canonical packs
|
|
50
|
+
The marketplace exists; the content doesn't. Pre-build and curate:
|
|
51
|
+
- React 19 · Next.js 16 · Vue 4 · Svelte 6
|
|
52
|
+
- Django 5 · Rails 8 · FastAPI · NestJS
|
|
53
|
+
- Rust async (Tokio/axum) · Solidity · Unity 6
|
|
54
|
+
- K8s ops · Postgres ops · Solana programs
|
|
55
|
+
Each pack: 200-500 high-signal entities, signed, MIT-licensed.
|
|
56
|
+
|
|
57
|
+
### 🟧 Tier-A (high impact)
|
|
58
|
+
|
|
59
|
+
#### A1. Mobile companion (React Native + Expo)
|
|
60
|
+
"Brain in your pocket."
|
|
61
|
+
- Voice capture: hold-to-talk → transcribe → ingest as memory
|
|
62
|
+
- Photo capture: snap a whiteboard → llava → memory entity
|
|
63
|
+
- Dashboard read-only view
|
|
64
|
+
- Notifications: "Your brain forgot X yesterday — restore?"
|
|
65
|
+
- Syncs via team-sync (Yjs)
|
|
66
|
+
|
|
67
|
+
#### A2. Multimodal v2 — real OCR + diagrams
|
|
68
|
+
v6.0.2 stubs OCR. v7 wires tesseract-wasm (zero install) for clean text extraction. Plus diagram parsing (Mermaid/PlantUML detection).
|
|
69
|
+
|
|
70
|
+
#### A3. Project-LoRA — actually trained
|
|
71
|
+
v6.0.2 ships the pipeline. v7 actually trains + publishes:
|
|
72
|
+
- 5 reference adapters on Hugging Face (one per canonical brain pack)
|
|
73
|
+
- Per-user trained adapters via paid tier (compute pass-through, no margin)
|
|
74
|
+
- Ollama Modelfile auto-generation
|
|
75
|
+
- A/B vs base model in eval harness
|
|
76
|
+
|
|
77
|
+
#### A4. Constitution v2 — auto-evolution
|
|
78
|
+
v6.0.2 reads `constitution.md` statically. v7 lets the brain **propose new rules** when it sees repeated violations of patterns. User approves → rule added. Living constitution.
|
|
79
|
+
|
|
80
|
+
#### A5. Time-travel UI in dashboard
|
|
81
|
+
Brain Replay is currently CLI/SVG. v7 ships an interactive React panel: drag-scrub, play, slow-motion, jump-to-milestone, full-screen.
|
|
82
|
+
|
|
83
|
+
### 🟨 Tier-B (high-leverage smaller bets)
|
|
84
|
+
|
|
85
|
+
- **B1.** Brain Exchange CLI commands: `shadow-brain exchange install react@latest` → ready in 5 seconds
|
|
86
|
+
- **B2.** Pricing tier signal: free → pro ($10/mo for team sync relay + LoRA training compute)
|
|
87
|
+
- **B3.** Public homepage: `brain.dev` (or `shadow-brain.dev`) with live demos
|
|
88
|
+
- **B4.** SDK in 3 langs: TypeScript (have it), Python, Rust — for embedding brain in any tool
|
|
89
|
+
- **B5.** "Ask the Hive" public demo — drop in a code snippet on the homepage, see the brain answer live (with rate limit)
|
|
90
|
+
- **B6.** Cursor / Cline / Aider plugins-on-their-marketplace (where they have one)
|
|
91
|
+
- **B7.** GitHub Action: `shadow-brain/learn-from-pr@v1` — every merged PR ingests its lessons
|
|
92
|
+
- **B8.** Brain garden v2 — actual knowledge-graph editor, not just a viz
|
|
93
|
+
|
|
94
|
+
### 🟩 Quality of life (do anytime)
|
|
95
|
+
|
|
96
|
+
- 30-second `demo` enhancements: add 3 themed sample projects (React, Django, Rust) the user can pick
|
|
97
|
+
- Per-platform installers: Homebrew tap, scoop, winget
|
|
98
|
+
- One-click migration from Cursor/Cline-stored prompts (if those tools expose any local memory)
|
|
99
|
+
- Brain "health report" weekly email (opt-in)
|
|
100
|
+
- "What did my brain learn today?" daily digest
|
|
101
|
+
|
|
102
|
+
---
|
|
103
|
+
|
|
104
|
+
## v7.5 — "Distributed" (target: Q4 2026)
|
|
105
|
+
|
|
106
|
+
### Big swings
|
|
107
|
+
|
|
108
|
+
- **Federated brains** — multiple teams' brains can selectively share concepts without merging fully. Cross-org learning without leaks.
|
|
109
|
+
- **Constitution federation** — share rules across projects with diff-and-approve flow
|
|
110
|
+
- **Real-time co-debugging** — two engineers + their brains + shared cursor on a bug, with hive-voice for decisions
|
|
111
|
+
- **Brain forking** — `shadow-brain fork --from theihtisham/react-pack` like GitHub for brains
|
|
112
|
+
- **Brain pull requests** — propose a change to a public brain, peer-reviewed
|
|
113
|
+
|
|
114
|
+
---
|
|
115
|
+
|
|
116
|
+
## v8.0 — "Self-Aware" (target: 2027)
|
|
117
|
+
|
|
118
|
+
The brain becomes meta-cognitive.
|
|
119
|
+
|
|
120
|
+
- **Self-tuning forgetting curve** — brain decides what to keep based on observed agent behavior, not heuristics
|
|
121
|
+
- **Brain self-debugging** — brain detects its own degraded recall and proposes interventions
|
|
122
|
+
- **Cross-brain federated learning** — multi-team adapters fine-tuned across consenting brains, privacy-preserving (DP-SGD or LoRA federation)
|
|
123
|
+
- **Predictive memory** — brain pre-fetches likely-needed memories *before* the agent asks, based on session trajectory
|
|
124
|
+
- **Brain handoff to humans** — handoff briefing generator: when a human takes over from an agent, get a one-page "what the agent thinks it knows + what it's uncertain about"
|
|
125
|
+
|
|
126
|
+
---
|
|
127
|
+
|
|
128
|
+
## What we will NOT build
|
|
129
|
+
|
|
130
|
+
Explicit anti-list. Saves time arguing.
|
|
131
|
+
|
|
132
|
+
- **Hosted-only SaaS shell** — defeats the local-first thesis. Always local-first; cloud is a relay, not a brain.
|
|
133
|
+
- **Closed core, open shell** — the brain stays MIT. Always.
|
|
134
|
+
- **LLM provider lock-in** — must work with Ollama / vLLM / any OpenAI-compat / Anthropic API equally.
|
|
135
|
+
- **Replacing the agent** — Shadow Brain is *for* agents, not a competing agent. Hermes-Devin-AutoGen territory is theirs.
|
|
136
|
+
- **Surveillance features** — no telemetry. No "anonymous usage data." Ever.
|
|
137
|
+
|
|
138
|
+
---
|
|
139
|
+
|
|
140
|
+
## How to push back on this roadmap
|
|
141
|
+
|
|
142
|
+
This document changes. File an issue at `github.com/theihtisham/agent-shadow-brain/issues` with:
|
|
143
|
+
- The item you disagree with
|
|
144
|
+
- What you'd do instead
|
|
145
|
+
- Why (with evidence — your team's experience, paper citation, etc.)
|
|
146
|
+
|
|
147
|
+
Strongest arguments win. The author reserves the right to be wrong publicly.
|
package/docs/SHARING.md
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# Share Agent Shadow Brain
|
|
2
|
+
|
|
3
|
+
## Short announcement
|
|
4
|
+
|
|
5
|
+
> Agent Shadow Brain 7.1.3 gives coding clients a shared local store for project decisions and lessons. Build a scoped context pack, review the memories behind it, and follow measured MCP calls in the live portal. Project skills and local MCP setup are available for Codex, Claude Code, OpenCode, and DeepSeek Harness.
|
|
6
|
+
|
|
7
|
+
[GitHub repository](https://github.com/ihtishaam-dev/agent-shadow-brain) · [7.1.3 release and recording](https://github.com/ihtishaam-dev/agent-shadow-brain/releases/tag/v7.1.3) · [npm package](https://www.npmjs.com/package/@theihtisham/agent-shadow-brain/v/7.1.3) · [Client setup](INTEGRATIONS.md)
|
|
8
|
+
|
|
9
|
+
## Demo caption
|
|
10
|
+
|
|
11
|
+
> Scripted local clients run real MCP calls against synthetic project memories. The live portal shows measured tool timing and marks explicitly reported task phases.
|
|
12
|
+
|
|
13
|
+
[Live screenshot](assets/live-v7.1.3.png) · [Workspace showcase](SHOWCASE.md)
|
package/docs/SHOWCASE.md
ADDED
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
# Workspace showcase
|
|
2
|
+
|
|
3
|
+
The images show the 7.1.4 workspace with synthetic projects, memory records, reviews, and links. The Project Kit images use a separate persistent synthetic project. The live views use scripted local MCP calls. Displayed phases come from explicit reports, and durations come from measured calls in that demo.
|
|
4
|
+
|
|
5
|
+
```bash
|
|
6
|
+
shadow-brain demo workspace --port 0
|
|
7
|
+
```
|
|
8
|
+
|
|
9
|
+
Open the printed **Workspace** or **Live view** address. Use `--no-activity` for a fixed initial journal snapshot.
|
|
10
|
+
|
|
11
|
+
## Project Kit
|
|
12
|
+
|
|
13
|
+
In a project-local workspace, inspect observed stack markers and declared checks. Save a knowledge record and use it when drafting a skill for the selected client.
|
|
14
|
+
|
|
15
|
+

|
|
16
|
+
|
|
17
|
+
Review the generated `SKILL.md` and its destination before applying it. The preview includes the user-supplied requirement and available checks.
|
|
18
|
+
|
|
19
|
+

|
|
20
|
+
|
|
21
|
+
### Reported memory outcomes
|
|
22
|
+
|
|
23
|
+
Record an observed result with a task, rating, reason, and optional references. The saved card shows the reporter and gives the user a way to remove the report. The switch controls whether later adaptive retrieval can use the reports.
|
|
24
|
+
|
|
25
|
+

|
|
26
|
+
|
|
27
|
+
The next matching task shows the report's signed contribution alongside the other ranking signals.
|
|
28
|
+
|
|
29
|
+

|
|
30
|
+
|
|
31
|
+
## Overview and attention queue
|
|
32
|
+
|
|
33
|
+
Choose the project scope, review source coverage, and open a record from the attention queue. The queue flags conditions that merit inspection, including contested records and missing references.
|
|
34
|
+
|
|
35
|
+

|
|
36
|
+
|
|
37
|
+
## Context Lab
|
|
38
|
+
|
|
39
|
+
Assemble a brief, check its estimated tokens and rendered characters, then expand a candidate to see matched fields, ranking contributions, or a recorded link path.
|
|
40
|
+
|
|
41
|
+

|
|
42
|
+
|
|
43
|
+
### Compare profiles
|
|
44
|
+
|
|
45
|
+
Compare the same task and scope with Adaptive and Legacy. The result lists which memories each profile adds and shows their estimated usage.
|
|
46
|
+
|
|
47
|
+

|
|
48
|
+
|
|
49
|
+
## Memory review and graph
|
|
50
|
+
|
|
51
|
+
Inspect a saved record, its recorded references, and manual review controls. A review change is recorded in revision history.
|
|
52
|
+
|
|
53
|
+

|
|
54
|
+
|
|
55
|
+
Select an edge or focus the recorded relationships around one memory. The workspace distinguishes these relations from project membership and recording-agent links.
|
|
56
|
+
|
|
57
|
+

|
|
58
|
+
|
|
59
|
+
## Integrations and features
|
|
60
|
+
|
|
61
|
+
Read the documented capabilities and generate a setup example for the client. A project skill-file check and a live client handshake provide different evidence.
|
|
62
|
+
|
|
63
|
+

|
|
64
|
+
|
|
65
|
+
Choose when context, session briefings, and activity are available. The workspace keeps activity visibility and journal recording as separate controls.
|
|
66
|
+
|
|
67
|
+

|
|
68
|
+
|
|
69
|
+
## Live operations and recorded replay
|
|
70
|
+
|
|
71
|
+
Select a session or event to inspect the available history. The session network, timeline, and charts distinguish measured tool activity from explicit host reports.
|
|
72
|
+
|
|
73
|
+

|
|
74
|
+
|
|
75
|
+
Replay navigates the loaded journal slice. Move to an event with the slider or step controls and return to the live stream when finished.
|
|
76
|
+
|
|
77
|
+

|
|
78
|
+
|
|
79
|
+

|
|
80
|
+
|
|
81
|
+
## Mobile layout
|
|
82
|
+
|
|
83
|
+
Use the workspace on a narrow viewport to inspect the same saved records and context.
|
|
84
|
+
|
|
85
|
+

|
|
86
|
+
|
|
87
|
+
[Project Kit guide](PROJECT_KIT.md) · [Context Lab guide](CONTEXT_LAB.md) · [Workspace guide](WORKSPACE.md) · [Client integrations](INTEGRATIONS.md)
|
package/docs/STATS.md
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# Package and repository statistics
|
|
2
|
+
|
|
3
|
+
Last successful refresh: **2026-11-13T10:46:49.286Z**. Counts are snapshots from public npm and GitHub APIs.
|
|
4
|
+
|
|
5
|
+
| Metric | Count | Coverage |
|
|
6
|
+
| --- | ---: | --- |
|
|
7
|
+
| npm total downloads | **6,030** | 2026-04-10 through 2026-11-12, inclusive |
|
|
8
|
+
| npm latest day | 79 | 2026-11-12 through 2026-11-12 |
|
|
9
|
+
| npm last 7 days | 725 | 2026-11-06 through 2026-11-12 |
|
|
10
|
+
| npm last 30 days | 819 | 2026-10-14 through 2026-11-12 |
|
|
11
|
+
| GitHub stars | 0 | At refresh |
|
|
12
|
+
| GitHub forks | 0 | At refresh |
|
|
13
|
+
| GitHub watchers | 0 | At refresh |
|
|
14
|
+
|
|
15
|
+
The package was created on 2026-04-10. The total sums non-overlapping ranges of at most 365 days from creation through the latest complete day returned by npm. This handles the API's 18-month request limit without silently truncating lifetime counts. npm counts downloads, including automated installs; these are not unique people or active users.
|
|
16
|
+
|
|
17
|
+
The dedicated **README metrics** workflow refreshes this page and the total-download badge daily. A failed request preserves the last successful snapshot. Weekly and monthly README badges use Shields' live npm endpoints and may refresh at different times.
|
|
18
|
+
|
|
19
|
+
[Raw snapshot and coverage](npm-metrics.json) · [npm download API documentation](https://github.com/npm/registry/blob/main/docs/download-counts.md) · [Package](https://www.npmjs.com/package/@theihtisham/agent-shadow-brain) · [Repository](https://github.com/theihtishaam/agents-brain)
|
|
20
|
+
|
|
21
|
+
Historical snapshots in [stats-history.json](stats-history.json) come from the previous monitoring implementation and are not used to calculate this total.
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# Troubleshooting
|
|
2
|
+
|
|
3
|
+
## The Hub says Workspace unavailable
|
|
4
|
+
|
|
5
|
+
Keep the launcher running and open the current URL. If an older tab points to a stopped server, start the same project on the same port and refresh. A port of `0` can change each time.
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
cd your-project
|
|
9
|
+
shadow-brain project workspace . --port 62595
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Open `http://127.0.0.1:62595/hub`. The status endpoint at `/api/workspace/status` reports the process instance, workspace mode, project scope, and storage health. A reachable server can report a storage error separately. Resolve the storage error before making changes and retain the existing project files. If the port is already in use, check the existing launcher or start on a free port and use the new address.
|
|
13
|
+
|
|
14
|
+
## The installed version differs from this guide
|
|
15
|
+
|
|
16
|
+
This guide describes the 7.1.4 build. It requires Node.js 22.13+ in the 22.x line, 24.x, or 26+.
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
node --version
|
|
20
|
+
npm install -g @theihtisham/agent-shadow-brain@latest
|
|
21
|
+
shadow-brain --version
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
If the command still reports the previous version, locate it with `Get-Command shadow-brain -All` in PowerShell or `command -v shadow-brain` in your shell. Restart the launcher after changing versions. A browser refresh alone continues using the old process.
|
|
25
|
+
|
|
26
|
+
## The graph or journal is empty
|
|
27
|
+
|
|
28
|
+
Check the selected project. Save a knowledge record or approve a PDF page to create a graph record. Connect a host using the recipe generated from the same project directory. In **Setup**, enable **Live dashboard activity** and **Record agent activity**. Ask the host to call `project_inspect` or `context_pack`, then look for the event. A reachable workspace and installed skill files are independent of host tool activity.
|
|
29
|
+
|
|
30
|
+
## A feature setting or claim changed elsewhere
|
|
31
|
+
|
|
32
|
+
Refresh to read the current revision before retrying. For a task claim, check its owner and lease. After a network failure, retry the same input to reuse the operation key. The work room and journal use different stores and can be inspected independently.
|
|
33
|
+
|
|
34
|
+
## A PDF page has no text
|
|
35
|
+
|
|
36
|
+
Image-only pages require OCR. The current Hub extracts a text layer and labels missing text. Upload a text-searchable PDF or save a verified excerpt as explicit project knowledge with its reference.
|
|
37
|
+
|
|
38
|
+
## A context pack is empty or shorter than expected
|
|
39
|
+
|
|
40
|
+
Check that the selected project contains relevant active memories, the context feature is enabled, and the token budget allows an excerpt. Try specific project terms. Context estimates describe the rendered pack. Model usage stays unavailable when the host supplies no usage receipts.
|
|
41
|
+
|
|
42
|
+
[Quickstart](QUICKSTART.md) · [Workspace guide](WORKSPACE.md) · [Integrations](INTEGRATIONS.md)
|