repo-nexus 0.3.1 → 0.3.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/README.md +28 -17
- package/docs/AGENTS.sample.md +7 -5
- package/docs/rnex.example.yaml +8 -3
- package/package.json +1 -1
- package/rnex +543 -160
- package/toolkit/plugins/karpathy-llm/README.md +126 -36
- package/toolkit/plugins/karpathy-llm/instructions/karpathy-llm.md +83 -0
- package/toolkit/plugins/karpathy-llm/plugin.yaml +2 -1
- package/toolkit/plugins/karpathy-llm/rules/KARPATHY_RULES.md +1 -3
- package/toolkit/plugins/karpathy-llm/templates/_log.md +1 -1
- package/toolkit/plugins/karpathy-llm/templates/hot.md +1 -1
- package/toolkit/plugins/karpathy-llm/templates/index.md +0 -1
- package/toolkit/prompts/setup-karpathy-wiki.md +13 -40
- package/toolkit/plugins/karpathy-llm/scripts/wiki-lint-trigger.sh +0 -44
package/README.md
CHANGED
|
@@ -54,7 +54,7 @@ A **simple, lightweight companion tool** for multi-repo workflows. It links mult
|
|
|
54
54
|
|
|
55
55
|
```
|
|
56
56
|
┌─────────────────────────────────────────────────────────────┐
|
|
57
|
-
│ Repo Nexus Workspace Root
|
|
57
|
+
│ Repo Nexus Workspace Root │
|
|
58
58
|
│ │
|
|
59
59
|
│ my-workspace/ │
|
|
60
60
|
│ repos/ │
|
|
@@ -93,22 +93,25 @@ A **simple, lightweight companion tool** for multi-repo workflows. It links mult
|
|
|
93
93
|
|
|
94
94
|
## Installation
|
|
95
95
|
|
|
96
|
-
Install `rnex` via npm,
|
|
96
|
+
Install `rnex` via npm, standalone one-liner (`curl` / `wget`), or from source:
|
|
97
97
|
|
|
98
|
-
### Option 1: Via npm (
|
|
98
|
+
### Option 1: Via npm (Global)
|
|
99
99
|
|
|
100
100
|
```bash
|
|
101
101
|
npm install -g repo-nexus
|
|
102
102
|
```
|
|
103
|
-
*(Installs both `repo-nexus` and `rnex` commands globally, or run via `npx repo-nexus init`)*
|
|
103
|
+
*(Installs both `repo-nexus` and `rnex` commands globally, or run without installing via `npx repo-nexus init`)*
|
|
104
104
|
|
|
105
|
-
### Option 2:
|
|
105
|
+
### Option 2: Standalone One-Liner (curl / wget — Zero Dependencies, No Node.js)
|
|
106
106
|
|
|
107
107
|
```bash
|
|
108
|
-
|
|
108
|
+
curl -fsSL https://raw.githubusercontent.com/nu-nenoi/repo-nexus/main/scripts/install.sh | sh
|
|
109
|
+
# or
|
|
110
|
+
wget -qO- https://raw.githubusercontent.com/nu-nenoi/repo-nexus/main/scripts/install.sh | sh
|
|
109
111
|
```
|
|
112
|
+
*(Downloads and links `rnex` and `repo-nexus` into `~/.local/bin` without requiring Node.js or npm)*
|
|
110
113
|
|
|
111
|
-
### Option 3: Native Installer (
|
|
114
|
+
### Option 3: Native Installer (Clone & Install)
|
|
112
115
|
|
|
113
116
|
Clone the repository and run the built-in installer:
|
|
114
117
|
|
|
@@ -144,7 +147,7 @@ rnex add frontend ../web-app # relative paths work too
|
|
|
144
147
|
rnex status
|
|
145
148
|
```
|
|
146
149
|
|
|
147
|
-
During `rnex init`, the CLI
|
|
150
|
+
During `rnex init`, the CLI creates `rnex.yaml` if none exists for the directory, and merges Repo Nexus workspace instructions with any existing AI instructions (such as `AGENTS.md`, `CLAUDE.md`, `.cursorrules`).
|
|
148
151
|
|
|
149
152
|
---
|
|
150
153
|
|
|
@@ -211,20 +214,22 @@ The `karpathy-llm` plugin packages Andrej Karpathy's verified LLM agent design p
|
|
|
211
214
|
* **Autonomous Karpathy LLM Wiki Knowledge Architecture:**
|
|
212
215
|
* **Intake (`/raw/`):** Append-only intake for unmodified source documents.
|
|
213
216
|
* **Curated Knowledge Base (`/wiki/`):** Interlinked atomic markdown pages with typed YAML frontmatter relations (`sources`, `related`, `extends`, `contradicts`, `mentioned_in`).
|
|
214
|
-
* **
|
|
217
|
+
* **Navigation Index (`/wiki/index.md`):** Master categorized navigation index.
|
|
215
218
|
* **Rolling Context (`/wiki/hot.md`):** ~500-word quick-orient context cache for AI agents.
|
|
216
219
|
* **Operation Log (`/wiki/_log.md`):** Append-only audit trail of ingest and lint operations.
|
|
217
|
-
* **Session Counter (`.rnex/.lint_trigger_counter`):** Machine-local state tracking session activity (gitignored).
|
|
218
|
-
* **Autonomous Lint Trigger (`.rnex/scripts/wiki-lint-trigger.sh`):** Session counter and maintenance alerts on session 1 and every 15 sessions.
|
|
219
220
|
* **Standardized Workflows (`.rnex/workflows/`):**
|
|
220
221
|
* `wiki-ingest.md`: 8-step protocol decomposing raw source documents into 5–25 atomic wiki pages.
|
|
221
222
|
* `wiki-lint.md`: 10-step protocol validating paths, recomputing `mentioned_in`, removing orphans, resolving contradictions, identifying gaps, suggesting source candidates, and rebuilding indexes.
|
|
222
223
|
|
|
223
224
|
---
|
|
224
225
|
|
|
225
|
-
##
|
|
226
|
+
## Two-Level Configuration
|
|
226
227
|
|
|
227
|
-
|
|
228
|
+
Repo Nexus supports a two-level configuration model:
|
|
229
|
+
1. **Repo Config (`rnex.yaml`):** Shared manifest committed to git. Tracks member repo names, default settings, and active plugins.
|
|
230
|
+
2. **Local Config (`.local.rnex.yaml`):** Machine-specific file ignored in `.gitignore`. Overrides or provides member repo paths on each developer's workstation.
|
|
231
|
+
|
|
232
|
+
### Repo Configuration (`rnex.yaml`)
|
|
228
233
|
|
|
229
234
|
```yaml
|
|
230
235
|
# Directory for repository symlinks (relative or absolute)
|
|
@@ -232,17 +237,15 @@ repos_dir: ./repos
|
|
|
232
237
|
|
|
233
238
|
# Workspace plugins
|
|
234
239
|
plugins:
|
|
235
|
-
karpathy-llm:
|
|
236
|
-
lint_trigger_enabled: true
|
|
240
|
+
karpathy-llm: {}
|
|
237
241
|
|
|
238
242
|
# Member repositories
|
|
239
243
|
repos:
|
|
240
244
|
backend:
|
|
241
|
-
path: /Users/dev/code/backend-api
|
|
242
245
|
scope: visible
|
|
243
246
|
rnex_dir: true # default: true (creates repos/backend/.rnex/)
|
|
244
247
|
frontend:
|
|
245
|
-
path: ../web-app
|
|
248
|
+
path: ../web-app # optional default relative path
|
|
246
249
|
scope: visible
|
|
247
250
|
rnex_dir: true
|
|
248
251
|
analytics:
|
|
@@ -251,6 +254,14 @@ repos:
|
|
|
251
254
|
rnex_dir: false # disabled: leaves analytics repo 100% untouched
|
|
252
255
|
```
|
|
253
256
|
|
|
257
|
+
### Local Configuration (`.local.rnex.yaml`)
|
|
258
|
+
|
|
259
|
+
```yaml
|
|
260
|
+
repos:
|
|
261
|
+
backend:
|
|
262
|
+
path: /Users/alice/projects/backend-api
|
|
263
|
+
```
|
|
264
|
+
|
|
254
265
|
> See [`docs/rnex.example.yaml`](docs/rnex.example.yaml) for a comprehensive example with all options.
|
|
255
266
|
> For common questions and architecture details, see the [Frequently Asked Questions (FAQ)](docs/FAQ.md).
|
|
256
267
|
|
package/docs/AGENTS.sample.md
CHANGED
|
@@ -4,8 +4,10 @@ This workspace operates as a **Repo Nexus** linking multiple independent reposit
|
|
|
4
4
|
|
|
5
5
|
## Rules for AI Coding Assistants
|
|
6
6
|
|
|
7
|
-
1. **
|
|
8
|
-
2. **
|
|
9
|
-
3. **
|
|
10
|
-
4. **
|
|
11
|
-
5. **
|
|
7
|
+
1. **Workspace Structure & Settings**: AI coding assistants MUST inspect and read `rnex.yaml` at the workspace root to understand the workspace structure (such as `repos_dir`), registered member repositories, and active configuration settings.
|
|
8
|
+
2. **Symlink Write-Through**: Files edited under `repos/<name>/` directly modify the target repository.
|
|
9
|
+
3. **Repo Boundaries**: Each repository is isolated. Do not introduce cross-repo imports unless explicitly architected.
|
|
10
|
+
4. **Shared Context**: This file governs AI assistant behavior across all member repositories. Keep instructions universal. Use local instructions for repo-specific rules.
|
|
11
|
+
5. **Member Repo RNEX Context**: Member repositories may contain an `.rnex/` directory (accessible via `repos/<name>/.rnex/`) containing repository-specific documents, instructions, rules, workflows, and scripts managed by Repo Nexus. AI assistants operating at the workspace level MUST inspect `repos/<name>/.rnex/` for member-specific context, guidelines, and commands.
|
|
12
|
+
6. **Plugin Instructions**: If plugins are enabled in `rnex.yaml` (under `plugins:`), AI coding assistants MUST read instructions for each enabled plugin from its separate instruction files (located in `.rnex/instructions/` or `.rnex/rules/`).
|
|
13
|
+
7. **Git Operations**: Commit and push changes directly within the respective member repository root.
|
package/docs/rnex.example.yaml
CHANGED
|
@@ -1,7 +1,13 @@
|
|
|
1
1
|
# ==============================================================================
|
|
2
2
|
# rnex.yaml — Repo Nexus Workspace Configuration (Full Example)
|
|
3
3
|
# ==============================================================================
|
|
4
|
-
# This file is the central manifest for a Repo Nexus workspace.
|
|
4
|
+
# This file is the central team manifest for a Repo Nexus workspace (committed to git).
|
|
5
|
+
#
|
|
6
|
+
# TWO-LEVEL CONFIGURATION:
|
|
7
|
+
# 1. Repo Config (rnex.yaml): Shared across team, tracks member repos, plugins.
|
|
8
|
+
# 2. Local Config (.local.rnex.yaml): Machine-specific (gitignored), overrides/provides
|
|
9
|
+
# local member repo paths and developer-specific plugin settings.
|
|
10
|
+
#
|
|
5
11
|
# Place it in your workspace root directory and run `rnex sync` to apply.
|
|
6
12
|
#
|
|
7
13
|
# For more information: https://github.com/nu-nenoi/repo-nexus
|
|
@@ -37,8 +43,7 @@ repos_dir: ./repos
|
|
|
37
43
|
# Local / custom plugins can also be placed in .rnex/plugins/<name>/
|
|
38
44
|
|
|
39
45
|
plugins:
|
|
40
|
-
# karpathy-llm:
|
|
41
|
-
# lint_trigger_enabled: true
|
|
46
|
+
# karpathy-llm: {}
|
|
42
47
|
|
|
43
48
|
# ------------------------------------------------------------------------------
|
|
44
49
|
# repos — Member repositories managed by Repo Nexus
|
package/package.json
CHANGED