repo-nexus 0.6.5 → 0.6.7

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 CHANGED
@@ -12,34 +12,28 @@ A **simple, lightweight Virtual Meta-Repo companion** for multi-repo workspaces
12
12
  - **No Git Submodules or Nested Git Collisions**: Member repositories are physically cloned into `./repos/` and strictly ignored by workspace Git. Each repository maintains its own standalone history, remotes, branches, and commits with zero submodule friction.
13
13
  - **Unified Workspace for AI Coding Assistants**: Open one root folder to give Cursor, Claude Code, GitHub Copilot, Codex, or Antigravity complete cross-service visibility.
14
14
  - **Two-Level Configuration as Source of Truth**: Shared team manifest in `rnex.yaml` with machine-specific overrides in `.local.rnex.yaml` (highest priority).
15
- - **1-Command Team Onboarding**: Teammates clone the meta-repo and run `rnex clone` to clone and configure all member repos in seconds.
15
+ - **OneCommand Team Onboarding**: Teammates clone the meta-repo and run `rnex clone` to clone and configure all member repos in seconds.
16
16
  - **Cross-Repo Batch Operations**: Run arbitrary commands across all active repositories with `rnex exec <command>`.
17
17
  - **Scoped Plugins & Context Packs**: Modular plugin packages scoped under `.rnex/plugins/<plugin-name>/` with support for domain directories (e.g. `raw/` and `wiki/` for `karpathy-llm`).
18
18
  - **Zero Dependencies**: Pure POSIX shell CLI (`rnex`). Works out of the box across macOS, Linux, and Windows (WSL/Git Bash).
19
19
 
