repo-nexus 0.2.5 → 0.2.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 +0 -39
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -9,13 +9,6 @@
|
|
|
9
9
|
|
|
10
10
|
A **simple, lightweight companion tool** for multi-repo workflows. It links multiple independent repositories and shares universal AI instructions (like `AGENTS.md`) using standard Unix symlinks — **without Git submodules, monorepo migrations, or complex setup**.
|
|
11
11
|
|
|
12
|
-
- **No Git Submodules or Nested Git Friction**: Keep your repositories completely independent. No detached HEADs, no `.gitmodules`, and no merge conflicts between repos.
|
|
13
|
-
- **A Lean Companion, Not a Workspace Replacer**: It does not replace your editor, terminal, build tools, or package manager. It is a tiny (~20 KB) helper that seamlessly complements your existing workflow.
|
|
14
|
-
- **Unified Workspace for AI Coding Assistants**: Open one folder to give Cursor, Claude Code, GitHub Copilot, or Antigravity complete cross-repo visibility.
|
|
15
|
-
- **Single Source of Truth for AI Guidelines**: Share and sync `AGENTS.md`, Copilot instructions (`.github/copilot-instructions.md`), Cursor rules (`.cursorrules`), Claude instructions (`CLAUDE.md`), and custom prompts across all projects.
|
|
16
|
-
- **Zero Dependencies**: Pure POSIX shell CLI (`rnex`). Works out of the box with zero external runtimes required.
|
|
17
|
-
A **simple, lightweight companion tool** for multi-repo workflows. It links multiple independent repositories and shares universal AI instructions (like `AGENTS.md`) using standard Unix symlinks — **without Git submodules, monorepo migrations, or complex setup**.
|
|
18
|
-
|
|
19
12
|
- **No Git Submodules or Nested Git Friction**: Keep your repositories completely independent. No detached HEADs, no `.gitmodules`, and no merge conflicts between repos.
|
|
20
13
|
- **A Lean Companion, Not a Workspace Replacer**: It does not replace your editor, terminal, build tools, or package manager. It is a tiny (~20 KB) helper that seamlessly complements your existing workflow.
|
|
21
14
|
- **Unified Workspace for AI Coding Assistants**: Open one folder to give Cursor, Claude Code, GitHub Copilot, or Antigravity complete cross-repo visibility.
|
|
@@ -37,17 +30,6 @@ A **simple, lightweight companion tool** for multi-repo workflows. It links mult
|
|
|
37
30
|
|
|
38
31
|
---
|
|
39
32
|
|
|
40
|
-
## What Repo Nexus Is (and What It Isn't)
|
|
41
|
-
|
|
42
|
-
| What It Is | What It Isn't |
|
|
43
|
-
| :--- | :--- |
|
|
44
|
-
| **A lightweight companion utility** (~20 KB POSIX script). | **NOT a replacement for your workspace or tools.** It doesn't replace VS Code, Cursor, JetBrains, or your terminal. |
|
|
45
|
-
| **A simple symlink manager** that groups existing repos into one folder for convenience. | **NOT a build tool or monorepo orchestrator.** It doesn't manage builds or replace tools like Nx, Turborepo, Cargo, or Gradle. |
|
|
46
|
-
| **Zero Git friction.** Repositories remain normal, autonomous Git repos. | **NOT Git submodules or subtrees.** No `.gitmodules` files, no detached HEADs, no commit coordination lock-in. |
|
|
47
|
-
| **Non-invasive.** If you delete the workspace, your repos remain completely untouched. | **NOT a proprietary platform.** No background daemons, no database, no vendor lock-in. |
|
|
48
|
-
|
|
49
|
-
---
|
|
50
|
-
|
|
51
33
|
## How It Works: The Two Symlink Flows
|
|
52
34
|
|
|
53
35
|
```
|
|
@@ -81,19 +63,14 @@ A **simple, lightweight companion tool** for multi-repo workflows. It links mult
|
|
|
81
63
|
|
|
82
64
|
## Key Principles
|
|
83
65
|
|
|
84
|
-
1. **No Git Submodules (Complete Repository Autonomy)**:
|
|
85
|
-
Member repositories are never converted into Git submodules or subtrees. Each repository keeps its own standalone Git history, remotes, branches, and commits. `rnex` simply links them on your local filesystem.
|
|
86
66
|
1. **No Git Submodules (Complete Repository Autonomy)**:
|
|
87
67
|
Member repositories are never converted into Git submodules or subtrees. Each repository keeps its own standalone Git history, remotes, branches, and commits. `rnex` simply links them on your local filesystem.
|
|
88
68
|
|
|
89
|
-
2. **Symlink Write-Through**:
|
|
90
|
-
Symlinks are transparent pointers resolved by your OS. When you or an AI agent edit `repos/backend/src/index.ts`, the OS resolves the link and writes directly to the source repository on disk.
|
|
91
69
|
2. **Symlink Write-Through**:
|
|
92
70
|
Symlinks are transparent pointers resolved by your OS. When you or an AI agent edit `repos/backend/src/index.ts`, the OS resolves the link and writes directly to the source repository on disk.
|
|
93
71
|
|
|
94
72
|
3. **Single Source of Truth for AI Context**:
|
|
95
73
|
Edit `AGENTS.md` once in Repo Nexus, and changes immediately reflect across all member repositories.
|
|
96
|
-
Edit `AGENTS.md` once in Repo Nexus, and changes immediately reflect across all member repositories.
|
|
97
74
|
|
|
98
75
|
4. **Dynamic Workspace Scope**:
|
|
99
76
|
Easily show or hide member repos from the active workspace without modifying disk contents.
|
|
@@ -113,25 +90,10 @@ npm install -g repo-nexus
|
|
|
113
90
|
|
|
114
91
|
### Option 2: Via GitHub Packages
|
|
115
92
|
|
|
116
|
-
```bash
|
|
117
|
-
npm install -g @nu-nenoi/repo-nexus --registry=https://npm.pkg.github.com
|
|
118
|
-
```
|
|
119
|
-
Install `rnex` via npm, GitHub Packages, or the zero-dependency native installer:
|
|
120
|
-
|
|
121
|
-
### Option 1: Via npm (Recommended)
|
|
122
|
-
|
|
123
|
-
```bash
|
|
124
|
-
npm install -g repo-nexus
|
|
125
|
-
```
|
|
126
|
-
*(Installs both `repo-nexus` and `rnex` commands globally, or run via `npx repo-nexus init`)*
|
|
127
|
-
|
|
128
|
-
### Option 2: Via GitHub Packages
|
|
129
|
-
|
|
130
93
|
```bash
|
|
131
94
|
npm install -g @nu-nenoi/repo-nexus --registry=https://npm.pkg.github.com
|
|
132
95
|
```
|
|
133
96
|
|
|
134
|
-
### Option 3: Native Installer (Zero Dependencies)
|
|
135
97
|
### Option 3: Native Installer (Zero Dependencies)
|
|
136
98
|
|
|
137
99
|
Clone the repository and run the built-in installer:
|
|
@@ -143,7 +105,6 @@ cd repo-nexus
|
|
|
143
105
|
```
|
|
144
106
|
*(Installs `rnex` and `repo-nexus` symlinks into `~/.local/bin`, or pass a custom directory like `./rnex install /usr/local/bin`)*
|
|
145
107
|
|
|
146
|
-
### Option 4: Shell Alias
|
|
147
108
|
### Option 4: Shell Alias
|
|
148
109
|
|
|
149
110
|
Add to your `~/.zshrc` or `~/.bashrc`:
|
package/package.json
CHANGED