@dennisrepa/elevate 1.2.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/LICENSE +21 -0
- package/README.md +214 -0
- package/dist/cli.js +3569 -0
- package/dist/cli.js.map +1 -0
- package/docs/de.md +305 -0
- package/docs/en.md +309 -0
- package/docs/plans/transactional-updates.md +142 -0
- package/package.json +73 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Dennis RΓ©pa
|
|
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,214 @@
|
|
|
1
|
+
# Elevate
|
|
2
|
+
|
|
3
|
+
> **Interactive Polyglot Terminal Dashboard (TUI) and MCP Server for safe, selective, and transparent dependency management across monorepos and multi-project repositories.**
|
|
4
|
+
|
|
5
|
+
[](https://opensource.org/licenses/MIT)
|
|
6
|
+
[](https://www.npmjs.com/package/@dennisrepa/elevate)
|
|
7
|
+
[](https://ko-fi.com/dennisrepa)
|
|
8
|
+
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## π Documentation
|
|
12
|
+
|
|
13
|
+
* π¬π§ **[English Documentation](./docs/en.md)** β Architecture, release channels, safety mechanisms, headless CLI, MCP server, and configuration.
|
|
14
|
+
* π©πͺ **[Deutsche Dokumentation](./docs/de.md)** β VollstΓ€ndige Anleitung, Architektur, Release Channels, Monorepo-Schutz und Konfiguration.
|
|
15
|
+
|
|
16
|
+
---
|
|
17
|
+
|
|
18
|
+
## β¨ Key Features
|
|
19
|
+
|
|
20
|
+
* **Polyglot Monorepo Support:** Manages frontend workspaces (`package.json`) and backend services (`pom.xml`) in a single tool.
|
|
21
|
+
* **Targeted Version Selection:** Interactive modal to search, filter, and pick any published version (`[V]`), not just `latest`.
|
|
22
|
+
* **Runtime Ecosystem Switching:** Switch instantly between Node.js and Maven modules (`[E]`).
|
|
23
|
+
* **Release Channels:** Configurable channels (`stable` vs. `all`) with automatic filtering of pre-releases (alpha, beta, rc, snapshot).
|
|
24
|
+
* **Monorepo Scope Protection:** Prevents private packages (`@my-org/*`, `com.mycompany.*`) and local symlinks from being overwritten by public registries.
|
|
25
|
+
* **Safety Guardrails & Verification:** Automatic post-update verification (`npm install`, `mvn test-compile`) with rollback safety and major-version warnings.
|
|
26
|
+
* **Agentic & CI/CD Ready:** Full headless CLI (`--json`) and native Model Context Protocol (MCP) server for integration with autonomous AI coding agents.
|
|
27
|
+
* **Bilingual Interface:** Instant language toggle between English and German (`[L]`).
|
|
28
|
+
* **Modular Architecture:** Decoupled domain core and ports/adapters (hexagonal architecture).
|
|
29
|
+
|
|
30
|
+
---
|
|
31
|
+
|
|
32
|
+
## π¦ Supported Package Managers
|
|
33
|
+
|
|
34
|
+
| Ecosystem | Package Manager | Manifest File | Primary Registry | Monorepo Support | Verification Method | Status |
|
|
35
|
+
| :--- | :--- | :--- | :--- | :--- | :--- | :---: |
|
|
36
|
+
| **Node.js** (JS / TS) | `npm` | `package.json` | [npm Registry](https://registry.npmjs.org) | Root & npm Workspaces | `npm install` | β
Supported |
|
|
37
|
+
| **Java** (JVM) | `Maven` (`mvn`) | `pom.xml` | [Maven Central](https://repo1.maven.org/maven2) | Root POM & nested sub-modules | `mvn test-compile` | β
Supported |
|
|
38
|
+
|
|
39
|
+
> **Planned:** Support for Python (`pip`, `poetry`, `uv`), `pnpm`, `yarn`, and `Gradle` is on the roadmap.
|
|
40
|
+
|
|
41
|
+
---
|
|
42
|
+
|
|
43
|
+
## π Installation & Quick Start
|
|
44
|
+
|
|
45
|
+
### 1. Instant Run via `npx` (No Installation Required)
|
|
46
|
+
```bash
|
|
47
|
+
npx @dennisrepa/elevate
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
> **For AI Agents (Claude Code, Cursor, Antigravity):**
|
|
51
|
+
> Register Elevate directly in your agent's MCP settings:
|
|
52
|
+
> ```json
|
|
53
|
+
> {
|
|
54
|
+
> "mcpServers": {
|
|
55
|
+
> "elevate": {
|
|
56
|
+
> "command": "npx",
|
|
57
|
+
> "args": ["-y", "@dennisrepa/elevate", "mcp"]
|
|
58
|
+
> }
|
|
59
|
+
> }
|
|
60
|
+
> }
|
|
61
|
+
> ```
|
|
62
|
+
|
|
63
|
+
---
|
|
64
|
+
|
|
65
|
+
### 2. Standalone Binary (Zero Node.js Dependency)
|
|
66
|
+
For environments without a Node.js runtime:
|
|
67
|
+
1. Download `elevate.exe` (Windows) or `elevate-linux` from [GitHub Releases](https://github.com/DennisRepa/Elevate/releases).
|
|
68
|
+
2. Execute directly:
|
|
69
|
+
```powershell
|
|
70
|
+
.\elevate.exe
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
---
|
|
74
|
+
|
|
75
|
+
### 3. Global Installation
|
|
76
|
+
```bash
|
|
77
|
+
npm install -g @dennisrepa/elevate
|
|
78
|
+
elevate
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
---
|
|
82
|
+
|
|
83
|
+
### 4. Project Integration
|
|
84
|
+
Add as a development dependency:
|
|
85
|
+
```bash
|
|
86
|
+
npm install -D @dennisrepa/elevate
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
Add an entry to `package.json`:
|
|
90
|
+
```json
|
|
91
|
+
{
|
|
92
|
+
"scripts": {
|
|
93
|
+
"elevate": "elevate"
|
|
94
|
+
}
|
|
95
|
+
}
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
Run via:
|
|
99
|
+
```bash
|
|
100
|
+
npm run elevate
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
---
|
|
104
|
+
|
|
105
|
+
### 5. Local Development
|
|
106
|
+
```bash
|
|
107
|
+
npm install
|
|
108
|
+
npm run build
|
|
109
|
+
npm link
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
Run locally:
|
|
113
|
+
```bash
|
|
114
|
+
elevate
|
|
115
|
+
# or
|
|
116
|
+
node dist/cli.js
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
---
|
|
120
|
+
|
|
121
|
+
## β¨οΈ Keyboard Shortcuts (Interactive TUI)
|
|
122
|
+
|
|
123
|
+
| Key | Action |
|
|
124
|
+
| :--- | :--- |
|
|
125
|
+
| **`E`** | Switch Ecosystem (`npm` β `Maven`) |
|
|
126
|
+
| **`W`** | Open Module / Workspace Selector |
|
|
127
|
+
| **`V`** | Pick Specific Version (Interactive search & filter modal) |
|
|
128
|
+
| **`L`** | Toggle Language (`English` β `Deutsch`) |
|
|
129
|
+
| **`β` / `β`** *(or `k`/`j`)* | Navigate package list |
|
|
130
|
+
| **`Space`** | Toggle selection of focused package |
|
|
131
|
+
| **`A`** | Toggle selection of all visible packages in the active tab |
|
|
132
|
+
| **`Tab`** *(or `1`, `2`, `3`)* | Switch between tabs |
|
|
133
|
+
| **`U`** | Execute update for selected packages |
|
|
134
|
+
| **`R`** | Re-scan current module |
|
|
135
|
+
| **`Q`** | Quit Elevate |
|
|
136
|
+
|
|
137
|
+
---
|
|
138
|
+
|
|
139
|
+
## π€ Headless CLI & MCP Server
|
|
140
|
+
|
|
141
|
+
### 1. Headless CLI (`--json`)
|
|
142
|
+
|
|
143
|
+
Run non-interactive commands for scripting and CI/CD pipelines:
|
|
144
|
+
|
|
145
|
+
```bash
|
|
146
|
+
# Discover all modules in the repository
|
|
147
|
+
elevate modules --json
|
|
148
|
+
|
|
149
|
+
# Scan dependencies for available updates (exits with code 1 if updates found)
|
|
150
|
+
elevate scan --ecosystem=npm --channel=stable --json
|
|
151
|
+
|
|
152
|
+
# Query complete published version history for a package
|
|
153
|
+
elevate versions chalk --json
|
|
154
|
+
|
|
155
|
+
# Dry-run update simulation without modifying files
|
|
156
|
+
elevate update --module=apps/web --packages=chalk@5.6.2 --dry-run --json
|
|
157
|
+
|
|
158
|
+
# Apply updates with explicit major-version approval
|
|
159
|
+
elevate update --module=apps/web --packages=pinia@4.0.3 --allow-major --json
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
### 2. Model Context Protocol (MCP) Server
|
|
163
|
+
|
|
164
|
+
Start Elevate as an MCP server via stdio:
|
|
165
|
+
```bash
|
|
166
|
+
elevate mcp
|
|
167
|
+
```
|
|
168
|
+
|
|
169
|
+
MCP Configuration (e.g. `claude_desktop_config.json`):
|
|
170
|
+
```json
|
|
171
|
+
{
|
|
172
|
+
"mcpServers": {
|
|
173
|
+
"elevate": {
|
|
174
|
+
"command": "npx",
|
|
175
|
+
"args": ["-y", "@dennisrepa/elevate", "mcp"]
|
|
176
|
+
}
|
|
177
|
+
}
|
|
178
|
+
}
|
|
179
|
+
```
|
|
180
|
+
|
|
181
|
+
#### Available MCP Tools:
|
|
182
|
+
* `elevate_discover_modules`: Discovers repository modules and workspaces.
|
|
183
|
+
* `elevate_scan`: Scans dependencies for outdated packages against registries.
|
|
184
|
+
* `elevate_get_versions`: Fetches published version history from registry.
|
|
185
|
+
* `elevate_apply_updates`: Applies targeted updates with verification and guardrails.
|
|
186
|
+
* `elevate_verify`: Runs module-specific build and test verification checks.
|
|
187
|
+
|
|
188
|
+
---
|
|
189
|
+
|
|
190
|
+
## βοΈ Configuration
|
|
191
|
+
|
|
192
|
+
Elevate operates with zero configuration by default. Optional settings can be defined in `elevate.config.json` in the repository root:
|
|
193
|
+
|
|
194
|
+
```json
|
|
195
|
+
{
|
|
196
|
+
"channel": "stable",
|
|
197
|
+
"locale": "en",
|
|
198
|
+
"excludeScopes": ["@my-org", "com.mycompany"],
|
|
199
|
+
"postUpdateScript": "npm test",
|
|
200
|
+
"postUpdateLabel": "Run test suite"
|
|
201
|
+
}
|
|
202
|
+
```
|
|
203
|
+
|
|
204
|
+
Detailed parameter references are available in [`docs/en.md`](./docs/en.md) and [`docs/de.md`](./docs/de.md).
|
|
205
|
+
|
|
206
|
+
---
|
|
207
|
+
|
|
208
|
+
## π License & Sponsorship
|
|
209
|
+
|
|
210
|
+
Elevate is open-source software licensed under the [MIT License](./package.json).
|
|
211
|
+
|
|
212
|
+
* **Ko-fi:** [Support on Ko-fi](https://ko-fi.com/dennisrepa)
|
|
213
|
+
* **npm:** `npm fund @dennisrepa/elevate`
|
|
214
|
+
|