Skip to content

Commit 709123e

Browse files
committed
feat(v3): bundle React dashboard and global nyx CLI command
1 parent 59c4d60 commit 709123e

8 files changed

Lines changed: 1035 additions & 21 deletions

File tree

.github/workflows/ci.yml

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@ name: CI
22

33
on:
44
push:
5-
branches: [ main, v2, v2-file-organization-audit ]
5+
branches: [ main, v3 ]
66
pull_request:
7-
branches: [ main, v2 ]
7+
branches: [ main, v3 ]
88

99
jobs:
1010
build:
@@ -29,9 +29,12 @@ jobs:
2929
- name: Run Quality Checks
3030
run: npm run check:quality
3131

32-
- name: Run Security Checks
32+
- name: Run Security Scans on Code
3333
run: npm run check:security
3434

35+
- name: Run Dependency Audit
36+
run: npm audit
37+
3538
- name: Run Tests
3639
run: npm test
3740

README.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,12 @@ Nyx operates on a **Human-in-the-Loop** model. It never moves or deletes a file
3333
git clone https://github.com/ptkvaibhav/nyx.git
3434
cd nyx
3535

36-
# Install dependencies
36+
# Install dependencies and link globally
3737
npm install
38+
npm link
39+
40+
# Now you can use the `nyx` command from anywhere!
41+
nyx
3842

3943
# Initialize your engagement (what Nyx can scan)
4044
# Edit docs/engagement.md to add your folders
@@ -44,12 +48,13 @@ npm install
4448

4549
| Command | Description |
4650
| :--- | :--- |
47-
| `node src/cli.js audit-local` | Performs a full scan of managed directories. |
48-
| `node src/cli.js prepare-local-organization` | Generates suggestions for moves and renames. |
49-
| `node src/cli.js local-organization-status` | Views the current pending review queue. |
50-
| `node src/cli.js approve-local-organization all` | Approves all organization proposals. |
51-
| `node src/cli.js apply-local-organization` | Executes the approved changes on disk. |
52-
| `node src/cli.js rollback-local-organization` | Undoes the last set of organization actions. |
51+
| `nyx` | Launches the React-based Visual Dashboard automatically. |
52+
| `nyx audit-local` | Performs a full scan of managed directories. |
53+
| `nyx prepare-local-organization` | Generates suggestions for moves and renames. |
54+
| `nyx local-organization-status` | Views the current pending review queue. |
55+
| `nyx approve-local-organization all` | Approves all organization proposals. |
56+
| `nyx apply-local-organization` | Executes the approved changes on disk. |
57+
| `nyx rollback-local-organization` | Undoes the last set of organization actions. |
5358

5459
## 🧪 Verification
5560

@@ -67,6 +72,6 @@ Nyx is built with quality as a first-class citizen:
6772
- [x] Incremental Scanning Logic
6873
- [x] Version & Purpose Intelligence
6974
- [x] Rollback System
70-
- [ ] **Next**: React-based Visual Dashboard
71-
- [ ] Google Drive & OneDrive Integration
75+
- [x] React-based Visual Dashboard
76+
- [ ] **Next**: Google Drive & OneDrive Integration
7277
- [ ] Duplicate Suffix Intelligence (`(1)`, `(2)`)

docs/project-plan.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -216,6 +216,7 @@ SQLite remains the right first persistence layer for this.
216216
- folder proposal engine
217217
- irrelevance review engine
218218
- user approval queue
219+
- React-based visual dashboard with automated `nyx` CLI global command
219220

220221
### V4: Local Execution - Implemented
221222

docs/roadmap.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
- add irrelevance review engine
2121
- build approval queue
2222
- expose local-first organization commands
23+
- bundled React-based Visual Dashboard with an automated global `nyx` CLI launcher
2324

2425
## V4 - Implemented For Local Files
2526

0 commit comments

Comments
 (0)