@mrpatronz/nexusflow 0.2.13 → 0.2.17

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.
Files changed (186) hide show
  1. package/.github/dependabot.yml +52 -52
  2. package/.github/workflows/dependabot-merge.yml +53 -0
  3. package/.github/workflows/release.yml +112 -100
  4. package/.vscode/launch.json +17 -17
  5. package/.vscode/tasks.json +17 -17
  6. package/GETTING_STARTED.md +114 -109
  7. package/README.md +336 -311
  8. package/desktop/build-installer.js +228 -0
  9. package/desktop/build.js +118 -0
  10. package/desktop/installer/nexusflow.iss +35 -0
  11. package/desktop/neutralino.config.json +39 -0
  12. package/desktop/package-lock.json +1060 -0
  13. package/desktop/package.json +14 -0
  14. package/dist/commands/desktop.d.ts +12 -0
  15. package/dist/commands/desktop.d.ts.map +1 -0
  16. package/dist/commands/desktop.js +119 -0
  17. package/dist/commands/desktop.js.map +1 -0
  18. package/dist/commands/sync.d.ts.map +1 -1
  19. package/dist/commands/sync.js +1 -3
  20. package/dist/commands/sync.js.map +1 -1
  21. package/dist/commands/tui.d.ts +8 -0
  22. package/dist/commands/tui.d.ts.map +1 -0
  23. package/dist/commands/tui.js +386 -0
  24. package/dist/commands/tui.js.map +1 -0
  25. package/dist/commands/ui.d.ts +3 -1
  26. package/dist/commands/ui.d.ts.map +1 -1
  27. package/dist/commands/ui.js +76 -19
  28. package/dist/commands/ui.js.map +1 -1
  29. package/dist/generators/base.d.ts.map +1 -1
  30. package/dist/generators/base.js +78 -66
  31. package/dist/generators/base.js.map +1 -1
  32. package/dist/generators/codex.js +11 -11
  33. package/dist/generators/copilot.js +17 -17
  34. package/dist/generators/cursor.js +5 -5
  35. package/dist/generators/index.js +50 -50
  36. package/dist/generators/map-generator.js +14 -14
  37. package/dist/generators/skills-generator.js +28 -28
  38. package/dist/gui/app_logo.png +0 -0
  39. package/dist/gui/assets/index-Ct3qq-X4.js +25 -0
  40. package/dist/gui/assets/index-P_ZrgHXg.css +1 -0
  41. package/dist/gui/icons.svg +24 -24
  42. package/dist/gui/index.html +18 -18
  43. package/dist/index.js +43 -0
  44. package/dist/index.js.map +1 -1
  45. package/dist/server.d.ts.map +1 -1
  46. package/dist/server.js +182 -1
  47. package/dist/server.js.map +1 -1
  48. package/dist/server.test.js +78 -0
  49. package/dist/server.test.js.map +1 -1
  50. package/dist/types.d.ts +4 -0
  51. package/dist/types.d.ts.map +1 -1
  52. package/dist/utils/git.d.ts +16 -0
  53. package/dist/utils/git.d.ts.map +1 -1
  54. package/dist/utils/git.js +52 -0
  55. package/dist/utils/git.js.map +1 -1
  56. package/dist/utils/multi-git.d.ts +2 -0
  57. package/dist/utils/multi-git.d.ts.map +1 -1
  58. package/dist/utils/multi-git.js +5 -2
  59. package/dist/utils/multi-git.js.map +1 -1
  60. package/dist/utils/update-check.d.ts +3 -1
  61. package/dist/utils/update-check.d.ts.map +1 -1
  62. package/dist/utils/update-check.js +23 -6
  63. package/dist/utils/update-check.js.map +1 -1
  64. package/dist/utils/workflows.d.ts +11 -0
  65. package/dist/utils/workflows.d.ts.map +1 -0
  66. package/dist/utils/workflows.js +156 -0
  67. package/dist/utils/workflows.js.map +1 -0
  68. package/dist/utils/workflows.test.d.ts +2 -0
  69. package/dist/utils/workflows.test.d.ts.map +1 -0
  70. package/dist/utils/workflows.test.js +86 -0
  71. package/dist/utils/workflows.test.js.map +1 -0
  72. package/extension/media/icon.svg +1 -0
  73. package/extension/package-lock.json +2673 -2811
  74. package/extension/package.json +108 -70
  75. package/extension/src/extension.ts +631 -204
  76. package/extension/tsconfig.json +21 -19
  77. package/gui/README.md +73 -73
  78. package/gui/e2e/wizard.spec.ts +346 -327
  79. package/gui/eslint.config.js +26 -26
  80. package/gui/index.html +17 -17
  81. package/gui/package-lock.json +3079 -3118
  82. package/gui/package.json +36 -36
  83. package/gui/playwright.config.ts +41 -41
  84. package/gui/public/app_logo.png +0 -0
  85. package/gui/public/icons.svg +24 -24
  86. package/gui/src/App.css +1 -1
  87. package/gui/src/App.tsx +3407 -2722
  88. package/gui/src/assets/vite.svg +1 -1
  89. package/gui/src/features/changes/ChangesViewer.tsx +388 -388
  90. package/gui/src/features/knowledge/KnowledgeBase.tsx +84 -84
  91. package/gui/src/features/onboarding/OnboardingWizard.tsx +230 -230
  92. package/gui/src/features/plan/ImplementationPlan.tsx +32 -32
  93. package/gui/src/features/services/ServiceConsole.tsx +250 -250
  94. package/gui/src/features/sessions/SessionHistory.tsx +195 -195
  95. package/gui/src/features/workspace/WorkspaceList.tsx +666 -666
  96. package/gui/src/index.css +152 -110
  97. package/gui/src/main.tsx +94 -10
  98. package/gui/src/types.ts +62 -62
  99. package/gui/tsconfig.app.json +25 -25
  100. package/gui/tsconfig.json +7 -7
  101. package/gui/tsconfig.node.json +24 -24
  102. package/gui/vite.config.ts +12 -12
  103. package/package.json +56 -56
  104. package/resources/workflows/plan-implement-review.md +8 -0
  105. package/resources/workflows/research-verify.md +6 -0
  106. package/resources/workflows/solo-developer.md +3 -0
  107. package/scripts/simulate-workspaces.ts +55 -55
  108. package/src/analyzers/detect-apis.ts +290 -290
  109. package/src/analyzers/detect-deps.ts +315 -315
  110. package/src/analyzers/detect-existing.ts +74 -74
  111. package/src/analyzers/detect-ports.ts +110 -110
  112. package/src/analyzers/index.ts +97 -97
  113. package/src/analyzers/messaging-analyzer.ts +254 -254
  114. package/src/analyzers/readme-summarizer.ts +102 -102
  115. package/src/analyzers/run-analyzer.ts +269 -269
  116. package/src/analyzers/tech-stack.ts +283 -283
  117. package/src/commands/add-repo.ts +157 -157
  118. package/src/commands/commands.test.ts +155 -155
  119. package/src/commands/commit.ts +131 -131
  120. package/src/commands/create.ts +207 -207
  121. package/src/commands/desktop.ts +128 -0
  122. package/src/commands/diff.ts +125 -125
  123. package/src/commands/doctor.ts +357 -357
  124. package/src/commands/handoff.ts +266 -266
  125. package/src/commands/init.ts +134 -134
  126. package/src/commands/list.ts +46 -46
  127. package/src/commands/logs.ts +63 -63
  128. package/src/commands/mcp.ts +92 -92
  129. package/src/commands/open.ts +129 -129
  130. package/src/commands/pack.ts +73 -73
  131. package/src/commands/refresh.ts +147 -147
  132. package/src/commands/remove.ts +98 -98
  133. package/src/commands/start.ts +117 -117
  134. package/src/commands/status.ts +54 -54
  135. package/src/commands/stop.ts +55 -55
  136. package/src/commands/sync.ts +151 -153
  137. package/src/commands/tui.ts +424 -0
  138. package/src/commands/ui.ts +111 -47
  139. package/src/core/config.test.ts +96 -96
  140. package/src/core/config.ts +115 -115
  141. package/src/core/graph.ts +344 -344
  142. package/src/core/packer.test.ts +99 -99
  143. package/src/core/packer.ts +107 -107
  144. package/src/core/scanner.test.ts +61 -61
  145. package/src/core/scanner.ts +91 -91
  146. package/src/core/workspace.ts +380 -380
  147. package/src/core/worktree.ts +120 -120
  148. package/src/generators/antigravity.ts +32 -32
  149. package/src/generators/base.ts +240 -227
  150. package/src/generators/claude.ts +34 -34
  151. package/src/generators/codex.ts +48 -48
  152. package/src/generators/copilot.ts +56 -56
  153. package/src/generators/cursor.ts +44 -44
  154. package/src/generators/index.ts +250 -250
  155. package/src/generators/map-generator.test.ts +159 -159
  156. package/src/generators/map-generator.ts +542 -542
  157. package/src/generators/plan-generator.ts +481 -481
  158. package/src/generators/skills-generator.ts +259 -259
  159. package/src/index.ts +426 -382
  160. package/src/mcp/server.ts +294 -294
  161. package/src/orchestration/detect.ts +313 -313
  162. package/src/orchestration/index.ts +7 -7
  163. package/src/orchestration/runner.ts +283 -283
  164. package/src/server.test.ts +555 -464
  165. package/src/server.ts +1308 -1104
  166. package/src/types.ts +408 -403
  167. package/src/utils/detect-ai.test.ts +44 -44
  168. package/src/utils/detect-ai.ts +84 -84
  169. package/src/utils/detect-editors.test.ts +48 -48
  170. package/src/utils/detect-editors.ts +57 -57
  171. package/src/utils/git.test.ts +74 -74
  172. package/src/utils/git.ts +117 -61
  173. package/src/utils/local-ai.test.ts +130 -130
  174. package/src/utils/local-ai.ts +111 -111
  175. package/src/utils/multi-git.ts +313 -306
  176. package/src/utils/prompts.ts +209 -209
  177. package/src/utils/session-finder.ts +483 -483
  178. package/src/utils/system-scanner.test.ts +89 -89
  179. package/src/utils/system-scanner.ts +96 -96
  180. package/src/utils/update-check.ts +309 -275
  181. package/src/utils/workflows.test.ts +114 -0
  182. package/src/utils/workflows.ts +178 -0
  183. package/tsconfig.json +19 -19
  184. package/vitest.config.ts +14 -14
  185. package/dist/gui/assets/index-CFWwqFux.js +0 -23
  186. package/dist/gui/assets/index-Dvc9QMvl.css +0 -2