20
- > 💡 **Documentation & Guides:**
21
- > - Check out the **[Documentation Site](https://unoxen.github.io/repo-nexus/)** or local **[CLI Reference](docs/cli/)** for complete command syntax, flags, Git hooks, plugins, and prompts.
22
- > - Check out the **[Plugins Guide](docs/plugins/)** for detailed documentation on all built-in AI provider and domain plugins.
23
- > - Check out the **[Frequently Asked Questions (FAQ)](docs/faq/)** for architecture deep dives, Git workflows, and AI context strategies.
20
+ > 💡 **Documentation:** Full documentation lives on the **[Documentation Site](https://unoxen.github.io/repo-nexus/)** (sources in [`docs/`](docs/)):
21
+ > - **[Architecture](docs/guide/architecture.md)** and **[Why Repo Nexus?](docs/guide/why-repo-nexus.md)** — workspace layout and rationale
22
+ > - **[CLI Reference](docs/cli/)** — all commands, flags, everyday usage, Git hooks, and shell completion
23
+ > - **[Plugins Guide](docs/plugins/)** — built-in AI provider and domain plugins
24
+ > - **[Configuration](docs/guide/configuration.md)** — `rnex.yaml` and `.local.rnex.yaml` schema
25
+ > - **[FAQ](docs/faq/)** — architecture deep dives, Git workflows, and AI context strategies
24
26
 
25
27
  ---
26
28
 
27
29
  ## Table of Contents
28
30
 
29
31
  - [What Repo Nexus Is (and What It Isn't)](#what-repo-nexus-is-and-what-it-isnt)
30
- - [How It Works: Virtual Meta-Repo Architecture](#how-it-works-virtual-meta-repo-architecture)
31
32
  - [Key Principles](#key-principles)
32
33
  - [Installation](#installation)
33
34
  - [Quick Start](#quick-start)
34
- - [Everyday Usage](#everyday-usage)
35
- - [Plugins & Scoped Context Packs](#plugins--scoped-context-packs)
36
- - [Two-Level Configuration (`rnex.yaml` & `.local.rnex.yaml`)](#two-level-configuration)
37
- - [CLI Command Reference](#cli-command-reference)
38
- - [Full CLI Reference Manual (docs/cli/)](docs/cli/)
39
- - [Shell Auto-Completion](#shell-auto-completion)
40
35
  - [Project Structure](#project-structure)
41
36
  - [Running Tests](#running-tests)
42
- - [Frequently Asked Questions (FAQ)](docs/faq/)
43
37
  - [License](#license)
44
38
 
45
39
  ---
@@ -55,34 +49,6 @@ A **simple, lightweight Virtual Meta-Repo companion** for multi-repo workspaces
55
49
 
56
50
  ---
57
51
 
58
- ## How It Works: Virtual Meta-Repo Architecture
59
-
60
- ```
61
- ┌─────────────────────────────────────────────────────────────┐
62
- │ Repo Nexus Workspace Root (Virtual Meta-Repo) │
63
- │ │
64
- │ my-workspace/ │
65
- │ .local.rnex.yaml (Highest Priority: local overrides) │
66
- │ rnex.yaml (Team Manifest: repos & plugins) │
67
- │ AGENTS.md (Routing-only AI agent instructions) │
68
- │ .gitignore (Strictly ignores repos/ & local yaml) │
69
- │ .rnex/ (Strictly encapsulated internal state) │
70
- │ plugins/ (Scoped plugin directories) │
71
- │ karpathy-llm/ (Isolated rules, workflows, templates) │
72
- │ repos/ (Autonomous Physical Git Clones) │
73
- │ backend/ (Own .git, branches, PRs) │
74
- │ .rnex/ (Quarantined member-specific context) │
75
- │ frontend/ (Own .git, branches, PRs) │
76
- │ .rnex/ (Quarantined member-specific context) │
77
- │ │
78
- │ • Agent opens workspace → reads config first → sees stack. │
79
- │ • Repos are 100% normal Git clones (zero submodules). │
80
- │ • Work across repos seamlessly using rnex exec. │
81
- └─────────────────────────────────────────────────────────────┘
82
- ```
83
-
84
- ---
85
-
86
52
  ## Key Principles
87
53
 
88
54
  1. **Configuration as Single Source of Truth**:
@@ -159,262 +125,6 @@ All declared member repositories are cloned and wired up automatically!
159
125
 
160
126
  ---
161
127
 
162
- ## Everyday Usage
163
-
164
- ```bash
165
- # Register and clone a repository
166
- rnex add backend git@github.com:myorg/backend.git
167
-
168
- # Register a repository in local config only (.local.rnex.yaml)
169
- rnex add --local analytics git@github.com:myorg/analytics.git
170
-
171
- # Clone all missing member repositories
172
- rnex clone
173
-
174
- # Run a command across all active repositories
175
- rnex exec git status -s
176
- rnex exec npm test
177
-
178
- # Disable a repository (skipped by clone, exec, and agents)
179
- rnex disable analytics
180
- rnex disable --local analytics # disable locally without modifying team rnex.yaml
181
-
182
- # Re-enable a repository
183
- rnex enable analytics
184
-
185
- # List all registered repositories with clone status and active branch
186
- rnex list
187
-
188
- # Inspect workspace health, active repos, and plugin status
189
- rnex status
190
-
191
- # Reconcile workspace, sync plugins, and upgrade config in a single pass (aliases: sync, update, upgrade)
192
- rnex fix
193
-
194
- # Unregister and delete a repository
195
- rnex remove analytics
196
- ```
197
-
198
- ---
199
-
200
- ## Plugins & Scoped Context Packs
201
-
202
- Repo Nexus features a scoped plugin architecture. Plugins package curated AI instructions, agent behavioral rules, and architecture templates that are synchronized into dedicated directories under `.rnex/plugins/<plugin-name>/`.
203
-
204
- ```bash
205
- # List available and active plugins
206
- rnex plugin list
207
-
208
- # Inspect plugin details and provided files
209
- rnex plugin info karpathy-llm
210
-
211
- # Enable a plugin in your workspace
212
- rnex plugin enable karpathy-llm
213
-
214
- # Disable a plugin and clean up scoped assets
215
- rnex plugin disable karpathy-llm
216
- ```
217
-
218
- ### Built-in Plugins
219
-
220
- > For dedicated guides, configuration options, and directory layouts for each plugin, see the [**Repo Nexus Plugins Guide**](docs/plugins/).
221
-
222
- #### 1. `copilot`
223
- The `copilot` plugin provides GitHub Copilot integration, automatically mirroring workspace and active plugin assets:
224
- * **Prompts (`.github/prompts/*.prompt.md`)**: Formatted with YAML frontmatter (`name`, `description`) for the VS Code Copilot Chat prompt picker and slash commands.
225
- * **Agent Skills (`.github/skills/<name>/SKILL.md`)**: Configured for GitHub Copilot Agent mode and `gh skill`.
226
- * **Custom Agents (`.github/agents/*.agent.md`)**: Active plugins' agent definitions mirrored for Copilot workspace custom agents.
227
- * **Instructions (`.github/copilot-instructions.md`)**: Synthesized workspace routing and active plugin guidelines, preserving manual user instructions.
228
- * **Configurable Options**:
229
- ```yaml
230
- plugins:
231
- copilot:
232
- prompts: true # mirror prompts to .github/prompts/*.prompt.md (default: true)
233
- skills: true # mirror skills to .github/skills/<name>/SKILL.md (default: true)
234
- instructions: true # mirror guidelines to .github/copilot-instructions.md (default: true)
235
- agents: true # mirror custom agents to .github/agents/*.agent.md (default: true)
236
- ```
237
-
238
- #### 2. `claude`
239
- The `claude` plugin integrates Anthropic's Claude Code and Claude CLI:
240
- * **Instructions (`CLAUDE.md`)**: Manages the root `CLAUDE.md` routing context, replacing `AGENTS.md`.
241
- * **Slash Commands (`.claude/commands/*.md`)**: Standardized commands (`/rnex-cross-repo-feature`, etc.) for Claude Code.
242
- * **Agent Skills (`.claude/skills/<name>/SKILL.md`)**: Mirrored tool skills and workflows.
243
- * **Configurable Options**:
244
- ```yaml
245
- plugins:
246
- claude:
247
- instructions: true # maintain CLAUDE.md (default: true)
248
- prompts: true # mirror slash commands to .claude/commands/ (default: true)
249
- skills: true # mirror skills to .claude/skills/ (default: true)
250
- ```
251
-
252
- #### 3. `gemini`
253
- The `gemini` plugin integrates Google Gemini CLI and Gemini Code Assist:
254
- * **Instructions (`GEMINI.md`)**: Manages root `GEMINI.md` context, replacing `AGENTS.md`.
255
- * **Prompts (`.gemini/prompts/*.prompt.md`)**: Standardized prompts formatted with YAML frontmatter.
256
- * **Skills (`.gemini/skills/<name>/SKILL.md`)**: Mirrored tool skills for Gemini agents.
257
- * **Configurable Options**:
258
- ```yaml
259
- plugins:
260
- gemini:
261
- instructions: true # maintain GEMINI.md (default: true)
262
- prompts: true # mirror prompts to .gemini/prompts/ (default: true)
263
- skills: true # mirror skills to .gemini/skills/ (default: true)
264
- ```
265
-
266
- #### 4. `cursor`
267
- The `cursor` plugin integrates the Cursor IDE:
268
- * **Instructions (`.cursorrules` & `.cursor/rules/repo-nexus.mdc`)**: Synchronizes project routing rules.
269
- * **Prompts (`.cursor/prompts/*.md`)**: Mirrored prompt files.
270
- * **Skills (`.cursor/skills/<name>/SKILL.md`)**: Mirrored agent skills.
271
- * **Configurable Options**:
272
- ```yaml
273
- plugins:
274
- cursor:
275
- instructions: true # maintain .cursorrules and MDC rule (default: true)
276
- prompts: true # mirror prompts to .cursor/prompts/ (default: true)
277
- skills: true # mirror skills to .cursor/skills/ (default: true)
278
- ```
279
-
280
- #### 5. `windsurf`
281
- The `windsurf` plugin integrates the Codeium Windsurf IDE:
282
- * **Instructions (`.windsurfrules`)**: Synchronizes project routing rules.
283
- * **Prompts (`.windsurf/prompts/*.md`)**: Mirrored prompt files.
284
- * **Skills (`.windsurf/skills/<name>/SKILL.md`)**: Mirrored agent skills.
285
- * **Configurable Options**:
286
- ```yaml
287
- plugins:
288
- windsurf:
289
- instructions: true # maintain .windsurfrules (default: true)
290
- prompts: true # mirror prompts to .windsurf/prompts/ (default: true)
291
- skills: true # mirror skills to .windsurf/skills/ (default: true)
292
- ```
293
-
294
- #### 6. `karpathy-llm`
295
- The `karpathy-llm` plugin packages Andrej Karpathy's verified LLM agent design patterns, context engineering principles, and the autonomous **Karpathy LLM Wiki** architecture:
296
- * **The 4 Cardinal Agent Rules** (`.rnex/plugins/karpathy-llm/rules/behavioral.md`):
297
- 1. *Think Before Coding:* Formulate explicit assumptions, boundary checks, and trade-offs before writing code.
298
- 2. *Simplicity First:* Minimal abstractions, readable implementations, zero speculative boilerplate.
299
- 3. *Surgical Changes:* Minimal blast radius, preserved comments/docstrings, and tight diffs.
300
- 4. *Goal-Driven Execution:* Upfront verification criteria, automated tests, and diff inspection.
301
- * **Autonomous Karpathy LLM Wiki Architecture:**
302
- * **Intake (`/raw/`):** Append-only intake for unmodified source documents.
303
- * **Curated Knowledge Base (`/wiki/`):** Interlinked atomic markdown pages with typed YAML frontmatter relations.
304
- * **Navigation Index (`/wiki/index.md`):** Master categorized navigation index.
305
- * **Rolling Context (`/wiki/hot.md`):** ~500-word quick-orient context cache for AI agents.
306
- * **Operation Log (`/wiki/_log.md`):** Append-only audit trail of ingest and lint operations.
307
- * **Standardized Workflows (`.rnex/plugins/karpathy-llm/workflows/`):**
308
- * `wiki-ingest.md`: 8-step protocol decomposing raw source documents into atomic wiki pages.
309
- * `wiki-lint.md`: 10-step protocol validating paths, relations, contradictions, and indexing.
310
-
311
- ---
312
-
313
- ## Two-Level Configuration
314
-
315
- 1. **Repo Config (`rnex.yaml`):** Shared manifest committed to Git. Declares member repos, Git URLs, default enabled states, and active plugins.
316
- 2. **Local Config (`.local.rnex.yaml`):** Machine-specific file ignored in `.gitignore`. Takes **highest priority** and overrides repo settings.
317
-
318
- ### Repo Configuration (`rnex.yaml`)
319
-
320
- ```yaml
321
- # Directory for member repository clones
322
- repos_dir: ./repos
323
-
324
- # Automated workspace Git hooks (default: true)
325
- git_hooks: true
326
-
327
- # Workspace plugins and tool integrations
328
- plugins:
329
- copilot:
330
- prompts: true
331
- skills: true
332
- instructions: true
333
- agents: true
334
- karpathy-llm: {}
335
-
336
- # Member repositories (enabled by default)
337
- repos:
338
- backend:
339
- url: git@github.com:myorg/backend-api.git
340
- rnex_dir: true # default: true (creates repos/backend/.rnex/)
341
- frontend:
342
- url: https://github.com/myorg/web-app.git
343
- rnex_dir: true
344
- analytics:
345
- url: git@github.com:myorg/analytics.git
346
- enabled: false # disabled: skipped by clone and exec
347
- rnex_dir: false
348
- ```
349
-
350
- ### Local Configuration (`.local.rnex.yaml`)
351
-
352
- ```yaml
353
- # Highest priority local overrides
354
- repos:
355
- analytics:
356
- enabled: true # locally enable analytics on this workstation
357
- ```
358
-
359
- ---
360
-
361
- ## CLI Command Reference
362
-
363
- > 📖 **Full Manual Available:** See the comprehensive **[CLI Reference Manual](docs/cli/)** for exhaustive details, deep dives into every command and flag, lifecycle behaviors, automated Git hooks, scoped plugins, standardized prompts catalog, and shell completion recipes.
364
-
365
- ### Global Options
366
- | Option | Description |
367
- |:---|:---|
368
- | `-c, --config <file>` | Explicit path to `rnex.yaml` (executes in that workspace directory) |
369
- | `-h, --help` | Display command help and usage instructions |
370
- | `-v, --version` | Display version |
371
-
372
- ### Commands
373
- | Command | Description |
374
- |:---|:---|
375
- | `rnex init [-y] [--ai <file>] [--code-workspace [file]] [--hooks\|--no-hooks] [dir]` | Initialize a new Virtual Meta-Repo workspace in current (or target) directory |
376
- | `rnex install [dir]` | Install `rnex` & `repo-nexus` globally into `~/.local/bin` (or custom dir) |
377
- | `rnex add [--local] [--disabled] <name> <git-url>` | Register and clone repo into `./repos/<name>` |
378
- | `rnex clone` | Clone all missing enabled repositories declared in `rnex.yaml` |
379
- | `rnex exec <command...>` | Execute a shell command across all active member repositories |
380
- | `rnex remove <name>` | Unregister repo and delete `./repos/<name>` |
381
- | `rnex enable [--local] <name>` | Enable a repository in active workspace |
382
- | `rnex disable [--local] <name>` | Disable a repository from active workspace |
383
- | `rnex list` | List all member repositories with clone state, active branch, and `.rnex` status |
384
- | `rnex status` | Inspect workspace health, active repos, config loaded, git hooks, and plugins |
385
- | `rnex rnex-dir <enable\|disable> <name>` | Toggle `.rnex/` directory integration for a member repository |
386
- | `rnex fix [-y] [--quiet]` (or `sync`) | Reconcile workspace repositories, plugins, prompts, and member `.rnex/` directories |
387
- | `rnex update [-y]` (or `upgrade`) | Safely upgrade workspace configuration schema and routing instructions |
388
- | `rnex hooks <install\|uninstall\|status> [--local]` | Manage automated Git hooks (`.rnex/hooks` and `git_hooks: true\|false`) |
389
- | `rnex plugin <list\|info\|enable\|disable>` | Manage workspace plugins |
390
- | `rnex completion <bash\|zsh\|fish>` | Generate shell auto-completion script |
391
-
392
- ---
393
-
394
- ## Shell Auto-Completion
395
-
396
- Generate auto-completions for your shell:
397
-
398
- ### Zsh
399
- ```bash
400
- # Add to ~/.zshrc
401
- source <(rnex completion zsh)
402
- ```
403
-
404
- ### Bash
405
- ```bash
406
- # Add to ~/.bashrc
407
- source <(rnex completion bash)
408
- ```
409
-
410
- ### Fish
411
- ```bash
412
- # Add to ~/.config/fish/config.fish
413
- rnex completion fish | source
414
- ```
415
-
416
- ---
417
-
418
128
  ## Project Structure
419
129
 
420
130
  ```
Binary file
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "repo-nexus",
3
- "version": "0.6.5",
3
+ "version": "0.6.7",
4
4
  "description": "Lightweight, zero-dependency Virtual Meta-Repo companion for multi-repo workspaces and shared AI context (no git submodules)",
5
5
  "bin": {
6
6
  "repo-nexus": "rnex",
@@ -30,26 +30,29 @@
30
30
  "bugs": {
31
31
  "url": "https://github.com/unoxen/repo-nexus/issues"
32
32
  },
33
- "homepage": "https://github.com/unoxen/repo-nexus#readme",
33
+ "homepage": "https://unoxen.github.io/repo-nexus/",
34
34
  "keywords": [
35
35
  "rnex",
36
36
  "repo-nexus",
37
- "multi-repo",
38
- "monorepo",
37
+ "nexus-repository",
38
+ "nexus",
39
+ "repo",
40
+ "repository",
39
41
  "meta-repo",
42
+ "meta-repository",
43
+ "virtual-meta-repo",
44
+ "multi-repo",
45
+ "context-repository",
46
+ "ai-first-repository",
40
47
  "harness",
48
+ "ai-harness",
49
+ "wiki-llm",
41
50
  "workspace",
42
51
  "toolkit",
43
- "ai-agents",
44
- "agents.md",
45
- "cursor-rules",
46
- "claude-code",
47
- "copilot",
52
+ "context-engineering",
48
53
  "cursor",
49
54
  "plugins",
50
55
  "karpathy",
51
- "context-engineering",
52
- "developer-tools",
53
56
  "cli"
54
57
  ],
55
58
  "license": "MIT",