@vortex-os/base 0.0.1
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 +21 -0
- package/README.md +63 -0
- package/dist/index.d.ts +24 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +22 -0
- package/dist/index.js.map +1 -0
- package/package.json +54 -0
- package/src/index.ts +33 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 dydan77
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
# @vortex-os/base
|
|
2
|
+
|
|
3
|
+
Base framework entry point for **VortEX** — a Multi-Agent Personal AI Work OS.
|
|
4
|
+
|
|
5
|
+
> This is the initial release (0.0.1) and exposes framework metadata only. The full v0.1.0 — which aggregates the framework's modules into a single importable surface — ships in a follow-up cycle. See [phase-10-split-plan.md](https://github.com/dydan77/vortex/blob/main/docs/phase-10-split-plan.md) for the capability-cluster packaging design.
|
|
6
|
+
|
|
7
|
+
## Install
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm install @vortex-os/base
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Usage (0.0.1)
|
|
14
|
+
|
|
15
|
+
```ts
|
|
16
|
+
import { FRAMEWORK_META, VORTEX_BASE_VERSION } from "@vortex-os/base";
|
|
17
|
+
|
|
18
|
+
console.log(FRAMEWORK_META);
|
|
19
|
+
// {
|
|
20
|
+
// version: "0.0.1",
|
|
21
|
+
// framework: "vortex-os",
|
|
22
|
+
// fullReleaseTarget: "0.1.0",
|
|
23
|
+
// designReference: "...",
|
|
24
|
+
// repository: "...",
|
|
25
|
+
// }
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
## What ships in v0.1.0
|
|
29
|
+
|
|
30
|
+
`@vortex-os/base` v0.1.0 will re-export the framework's modules as a single package:
|
|
31
|
+
|
|
32
|
+
- `core` — frontmatter, privacy, types, ModuleContext
|
|
33
|
+
- `slash-commands` — Command, CommandRegistry, runSlash
|
|
34
|
+
- `memory-system` — markdown-frontmatter memory layer
|
|
35
|
+
- `til` — daily work-log store
|
|
36
|
+
- `decision-log` — decision-log store
|
|
37
|
+
- `runbooks` — runbook store
|
|
38
|
+
- `index-generator` — `_INDEX.md` rendering
|
|
39
|
+
- `link-rewriter` — wiki-link detect / resolve / check / rewrite
|
|
40
|
+
- `data-lint` — directory linter
|
|
41
|
+
- `report-generator` — HTML reports with privacy filtering
|
|
42
|
+
- `ai-coding-pitfalls` — coding pitfall catalog
|
|
43
|
+
- `tool-rules` — tool usage rules catalog
|
|
44
|
+
- `session-rituals` plugin — `/session-start`, `/reindex`, `/decision`, `/til`, `/vortex`
|
|
45
|
+
|
|
46
|
+
## Capability add-ons (Phase 11+)
|
|
47
|
+
|
|
48
|
+
Future capability clusters publish as siblings under the `@vortex-os` scope:
|
|
49
|
+
|
|
50
|
+
- `@vortex-os/memory-extended` (Phase 11) — sqlite + vector + recall for scale + semantic search
|
|
51
|
+
- `@vortex-os/dev-toolkit` (Phase 12) — vibe coding + self-QA + CI/CD assistance
|
|
52
|
+
- `@vortex-os/vision` (Phase 14, under review) — screen context + visual reasoning
|
|
53
|
+
|
|
54
|
+
Each add-on installs alongside the base and extends what the agent can do without forcing a base upgrade.
|
|
55
|
+
|
|
56
|
+
## Related
|
|
57
|
+
|
|
58
|
+
- [VortEX framework](https://github.com/dydan77/vortex) — integration template + current monorepo source
|
|
59
|
+
- [Phase 10 split plan](https://github.com/dydan77/vortex/blob/main/docs/phase-10-split-plan.md) — capability-cluster design (revision 2)
|
|
60
|
+
|
|
61
|
+
## License
|
|
62
|
+
|
|
63
|
+
MIT — see [LICENSE](./LICENSE).
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @vortex-os/base — base framework entry point for VortEX.
|
|
3
|
+
*
|
|
4
|
+
* This is the initial release (0.0.1). The full v0.1.0 will aggregate the
|
|
5
|
+
* framework modules (core, slash-commands, til, decision-log, memory-system,
|
|
6
|
+
* runbooks, data-lint, link-rewriter, index-generator, report-generator,
|
|
7
|
+
* ai-coding-pitfalls, tool-rules, session-rituals) into a single importable
|
|
8
|
+
* surface, plus an add-on discovery hook. See
|
|
9
|
+
* https://github.com/dydan77/vortex/blob/main/docs/phase-10-split-plan.md
|
|
10
|
+
* (Phase 10 split plan v2 — capability-cluster) for the shape.
|
|
11
|
+
*
|
|
12
|
+
* Until v0.1.0 lands, this package exposes framework metadata only.
|
|
13
|
+
*/
|
|
14
|
+
export declare const VORTEX_BASE_VERSION: "0.0.1";
|
|
15
|
+
/** Framework metadata available at install time, without pulling in any module. */
|
|
16
|
+
export interface VortexFrameworkMeta {
|
|
17
|
+
readonly version: string;
|
|
18
|
+
readonly framework: "vortex-os";
|
|
19
|
+
readonly fullReleaseTarget: string;
|
|
20
|
+
readonly designReference: string;
|
|
21
|
+
readonly repository: string;
|
|
22
|
+
}
|
|
23
|
+
export declare const FRAMEWORK_META: VortexFrameworkMeta;
|
|
24
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,eAAO,MAAM,mBAAmB,EAAG,OAAgB,CAAC;AAEpD,mFAAmF;AACnF,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC;IAChC,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC;IACnC,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IACjC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;CAC7B;AAED,eAAO,MAAM,cAAc,EAAE,mBAO5B,CAAC"}
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @vortex-os/base — base framework entry point for VortEX.
|
|
3
|
+
*
|
|
4
|
+
* This is the initial release (0.0.1). The full v0.1.0 will aggregate the
|
|
5
|
+
* framework modules (core, slash-commands, til, decision-log, memory-system,
|
|
6
|
+
* runbooks, data-lint, link-rewriter, index-generator, report-generator,
|
|
7
|
+
* ai-coding-pitfalls, tool-rules, session-rituals) into a single importable
|
|
8
|
+
* surface, plus an add-on discovery hook. See
|
|
9
|
+
* https://github.com/dydan77/vortex/blob/main/docs/phase-10-split-plan.md
|
|
10
|
+
* (Phase 10 split plan v2 — capability-cluster) for the shape.
|
|
11
|
+
*
|
|
12
|
+
* Until v0.1.0 lands, this package exposes framework metadata only.
|
|
13
|
+
*/
|
|
14
|
+
export const VORTEX_BASE_VERSION = "0.0.1";
|
|
15
|
+
export const FRAMEWORK_META = {
|
|
16
|
+
version: VORTEX_BASE_VERSION,
|
|
17
|
+
framework: "vortex-os",
|
|
18
|
+
fullReleaseTarget: "0.1.0",
|
|
19
|
+
designReference: "https://github.com/dydan77/vortex/blob/main/docs/phase-10-split-plan.md",
|
|
20
|
+
repository: "https://github.com/vortex-os-project/base",
|
|
21
|
+
};
|
|
22
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,MAAM,CAAC,MAAM,mBAAmB,GAAG,OAAgB,CAAC;AAWpD,MAAM,CAAC,MAAM,cAAc,GAAwB;IACjD,OAAO,EAAE,mBAAmB;IAC5B,SAAS,EAAE,WAAW;IACtB,iBAAiB,EAAE,OAAO;IAC1B,eAAe,EACb,yEAAyE;IAC3E,UAAU,EAAE,2CAA2C;CACxD,CAAC"}
|
package/package.json
ADDED
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@vortex-os/base",
|
|
3
|
+
"version": "0.0.1",
|
|
4
|
+
"description": "Base framework entry point for VortEX (placeholder — full v0.1.0 ships in a follow-up cycle).",
|
|
5
|
+
"license": "MIT",
|
|
6
|
+
"author": "dydan77 <styxii77@nate.com>",
|
|
7
|
+
"homepage": "https://github.com/vortex-os-project/base#readme",
|
|
8
|
+
"bugs": {
|
|
9
|
+
"url": "https://github.com/vortex-os-project/base/issues"
|
|
10
|
+
},
|
|
11
|
+
"repository": {
|
|
12
|
+
"type": "git",
|
|
13
|
+
"url": "git+https://github.com/vortex-os-project/base.git"
|
|
14
|
+
},
|
|
15
|
+
"keywords": [
|
|
16
|
+
"vortex",
|
|
17
|
+
"vortex-os",
|
|
18
|
+
"framework",
|
|
19
|
+
"agent",
|
|
20
|
+
"ai-os",
|
|
21
|
+
"multi-agent",
|
|
22
|
+
"personal-knowledge-base"
|
|
23
|
+
],
|
|
24
|
+
"type": "module",
|
|
25
|
+
"main": "./dist/index.js",
|
|
26
|
+
"types": "./dist/index.d.ts",
|
|
27
|
+
"exports": {
|
|
28
|
+
".": {
|
|
29
|
+
"types": "./dist/index.d.ts",
|
|
30
|
+
"default": "./dist/index.js"
|
|
31
|
+
}
|
|
32
|
+
},
|
|
33
|
+
"files": [
|
|
34
|
+
"dist",
|
|
35
|
+
"src",
|
|
36
|
+
"README.md",
|
|
37
|
+
"LICENSE"
|
|
38
|
+
],
|
|
39
|
+
"scripts": {
|
|
40
|
+
"build": "tsc -p tsconfig.json",
|
|
41
|
+
"typecheck": "tsc -p tsconfig.json --noEmit",
|
|
42
|
+
"prepublishOnly": "npm run build"
|
|
43
|
+
},
|
|
44
|
+
"devDependencies": {
|
|
45
|
+
"@types/node": "^24.0.0",
|
|
46
|
+
"typescript": "^5.9.0"
|
|
47
|
+
},
|
|
48
|
+
"engines": {
|
|
49
|
+
"node": ">=22"
|
|
50
|
+
},
|
|
51
|
+
"publishConfig": {
|
|
52
|
+
"access": "public"
|
|
53
|
+
}
|
|
54
|
+
}
|
package/src/index.ts
ADDED
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @vortex-os/base — base framework entry point for VortEX.
|
|
3
|
+
*
|
|
4
|
+
* This is the initial release (0.0.1). The full v0.1.0 will aggregate the
|
|
5
|
+
* framework modules (core, slash-commands, til, decision-log, memory-system,
|
|
6
|
+
* runbooks, data-lint, link-rewriter, index-generator, report-generator,
|
|
7
|
+
* ai-coding-pitfalls, tool-rules, session-rituals) into a single importable
|
|
8
|
+
* surface, plus an add-on discovery hook. See
|
|
9
|
+
* https://github.com/dydan77/vortex/blob/main/docs/phase-10-split-plan.md
|
|
10
|
+
* (Phase 10 split plan v2 — capability-cluster) for the shape.
|
|
11
|
+
*
|
|
12
|
+
* Until v0.1.0 lands, this package exposes framework metadata only.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
export const VORTEX_BASE_VERSION = "0.0.1" as const;
|
|
16
|
+
|
|
17
|
+
/** Framework metadata available at install time, without pulling in any module. */
|
|
18
|
+
export interface VortexFrameworkMeta {
|
|
19
|
+
readonly version: string;
|
|
20
|
+
readonly framework: "vortex-os";
|
|
21
|
+
readonly fullReleaseTarget: string;
|
|
22
|
+
readonly designReference: string;
|
|
23
|
+
readonly repository: string;
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
export const FRAMEWORK_META: VortexFrameworkMeta = {
|
|
27
|
+
version: VORTEX_BASE_VERSION,
|
|
28
|
+
framework: "vortex-os",
|
|
29
|
+
fullReleaseTarget: "0.1.0",
|
|
30
|
+
designReference:
|
|
31
|
+
"https://github.com/dydan77/vortex/blob/main/docs/phase-10-split-plan.md",
|
|
32
|
+
repository: "https://github.com/vortex-os-project/base",
|
|
33
|
+
};
|