@vortex-os/base 0.4.0 → 0.6.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 +26 -14
- package/dist/catch-up-GDDKPZHJ.js +8 -0
- package/dist/{chunk-6SO4DAWJ.js → chunk-3L5DLEGP.js} +6 -9
- package/dist/chunk-3L5DLEGP.js.map +1 -0
- package/dist/chunk-PZ5AY32C.js +10 -0
- package/dist/chunk-PZ5AY32C.js.map +1 -0
- package/dist/index.d.ts +672 -80
- package/dist/index.js +0 -0
- package/dist/index.js.map +1 -1
- package/dist/vectorize-PN4Y7XMO.js +30 -0
- package/dist/vectorize-PN4Y7XMO.js.map +1 -0
- package/package.json +2 -2
- package/templates/commands/recall.md +31 -17
- package/templates/commands/resume.md +52 -0
- package/templates/config/vortex.json +3 -0
- package/templates/manifest.json +56 -0
- package/templates/routers/.cursorrules +5 -5
- package/templates/routers/AGENTS.md +22 -13
- package/templates/routers/AI-RULES.md +143 -0
- package/templates/routers/CLAUDE.md +23 -4
- package/templates/routers/GEMINI.md +5 -3
- package/dist/catch-up-ZQN7HMMN.js +0 -7
- package/dist/chunk-6SO4DAWJ.js.map +0 -1
- package/templates/routers/AGENT.md +0 -93
- package/templates/routers/CODEX.md +0 -16
- /package/dist/{catch-up-ZQN7HMMN.js.map → catch-up-GDDKPZHJ.js.map} +0 -0
|
@@ -1,93 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
type: agent-entry
|
|
3
|
-
status: active
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# VortEX Instance — Multi-Agent Personal AI Work OS
|
|
7
|
-
|
|
8
|
-
> A vortex absorbing context, an executable runtime running it through agents.
|
|
9
|
-
|
|
10
|
-
This is the unified entry point for every agent working in this instance (Claude Code, Codex CLI, Gemini CLI, Cursor). The per-agent files (`CLAUDE.md`, `AGENTS.md`, `CODEX.md`, `GEMINI.md`, `.cursorrules`) all route here — this file is the single source of truth.
|
|
11
|
-
|
|
12
|
-
This instance was created from the `@vortex-os/base` framework. The framework code lives in `node_modules/@vortex-os/`; you do not edit it. You work in `data/` — your own content — and use the `vortex` CLI and the `/`-commands it installs.
|
|
13
|
-
|
|
14
|
-
## First thing to check
|
|
15
|
-
|
|
16
|
-
If `data/_memory/user_profile.md` is missing, this instance has not been set up yet. Run:
|
|
17
|
-
|
|
18
|
-
```
|
|
19
|
-
npx vortex init --name "<your name>" --role "<your role>" --task "<what you're working on>"
|
|
20
|
-
```
|
|
21
|
-
|
|
22
|
-
`init` creates a user-profile memory, today's first worklog, the agent slash-commands, and wires the session hooks. Everything after that grows as you work.
|
|
23
|
-
|
|
24
|
-
## How VortEX behaves by default — auto the plumbing, propose the prose
|
|
25
|
-
|
|
26
|
-
Operating principle: **auto-maintain the operational memory; propose changes to the knowledge base.** You should never have to learn commands to get value — the records that make recall smarter accumulate on their own, while you keep full control over your own topic documentation.
|
|
27
|
-
|
|
28
|
-
**Auto (no prompt — append-only operational records; *show, don't ask*):**
|
|
29
|
-
- **Session start.** Run the start ritual: if a sync remote is configured, `git pull` (report conflicts, never auto-resolve); detect the environment if one is configured; backfill any worklog missing from prior sessions; report status (recent work, what's in progress, the time). Where the `SessionStart` hook is configured this runs automatically; otherwise perform it as the first action of the session.
|
|
30
|
-
- **Worklog.** As a work unit completes — and at session wind-down ("that's it for today", "wrap up") — ensure today's worklog exists and append the work. The agent is the primary path; the `SessionEnd` hook is the net.
|
|
31
|
-
- **Decisions.** When the user makes a *substantive* decision ("let's go with X"), record it in the Decision Log. Real decisions, not casual asides.
|
|
32
|
-
- **Ambient recall** (read-only). When the user references earlier work, run `/recall <the reference>` and weave a confident hit into one sentence. One nudge, not a list; drop it if waved off.
|
|
33
|
-
|
|
34
|
-
These are **append-only and transparent**: do them without a yes/no prompt, but surface a brief, non-blocking note so the user always sees what was recorded. Everything lands in git and is reversible; disable any of them via `.agent/vortex.json` (`autoRecord.*`). `git push` stays **explicit**, never automatic.
|
|
35
|
-
|
|
36
|
-
**Propose (ask first — the one place friction is intentional):**
|
|
37
|
-
- **Knowledge-base documentation.** Changes to the user's topic documentation (the `data/<topic>/` tree and hubs) are **proposed, never auto-written**: "you've done X, Y, Z on this — update the existing doc, or create a new folder?" The user owns the shape of their knowledge base; the agent never silently restructures it.
|
|
38
|
-
|
|
39
|
-
The line is technical: **append-only operational logs are safe to auto-write; structural or content changes to the knowledge base are proposed.**
|
|
40
|
-
|
|
41
|
-
## Working style
|
|
42
|
-
|
|
43
|
-
**Explain simply and briefly — assume the user is not an IT expert.** Default to plain language. Lead with the conclusion. Keep ordinary replies short (a few lines, at most a few bullets); add tables/code only when they earn their place. Unpack any unavoidable technical term in a line or with a plain analogy.
|
|
44
|
-
|
|
45
|
-
**Ask one decision at a time.** When you need the user to decide, ask a single question and wait — do not stack several at once. Only batch when the choices are genuinely independent.
|
|
46
|
-
|
|
47
|
-
**Match reasoning effort to the task.** Don't over-reason trivial asks — a status check, a one-line edit, a lookup; don't under-reason heavy ones — architecture design, multi-file refactors, large debugging or migration, broad reviews. If the host exposes a tunable reasoning/thinking level and the task ahead clearly needs a different one than the session is set for, recommend the change — but rarely: only at a real boundary (a sizable task's start, a major topic shift, a substantial new directive), one or two times across a long session, never per question.
|
|
48
|
-
|
|
49
|
-
## The `data/` layout
|
|
50
|
-
|
|
51
|
-
Your content lives under `data/`. Each category answers a different question:
|
|
52
|
-
|
|
53
|
-
| Category | Question it answers |
|
|
54
|
-
|---|---|
|
|
55
|
-
| `worklog/` | "What happened today?" — chronological, one entry per day (`YYYY/MM/YYYY-MM-DD-keyword.md`). |
|
|
56
|
-
| `decision-log/` | "Why did we choose X over Y?" — per-decision record with context + alternatives. |
|
|
57
|
-
| `_memory/` | "What rule or fact must survive every session?" — curated facts reloaded each session start. |
|
|
58
|
-
| `runbooks/` | "What is the procedure when X breaks?" — repeatable steps with `last_tested` aging. |
|
|
59
|
-
| `hubs/` | "Where do I find everything about topic Z?" — a cross-cut landing page; grows organically once 3+ categories accumulate on the same topic. |
|
|
60
|
-
| `inbox/` | "Where does an unfiled note land before I sort it?" |
|
|
61
|
-
|
|
62
|
-
A typical day flows from short-lived capture (worklog) into longer-lived artifacts (decision-log, runbook, memory, hub). These are common promotion patterns, not required flows.
|
|
63
|
-
|
|
64
|
-
## Commands you'll use
|
|
65
|
-
|
|
66
|
-
These slash-commands are installed into `.claude/commands/` by `vortex init` (the agent runs the underlying `vortex` CLI and presents the result):
|
|
67
|
-
|
|
68
|
-
| Command | What it does |
|
|
69
|
-
|---|---|
|
|
70
|
-
| `/vortex` | Instance operations: `init`, `status`, `import`, `doctor`, `help`. |
|
|
71
|
-
| `/session-start` | Start-of-session report — recent work, current counts, the time. |
|
|
72
|
-
| `/log <section>` | Append a section to today's worklog (creates it if needed). |
|
|
73
|
-
| `/decision <slug> <title>` | Create a new Decision Log entry from the template. |
|
|
74
|
-
| `/recall <query>` | Semantic search over your memories and past sessions. *(Only when the optional `@vortex-os/memory-extended` add-on is installed.)* |
|
|
75
|
-
| `/agenda` | "What should I focus on?" — synthesizes open tasks, decisions, recent activity. |
|
|
76
|
-
| `/reindex [dir]` | Regenerate `_INDEX.md` for a category (or all). Idempotent. |
|
|
77
|
-
|
|
78
|
-
You can also run any of these directly: `npx vortex <command> [args]`.
|
|
79
|
-
|
|
80
|
-
## Optional add-ons
|
|
81
|
-
|
|
82
|
-
- **`@vortex-os/memory-extended`** — semantic recall over memories and past conversation sessions. Install alongside this instance to light up `/recall`; without it, everything else works and `/recall` is simply absent.
|
|
83
|
-
|
|
84
|
-
## Agent routing
|
|
85
|
-
|
|
86
|
-
| Agent | Entry | Shared config | Dedicated config |
|
|
87
|
-
|---|---|---|---|
|
|
88
|
-
| Claude Code | `CLAUDE.md` → `AGENT.md` | `.agent/` | `.claude/` |
|
|
89
|
-
| Codex CLI | `AGENTS.md` → `AGENT.md` (Codex auto-loads `AGENTS.md`; `CODEX.md` is legacy/manual) | `.agent/` | `.codex/` |
|
|
90
|
-
| Gemini CLI | `GEMINI.md` → `AGENT.md` | `.agent/` | `.gemini/` |
|
|
91
|
-
| Cursor | `.cursorrules` → `AGENT.md` | `.agent/` | `.cursor/` |
|
|
92
|
-
|
|
93
|
-
Per-agent files contain only agent-specific supplements. System-wide rules belong in this file.
|
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
# CODEX.md
|
|
2
|
-
|
|
3
|
-
NOTE: Codex CLI auto-loads `AGENTS.md`, not this file. The auto-load entry for
|
|
4
|
-
Codex is `AGENTS.md` (which routes to `AGENT.md`). This `CODEX.md` is a manual /
|
|
5
|
-
legacy supplement — read it only when explicitly pointed here.
|
|
6
|
-
|
|
7
|
-
## Route to unified entry
|
|
8
|
-
|
|
9
|
-
Read [`AGENT.md`](./AGENT.md) first — it is the single source of truth for how this instance behaves.
|
|
10
|
-
|
|
11
|
-
This `CODEX.md` holds only Codex-specific supplements. For everything else, refer to `AGENT.md`.
|
|
12
|
-
|
|
13
|
-
## Codex-specific config
|
|
14
|
-
|
|
15
|
-
- Dedicated dir: `.codex/`
|
|
16
|
-
- Shared dir: `.agent/`
|
|
File without changes
|