@vortex-os/base 0.1.0 → 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.
- package/LICENSE +1 -1
- package/README.md +113 -77
- package/dist/index.d.ts +1609 -166
- package/dist/index.js +3369 -528
- package/dist/index.js.map +1 -1
- package/package.json +63 -61
package/LICENSE
CHANGED
package/README.md
CHANGED
|
@@ -1,77 +1,113 @@
|
|
|
1
|
-
# @vortex-os/base
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
```
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
1
|
+
# @vortex-os/base
|
|
2
|
+
|
|
3
|
+
```
|
|
4
|
+
__ __ _ _____ __
|
|
5
|
+
\ \ / ___ _ _| |_| __\ \/ /
|
|
6
|
+
\ V / _ | '_| _| _| > <
|
|
7
|
+
\_/\___|_| \__|___/_/\_\
|
|
8
|
+
Vortex absorbs context · EX executes it
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
Base entry point for **VortEX** — a Multi-Agent Personal AI Work OS framework.
|
|
12
|
+
|
|
13
|
+
`@vortex-os/base` bundles the framework's 14 internal workspaces (core utilities, slash-command runtime, memory store, daily-log store, decision-log store, runbook store, link-rewriter, index-generator, data-linter, report-generator, two catalog modules, the proactive-curator proposal engine, and the session-rituals plugin) into a single installable package. Install once, get the whole framework.
|
|
14
|
+
|
|
15
|
+
## Install
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
npm install @vortex-os/base
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## Usage
|
|
22
|
+
|
|
23
|
+
```ts
|
|
24
|
+
import {
|
|
25
|
+
core,
|
|
26
|
+
slashCommands,
|
|
27
|
+
memorySystem,
|
|
28
|
+
worklog,
|
|
29
|
+
decisionLog,
|
|
30
|
+
proactiveCurator,
|
|
31
|
+
sessionRituals,
|
|
32
|
+
} from "@vortex-os/base";
|
|
33
|
+
|
|
34
|
+
// Use the slash-rituals registry against your own data directory
|
|
35
|
+
const registry = sessionRituals.createRitualRegistry();
|
|
36
|
+
const ctx = core.makeContext(process.cwd());
|
|
37
|
+
|
|
38
|
+
await slashCommands.runSlash("/session-start", { registry, context: ctx });
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
### Opt-in `/curate` surface
|
|
42
|
+
|
|
43
|
+
The `/curate` command is opt-in because it needs a host-supplied LLM adapter. To enable it on Claude Code, wire a sub-agent invoker:
|
|
44
|
+
|
|
45
|
+
```ts
|
|
46
|
+
import { proactiveCurator, sessionRituals } from "@vortex-os/base";
|
|
47
|
+
|
|
48
|
+
const llm = new proactiveCurator.ClaudeCodeLLMJudge(async ({ prompt }) => {
|
|
49
|
+
// Host-specific sub-agent invocation; return the sub-agent's raw answer.
|
|
50
|
+
return await invokeMySubAgent(prompt);
|
|
51
|
+
});
|
|
52
|
+
|
|
53
|
+
const registry = sessionRituals.createRitualRegistry({
|
|
54
|
+
curate: {
|
|
55
|
+
llm,
|
|
56
|
+
// Optional — supply the in-session insight surface with recent turns.
|
|
57
|
+
insightInputProvider: () => ({
|
|
58
|
+
recentTurns: myTurnBuffer.recent(20),
|
|
59
|
+
accumulatedTokens: myTurnBuffer.tokenCount(),
|
|
60
|
+
}),
|
|
61
|
+
},
|
|
62
|
+
});
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
Without an `LLMJudge`, `/curate` is simply absent (graceful degradation); the rest of the rituals work unchanged.
|
|
66
|
+
|
|
67
|
+
## Exported namespaces
|
|
68
|
+
|
|
69
|
+
Each internal workspace is exposed as a top-level namespace on the package:
|
|
70
|
+
|
|
71
|
+
| Namespace | Source workspace | Role |
|
|
72
|
+
|---|---|---|
|
|
73
|
+
| `core` | `@vortex-os/core` | Frontmatter parser (BOM-safe), three-tier privacy filter, `ModuleContext` path resolver, shared types |
|
|
74
|
+
| `slashCommands` | `@vortex-os/slash-commands` | `Command`, `CommandRegistry`, `runSlash` primitives |
|
|
75
|
+
| `memorySystem` | `@vortex-os/memory-system` | Markdown-frontmatter memory store + `MEMORY.md` index writer + diff helpers |
|
|
76
|
+
| `dataLint` | `@vortex-os/data-lint` | Pluggable linter for markdown directories (frontmatter / privacy / wiki-link checks) |
|
|
77
|
+
| `aiCodingPitfalls` | `@vortex-os/ai-coding-pitfalls` | Typed catalog of AI coding pitfall patterns |
|
|
78
|
+
| `toolRules` | `@vortex-os/tool-rules` | Typed catalog of tool usage rules |
|
|
79
|
+
| `reportGenerator` | `@vortex-os/report-generator` | HTML reports with privacy-marker section filtering |
|
|
80
|
+
| `worklog` | `@vortex-os/worklog` | Daily work-log store with year/month layout |
|
|
81
|
+
| `decisionLog` | `@vortex-os/decision-log` | Decision-log store with template-driven entry creation |
|
|
82
|
+
| `indexGenerator` | `@vortex-os/index-generator` | `_INDEX.md` rendering (flat + nested modes) |
|
|
83
|
+
| `runbooks` | `@vortex-os/runbooks` | Runbook store with `last_tested`-based stale detection |
|
|
84
|
+
| `linkRewriter` | `@vortex-os/link-rewriter` | Wiki-link extract / resolve / check / rewrite |
|
|
85
|
+
| `proactiveCurator` | `@vortex-os/proactive-curator` | Topic-aware proposal engine — in-session insight capture + hub auto-curation with 4-action active placement (`create-folder` / `create-file` / `append-section` / `update-file`). Asymmetric LLM gate for hub thresholds (3 weak / 5 strong). Decline durability + Claude Code `LLMJudge` adapter. |
|
|
86
|
+
| `sessionRituals` | `@vortex-os/session-rituals` | Daily session-loop slash commands: `/session-start`, `/reindex`, `/decision`, `/log`, `/vortex`, `/curate`, `/recall` |
|
|
87
|
+
|
|
88
|
+
## Capability add-ons (Phase 11+)
|
|
89
|
+
|
|
90
|
+
Future capability clusters publish as siblings under the `@vortex-os` scope and install alongside the base. The base auto-detects installed add-ons at session-start:
|
|
91
|
+
|
|
92
|
+
- **`@vortex-os/memory-extended@0.5.0` (Phase 11) — shipped** — all five namespaces are live: `sqlite` (structured index + drift detection), `vector` (brute-force cosine backend, local `multilingual-e5-small` embedder), `recall` (two-stage hybrid `/recall` over memories *and* conversation sessions), `sessionArchive` (four first-party host adapters: Claude Code, Codex, Gemini, Claude Desktop), `consolidate` (post-session memory-candidate proposer). Peer-depends on this base. See [memory-extended-design.md](https://github.com/vortex-os-project/vortex/blob/main/docs/memory-extended-design.md).
|
|
93
|
+
- `@vortex-os/dev-toolkit` (Phase 12) — vibe coding + self-QA + CI/CD assistance.
|
|
94
|
+
- `@vortex-os/vision` (Phase 14, under review) — screen context + visual reasoning.
|
|
95
|
+
|
|
96
|
+
Each add-on installs alongside the base and extends what the agent can do without forcing a base upgrade.
|
|
97
|
+
|
|
98
|
+
## Packaging notes
|
|
99
|
+
|
|
100
|
+
- **Bundled**: all 14 workspaces are bundled into the published artifact via `tsup`. Consumers do not need to install workspace packages individually.
|
|
101
|
+
- **External dependency**: `yaml` is left as a runtime dependency (npm resolves it on install).
|
|
102
|
+
- **Format**: ESM only. `"type": "module"` in your consumer is required (or set up `.mjs`).
|
|
103
|
+
- **Types**: a single `dist/index.d.ts` exposes all namespace types.
|
|
104
|
+
|
|
105
|
+
## Related
|
|
106
|
+
|
|
107
|
+
- [VortEX framework repository](https://github.com/vortex-os-project/vortex) — source, design docs, integration template for instances
|
|
108
|
+
- [Phase 10 split plan v2](https://github.com/vortex-os-project/vortex/blob/main/docs/phase-10-split-plan.md) — capability-cluster packaging design
|
|
109
|
+
- [Memory-extended design](https://github.com/vortex-os-project/vortex/blob/main/docs/memory-extended-design.md) — Phase 11 (memory-extended add-on) reference
|
|
110
|
+
|
|
111
|
+
## License
|
|
112
|
+
|
|
113
|
+
MIT — see [LICENSE](./LICENSE).
|