@@ -1,52 +1,52 @@
1
- version: 2
2
- updates:
3
- # 1. Root npm dependencies
4
- - package-ecosystem: "npm"
5
- directory: "/"
6
- schedule:
7
- interval: "daily"
8
- time: "03:00"
9
- open-pull-requests-limit: 10
10
- reviewers:
11
- - "antan87"
12
- groups:
13
- root-minor-patch:
14
- patterns:
15
- - "*"
16
- update-types:
17
- - "minor"
18
- - "patch"
19
-
20
- # 2. GUI npm dependencies
21
- - package-ecosystem: "npm"
22
- directory: "/gui"
23
- schedule:
24
- interval: "daily"
25
- time: "03:00"
26
- open-pull-requests-limit: 10
27
- reviewers:
28
- - "antan87"
29
- groups:
30
- gui-minor-patch:
31
- patterns:
32
- - "*"
33
- update-types:
34
- - "minor"
35
- - "patch"
36
-
37
- # 3. VS Code Extension npm dependencies
38
- - package-ecosystem: "npm"
39
- directory: "/extension"
40
- schedule:
41
- interval: "daily"
42
- time: "03:00"
43
- open-pull-requests-limit: 10
44
- reviewers:
45
- - "antan87"
46
- groups:
47
- extension-minor-patch:
48
- patterns:
49
- - "*"
50
- update-types:
51
- - "minor"
52
- - "patch"
1
+ version: 2
2
+ updates:
3
+ # 1. Root npm dependencies
4
+ - package-ecosystem: "npm"
5
+ directory: "/"
6
+ schedule:
7
+ interval: "daily"
8
+ time: "03:00"
9
+ open-pull-requests-limit: 10
10
+ reviewers:
11
+ - "antan87"
12
+ groups:
13
+ root-minor-patch:
14
+ patterns:
15
+ - "*"
16
+ update-types:
17
+ - "minor"
18
+ - "patch"
19
+
20
+ # 2. GUI npm dependencies
21
+ - package-ecosystem: "npm"
22
+ directory: "/gui"
23
+ schedule:
24
+ interval: "daily"
25
+ time: "03:00"
26
+ open-pull-requests-limit: 10
27
+ reviewers:
28
+ - "antan87"
29
+ groups:
30
+ gui-minor-patch:
31
+ patterns:
32
+ - "*"
33
+ update-types:
34
+ - "minor"
35
+ - "patch"
36
+
37
+ # 3. VS Code Extension npm dependencies
38
+ - package-ecosystem: "npm"
39
+ directory: "/extension"
40
+ schedule:
41
+ interval: "daily"
42
+ time: "03:00"
43
+ open-pull-requests-limit: 10
44
+ reviewers:
45
+ - "antan87"
46
+ groups:
47
+ extension-minor-patch:
48
+ patterns:
49
+ - "*"
50
+ update-types:
51
+ - "minor"
52
+ - "patch"
@@ -0,0 +1,53 @@
1
+ name: Dependabot Auto-Merge and Version Bump
2
+
3
+ on:
4
+ pull_request_target:
5
+ types: [opened, reopened, synchronize]
6
+ branches: [main]
7
+
8
+ permissions:
9
+ contents: write
10
+ pull-requests: write
11
+
12
+ jobs:
13
+ dependabot:
14
+ runs-on: ubuntu-latest
15
+ if: github.actor == 'dependabot[bot]'
16
+ steps:
17
+ - name: Checkout PR branch
18
+ uses: actions/checkout@v4
19
+ with:
20
+ ref: ${{ github.event.pull_request.head.ref }}
21
+ fetch-depth: 0
22
+
23
+ - name: Setup Node.js
24
+ uses: actions/setup-node@v4
25
+ with:
26
+ node-version: 20
27
+
28
+ - name: Bump Version
29
+ run: |
30
+ # Configure Git
31
+ git config user.name "github-actions[bot]"
32
+ git config user.email "github-actions[bot]@users.noreply.github.com"
33
+
34
+ # Fetch main to compare versions
35
+ git fetch origin main:main
36
+
37
+ MAIN_VERSION=$(git show main:package.json | node -e "console.log(JSON.parse(require('fs').readFileSync(0, 'utf-8')).version)")
38
+ PR_VERSION=$(node -e "console.log(JSON.parse(require('fs').readFileSync('package.json', 'utf-8')).version)")
39
+
40
+ if [ "$PR_VERSION" = "$MAIN_VERSION" ]; then
41
+ echo "Version has not been bumped yet. Bumping patch version..."
42
+ npm version patch --no-git-tag-version
43
+ git add package.json package-lock.json
44
+ git commit -m "chore: bump version for dependabot update"
45
+ git push origin HEAD:${{ github.event.pull_request.head.ref }}
46
+ else
47
+ echo "Version is already bumped ($PR_VERSION vs main $MAIN_VERSION). Skipping bump."
48
+ fi
49
+
50
+ - name: Enable Auto-Merge
51
+ run: gh pr merge --auto --merge "${{ github.event.pull_request.html_url }}"
52
+ env:
53
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -1,100 +1,112 @@
1
- name: Release & Publish
2
-
3
- on:
4
- push:
5
- branches: [main]
6
- pull_request:
7
- branches: [main]
8
-
9
- permissions:
10
- contents: write
11
-
12
- jobs:
13
- build-and-test:
14
- runs-on: ubuntu-latest
15
- steps:
16
- - name: Checkout Repository
17
- uses: actions/checkout@v4
18
-
19
- - name: Setup Node.js
20
- uses: actions/setup-node@v4
21
- with:
22
- node-version: 20
23
-
24
- - name: Install Dependencies
25
- run: npm ci
26
-
27
- - name: Install GUI Dependencies
28
- run: npm ci --prefix gui
29
-
30
- - name: Install Extension Dependencies
31
- run: npm ci --prefix extension
32
-
33
- - name: Build Project
34
- run: npm run build
35
-
36
- - name: Run Tests
37
- run: npm test
38
-
39
- - name: Install Playwright Browsers
40
- run: npx playwright install chromium --with-deps
41
- working-directory: gui
42
-
43
- - name: Run GUI E2E Tests
44
- run: npm run test:gui
45
-
46
- publish:
47
- needs: build-and-test
48
- runs-on: ubuntu-latest
49
- if: github.event_name == 'push' && github.ref == 'refs/heads/main'
50
- steps:
51
- - name: Checkout Repository
52
- uses: actions/checkout@v4
53
-
54
- - name: Setup Node.js
55
- uses: actions/setup-node@v4
56
- with:
57
- node-version: 20
58
- registry-url: 'https://registry.npmjs.org/'
59
-
60
- - name: Install Dependencies
61
- run: npm ci
62
-
63
- - name: Install GUI Dependencies
64
- run: npm ci --prefix gui
65
-
66
- - name: Install Extension Dependencies
67
- run: npm ci --prefix extension
68
-
69
- - name: Build Project
70
- run: npm run build
71
-
72
- - name: Check version and NPM
73
- id: check-version
74
- run: |
75
- CURRENT_VERSION=$(node -e "console.log(JSON.parse(require('fs').readFileSync('./package.json', 'utf8')).version)")
76
- echo "version=$CURRENT_VERSION" >> $GITHUB_OUTPUT
77
- if npm info @mrpatronz/nexusflow@$CURRENT_VERSION --json >/dev/null 2>&1; then
78
- echo "is_new=false" >> $GITHUB_OUTPUT
79
- echo "Version $CURRENT_VERSION is already published on NPM. Skipping publish."
80
- else
81
- echo "is_new=true" >> $GITHUB_OUTPUT
82
- echo "Version $CURRENT_VERSION is new."
83
- fi
84
- env:
85
- NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
86
-
87
- - name: Publish to NPM
88
- if: steps.check-version.outputs.is_new == 'true'
89
- run: npm publish --access public
90
- env:
91
- NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
92
-
93
- - name: Create GitHub Release
94
- if: steps.check-version.outputs.is_new == 'true'
95
- uses: softprops/action-gh-release@v2
96
- with:
97
- tag_name: v${{ steps.check-version.outputs.version }}
98
- name: Release v${{ steps.check-version.outputs.version }}
99
- generate_release_notes: true
100
- target_commitish: ${{ github.sha }}
1
+ name: Release & Publish
2
+
3
+ on:
4
+ push:
5
+ branches: [main]
6
+ pull_request:
7
+ branches: [main]
8
+
9
+ permissions:
10
+ contents: write
11
+
12
+ jobs:
13
+ build-and-test:
14
+ runs-on: ubuntu-latest
15
+ steps:
16
+ - name: Checkout Repository
17
+ uses: actions/checkout@v4
18
+
19
+ - name: Setup Node.js
20
+ uses: actions/setup-node@v4
21
+ with:
22
+ node-version: 20
23
+
24
+ - name: Install Dependencies
25
+ run: npm ci
26
+
27
+ - name: Install GUI Dependencies
28
+ run: npm ci --prefix gui
29
+
30
+ - name: Install Extension Dependencies
31
+ run: npm ci --prefix extension
32
+
33
+ - name: Build Project
34
+ run: npm run build
35
+
36
+ - name: Run Tests
37
+ run: npm test
38
+
39
+ - name: Install Playwright Browsers
40
+ run: npx playwright install chromium --with-deps
41
+ working-directory: gui
42
+
43
+ - name: Run GUI E2E Tests
44
+ run: npm run test:gui
45
+
46
+ publish:
47
+ needs: build-and-test
48
+ runs-on: windows-latest
49
+ if: github.event_name == 'push' && github.ref == 'refs/heads/main'
50
+ steps:
51
+ - name: Checkout Repository
52
+ uses: actions/checkout@v4
53
+
54
+ - name: Setup Node.js
55
+ uses: actions/setup-node@v4
56
+ with:
57
+ node-version: 20
58
+ registry-url: 'https://registry.npmjs.org/'
59
+
60
+ - name: Install Dependencies
61
+ run: npm ci
62
+
63
+ - name: Install GUI Dependencies
64
+ run: npm ci --prefix gui
65
+
66
+ - name: Install Extension Dependencies
67
+ run: npm ci --prefix extension
68
+
69
+ - name: Install Desktop Dependencies
70
+ run: npm ci --prefix desktop
71
+
72
+ - name: Build Project
73
+ run: npm run build
74
+
75
+ - name: Build Desktop GUI & Binaries
76
+ run: npm run build --prefix desktop
77
+
78
+ - name: Build Standalone Installer
79
+ run: npm run build:installer --prefix desktop
80
+
81
+ - name: Check version and NPM
82
+ id: check-version
83
+ shell: bash
84
+ run: |
85
+ CURRENT_VERSION=$(node -e "console.log(JSON.parse(require('fs').readFileSync('./package.json', 'utf8')).version)")
86
+ echo "version=$CURRENT_VERSION" >> $GITHUB_OUTPUT
87
+ if npm info @mrpatronz/nexusflow@$CURRENT_VERSION --json >/dev/null 2>&1; then
88
+ echo "is_new=false" >> $GITHUB_OUTPUT
89
+ echo "Version $CURRENT_VERSION is already published on NPM. Skipping publish."
90
+ else
91
+ echo "is_new=true" >> $GITHUB_OUTPUT
92
+ echo "Version $CURRENT_VERSION is new."
93
+ fi
94
+ env:
95
+ NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
96
+
97
+ - name: Publish to NPM
98
+ if: steps.check-version.outputs.is_new == 'true'
99
+ run: npm publish --access public
100
+ env:
101
+ NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
102
+
103
+ - name: Create GitHub Release
104
+ if: steps.check-version.outputs.is_new == 'true'
105
+ uses: softprops/action-gh-release@v2
106
+ with:
107
+ tag_name: v${{ steps.check-version.outputs.version }}
108
+ name: Release v${{ steps.check-version.outputs.version }}
109
+ generate_release_notes: true
110
+ target_commitish: ${{ github.sha }}
111
+ files: |
112
+ desktop/dist-installer-output/NexusFlowSetup.exe
@@ -1,17 +1,17 @@
1
- {
2
- "version": "0.2.0",
3
- "configurations": [
4
- {
5
- "name": "Launch Extension",
6
- "type": "extensionHost",
7
- "request": "launch",
8
- "args": [
9
- "--extensionDevelopmentPath=${workspaceRoot}/extension"
10
- ],
11
- "outFiles": [
12
- "${workspaceRoot}/extension/dist/**/*.js"
13
- ],
14
- "preLaunchTask": "npm: extension-compile"
15
- }
16
- ]
17
- }
1
+ {
2
+ "version": "0.2.0",
3
+ "configurations": [
4
+ {
5
+ "name": "Launch Extension",
6
+ "type": "extensionHost",
7
+ "request": "launch",
8
+ "args": [
9
+ "--extensionDevelopmentPath=${workspaceRoot}/extension"
10
+ ],
11
+ "outFiles": [
12
+ "${workspaceRoot}/extension/dist/**/*.js"
13
+ ],
14
+ "preLaunchTask": "npm: extension-compile"
15
+ }
16
+ ]
17
+ }
@@ -1,17 +1,17 @@
1
- {
2
- "version": "2.0.0",
3
- "tasks": [
4
- {
5
- "type": "npm",
6
- "script": "extension:compile",
7
- "group": {
8
- "kind": "build",
9
- "isDefault": true
10
- },
11
- "label": "npm: extension-compile",
12
- "problemMatcher": [
13
- "$tsc"
14
- ]
15
- }
16
- ]
17
- }
1
+ {
2
+ "version": "2.0.0",
3
+ "tasks": [
4
+ {
5
+ "type": "npm",
6
+ "script": "extension:compile",
7
+ "group": {
8
+ "kind": "build",
9
+ "isDefault": true
10
+ },
11
+ "label": "npm: extension-compile",
12
+ "problemMatcher": [
13
+ "$tsc"
14
+ ]
15
+ }
16
+ ]
17
+ }
@@ -1,109 +1,114 @@
1
- # NexusFlow — Getting Started Guide
2
-
3
- Welcome to **NexusFlow**! This guide will walk you through the system, explain its core workflows, and show you how to leverage multi-repository workspaces and agentic orchestration to accelerate feature development.
4
-
5
- ---
6
-
7
- ## 💡 What is NexusFlow?
8
-
9
- When developing complex features in modern systems, you often need to touch multiple repositories simultaneously (e.g., modifying a shared package, updating a backend REST API, and updating a frontend application).
10
-
11
- Traditional AI assistant setups only give the assistant context of a single repository. NexusFlow solves this by:
12
- 1. **Grouping Repositories**: Creating a dedicated workspace using **git worktrees** on a unified feature branch name.
13
- 2. **Generating AI Context**: Writing specialized configurations (`CLAUDE.md`, `AGENTS.md`, Copilot guidelines, and Cursor rules) that outline the workspace architecture.
14
- 3. **Smart Codebase Analysis**: Scanning tech stacks, ports, and API endpoints so the AI instantly understands the codebase boundaries.
15
- 4. **Service Orchestration**: Running, stopping, and logging all projects simultaneously from a single place.
16
-
17
- ---
18
-
19
- ## 🚀 Step-by-Step Workflow
20
-
21
- Here is how to get started with your first feature workspace.
22
-
23
- ```mermaid
24
- flowchart TD
25
- A["1. Run Web GUI or CLI"] --> B["2. Fill Feature Details & Pick Repos"]
26
- B --> C["3. Workspace Created\n(Git Worktrees + Context generated)"]
27
- C --> D["4. AI Agent Initializes\n(Fills nexusflow-overview.md + questions)"]
28
- D --> E["5. Confirm Assumptions & Spin up services"]
29
- ```
30
-
31
- ### 1. Initialize NexusFlow
32
- First, initialize the default configuration on your machine:
33
- ```bash
34
- nexusflow init
35
- ```
36
- This sets up `~/.nexusflow/config.json` with default settings:
37
- * **Development Directory**: Where your git repositories are located (defaults to `~/dev`).
38
- * **Workspaces Directory**: Where your worktrees will be created (defaults to `~/dev/workspaces`).
39
-
40
- ---
41
-
42
- ### 2. Launch the Web Dashboard
43
- NexusFlow comes with a rich, interactive Web Dashboard. Launch it by running:
44
- ```bash
45
- nexusflow ui
46
- ```
47
- This starts the local backend server on port `3000` and automatically opens the browser.
48
-
49
- ---
50
-
51
- ### 3. Create a Feature Workspace
52
- On the dashboard (or via the `nexusflow create` CLI command):
53
- 1. **Branch name**: Enter your branch name (e.g. `feature/user-profiles`). Slashes are supported!
54
- 2. **Description**: Describe the feature you are building. The AI assistant will read this to compile the plan.
55
- 3. **Pick Repositories**: Choose which repositories you need to modify or reference.
56
- 4. **Assistant Selection**: Select which AI coding assistants you plan to use (Claude Code, Antigravity, Cursor, etc.).
57
- 5. **Click Build Workspace**: NexusFlow will fetch origin updates, create local branches, spin up git worktrees under `workspaces/feature/user-profiles`, run tech analyses, and write context configurations.
58
-
59
- ---
60
-
61
- ### 4. The Agentic Initialization (Universal Context)
62
- Once the workspace is built, open it in your preferred AI assistant.
63
-
64
- Whichever AI harness you use, **the agent's very first instructions** are to:
65
- 1. Scan the workspace projects.
66
- 2. Create a universal reference file: **`nexusflow-overview.md`**.
67
- 3. Write down its assumptions of what each project does, how they interact, and their responsibilities.
68
- 4. List any **Clarifying Questions** it needs you to answer before coding.
69
-
70
- **Your Action**: Review the generated `nexusflow-overview.md`, answer the assistant's questions directly in the chat or file, and confirm its assumptions. This ensures you and the agent are aligned before a single line of code is modified.
71
-
72
- ---
73
-
74
- ### 5. Orchestrate Local Services
75
- You don't need to open five terminal windows to start your backend, frontend, databases, or libraries.
76
-
77
- **On the Web Dashboard:**
78
- * Expand your active workspace to see all detected services (e.g. node scripts, dotnet servers, python hosts).
79
- * Click **Start All** to spin them up.
80
- * View aggregate console streams inside the tabbed retro-terminal output screen.
81
-
82
- **Via the CLI:**
83
- * Navigate to your workspace directory and run:
84
- ```bash
85
- nexusflow start
86
- ```
87
- * Check logs or stop services with:
88
- ```bash
89
- nexusflow logs
90
- nexusflow stop
91
- ```
92
-
93
- ---
94
-
95
- ## 🛠️ CLI Reference
96
-
97
- Here is a summary of the command-line interface:
98
-
99
- | Command | Usage | Description |
100
- | :--- | :--- | :--- |
101
- | **`nexusflow ui`** | `nexusflow ui [-p <port>]` | Starts the backend Hono API server and opens the GUI Dashboard. |
102
- | **`nexusflow create`** | `nexusflow create` | Launches the interactive step-by-step terminal wizard to build a workspace. |
103
- | **`nexusflow list`** | `nexusflow list` / `nexusflow ls` | Lists all active feature workspaces discovered on your machine. |
104
- | **`nexusflow open`** | `nexusflow open` | Prompts you to pick an active workspace and opens it in your editor. |
105
- | **`nexusflow start`** | `nexusflow start [path]` | Starts background processes for all projects in the workspace. |
106
- | **`nexusflow stop`** | `nexusflow stop [path]` | Kills all running processes for the workspace. |
107
- | **`nexusflow logs`** | `nexusflow logs [path] [-n <lines>]` | Tails output log files for all service processes in the workspace. |
108
- | **`nexusflow status`** | `nexusflow status [path]` | Displays running/stopped statuses and PIDs for each service. |
109
- | **`nexusflow init`** | `nexusflow init` | Creates or edits the global config file. |
1
+ # NexusFlow — Getting Started Guide
2
+
3
+ Welcome to **NexusFlow**! This guide will walk you through the system, explain its core workflows, and show you how to leverage multi-repository workspaces and agentic orchestration to accelerate feature development.
4
+
5
+ ---
6
+
7
+ ## 💡 What is NexusFlow?
8
+
9
+ When developing complex features in modern systems, you often need to touch multiple repositories simultaneously (e.g., modifying a shared package, updating a backend REST API, and updating a frontend application).
10
+
11
+ Traditional AI assistant setups only give the assistant context of a single repository. NexusFlow solves this by:
12
+ 1. **Grouping Repositories**: Creating a dedicated workspace using **git worktrees** on a unified feature branch name.
13
+ 2. **Generating AI Context**: Writing specialized configurations (`CLAUDE.md`, `AGENTS.md`, Copilot guidelines, and Cursor rules) that outline the workspace architecture.
14
+ 3. **Smart Codebase Analysis**: Scanning tech stacks, ports, and API endpoints so the AI instantly understands the codebase boundaries.
15
+ 4. **Service Orchestration**: Running, stopping, and logging all projects simultaneously from a single place.
16
+
17
+ ---
18
+
19
+ ## 🚀 Step-by-Step Workflow
20
+
21
+ Here is how to get started with your first feature workspace.
22
+
23
+ ```mermaid
24
+ flowchart TD
25
+ A["1. Run Web GUI or CLI"] --> B["2. Fill Feature Details & Pick Repos"]
26
+ B --> C["3. Workspace Created\n(Git Worktrees + Context generated)"]
27
+ C --> D["4. AI Agent Initializes\n(Fills nexusflow-overview.md + questions)"]
28
+ D --> E["5. Confirm Assumptions & Spin up services"]
29
+ ```
30
+
31
+ ### 1. Initialize NexusFlow
32
+ First, initialize the default configuration on your machine:
33
+ ```bash
34
+ nexusflow init
35
+ ```
36
+ This sets up `~/.nexusflow/config.json` with default settings:
37
+ * **Development Directory**: Where your git repositories are located (defaults to `~/dev`).
38
+ * **Workspaces Directory**: Where your worktrees will be created (defaults to `~/dev/workspaces`).
39
+
40
+ ---
41
+
42
+ ### 2. Launch the Web Dashboard
43
+ NexusFlow comes with a rich, interactive Web Dashboard. Launch it by running:
44
+ ```bash
45
+ nexusflow ui
46
+ ```
47
+ This starts the local backend server on port `3000` and automatically opens the browser.
48
+
49
+ ---
50
+
51
+ ### 3. Create a Feature Workspace
52
+ On the dashboard (or via the `nexusflow create` CLI command):
53
+ 1. **Branch name**: Enter your branch name (e.g. `feature/user-profiles`). Slashes are supported!
54
+ 2. **Description**: Describe the feature you are building. The AI assistant will read this to compile the plan.
55
+ 3. **Pick Repositories**: Choose which repositories you need to modify or reference.
56
+ 4. **Assistant Selection**: Select which AI coding assistants you plan to use (Claude Code, Antigravity, Cursor, etc.).
57
+ 5. **Click Build Workspace**: NexusFlow will fetch origin updates, create local branches, spin up git worktrees under `workspaces/feature/user-profiles`, run tech analyses, and write context configurations.
58
+
59
+ ---
60
+
61
+ ### 4. The Agentic Initialization (Universal Context)
62
+ Once the workspace is built, open it in your preferred AI assistant.
63
+
64
+ Whichever AI harness you use, **the agent's very first instructions** are to:
65
+ 1. Scan the workspace projects.
66
+ 2. Create a universal reference file: **`nexusflow-overview.md`**.
67
+ 3. Write down its assumptions of what each project does, how they interact, and their responsibilities.
68
+ 4. List any **Clarifying Questions** it needs you to answer before coding.
69
+
70
+ **Your Action**: Review the generated `nexusflow-overview.md`, answer the assistant's questions directly in the chat or file, and confirm its assumptions. This ensures you and the agent are aligned before a single line of code is modified.
71
+
72
+ ---
73
+
74
+ ### 5. Orchestrate Local Services
75
+ You don't need to open five terminal windows to start your backend, frontend, databases, or libraries.
76
+
77
+ **On the Web Dashboard:**
78
+ * Expand your active workspace to see all detected services (e.g. node scripts, dotnet servers, python hosts).
79
+ * Click **Start All** to spin them up.
80
+ * View aggregate console streams inside the tabbed retro-terminal output screen.
81
+
82
+ **Via the CLI:**
83
+ * Navigate to your workspace directory and run:
84
+ ```bash
85
+ nexusflow start
86
+ ```
87
+ * Check logs or stop services with:
88
+ ```bash
89
+ nexusflow logs
90
+ nexusflow stop
91
+ ```
92
+
93
+ ---
94
+
95
+ ## 🛠️ CLI Reference
96
+
97
+ Here is a summary of the command-line interface:
98
+
99
+ | Command | Usage | Description |
100
+ | :--- | :--- | :--- |
101
+ | **`nexusflow ui`** | `nexusflow ui [-p <port>]` | Starts the backend Hono API server and opens the GUI Dashboard. |
102
+ | **`nexusflow create`** | `nexusflow create` | Launches the interactive step-by-step terminal wizard to build a workspace. |
103
+ | **`nexusflow list`** | `nexusflow list` / `nexusflow ls` | Lists all active feature workspaces discovered on your machine. |
104
+ | **`nexusflow open`** | `nexusflow open` | Prompts you to pick an active workspace and opens it in your editor. |
105
+ | **`nexusflow start`** | `nexusflow start [path]` | Starts background processes for all projects in the workspace. |
106
+ | **`nexusflow stop`** | `nexusflow stop [path]` | Kills all running processes for the workspace. |
107
+ | **`nexusflow logs`** | `nexusflow logs [path] [-n <lines>]` | Tails output log files for all service processes in the workspace. |
108
+ | **`nexusflow status`** | `nexusflow status [path]` | Displays running/stopped statuses and PIDs for each service. |
109
+ | **`nexusflow init`** | `nexusflow init` | Creates or edits the global config file. |
110
+ | **`nexusflow diff`** | `nexusflow diff` | Displays pending code changes across all active workspace repositories. |
111
+ | **`nexusflow commit`** | `nexusflow commit` | Automates cross-repository git commit and branch pushes in the workspace. |
112
+ | **`nexusflow sync`** | `nexusflow sync` | Syncs and rebases all workspace worktrees with default base branches. |
113
+ | **`nexusflow refresh`**| `nexusflow refresh` | Regenerates architecture maps, task plans, and AI context files. |
114
+ | **`nexusflow doctor`** | `nexusflow doctor` | Assesses and reports diagnostics of the current workspace setup. |