@mrpatronz/nexusflow 0.2.17 → 0.2.18

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 (274) hide show
  1. package/.agents/skills/ccc/SKILL.md +71 -0
  2. package/.agents/skills/ccc/references/management.md +110 -0
  3. package/.agents/skills/ccc/references/settings.md +126 -0
  4. package/.github/dependabot.yml +52 -52
  5. package/.github/workflows/ci.yml +44 -0
  6. package/.github/workflows/dependabot-merge.yml +53 -53
  7. package/.github/workflows/release-desktop.yml +67 -0
  8. package/.github/workflows/release-npm.yml +65 -0
  9. package/.github/workflows/release-vscode.yml +61 -0
  10. package/.vscode/launch.json +17 -17
  11. package/.vscode/tasks.json +17 -17
  12. package/GETTING_STARTED.md +114 -114
  13. package/README.md +364 -336
  14. package/desktop/build-installer.js +228 -228
  15. package/desktop/build.js +118 -118
  16. package/desktop/installer/nexusflow.iss +35 -35
  17. package/desktop/neutralino.config.json +38 -38
  18. package/desktop/package-lock.json +1060 -1060
  19. package/desktop/package.json +14 -14
  20. package/dist/commands/adapter.d.ts +27 -0
  21. package/dist/commands/adapter.d.ts.map +1 -0
  22. package/dist/commands/adapter.js +318 -0
  23. package/dist/commands/adapter.js.map +1 -0
  24. package/dist/commands/add-repo.d.ts.map +1 -1
  25. package/dist/commands/add-repo.js +0 -1
  26. package/dist/commands/add-repo.js.map +1 -1
  27. package/dist/commands/commands.test.js +2 -2
  28. package/dist/commands/commands.test.js.map +1 -1
  29. package/dist/commands/config.d.ts +22 -0
  30. package/dist/commands/config.d.ts.map +1 -0
  31. package/dist/commands/config.js +50 -0
  32. package/dist/commands/config.js.map +1 -0
  33. package/dist/commands/create.d.ts.map +1 -1
  34. package/dist/commands/create.js +14 -17
  35. package/dist/commands/create.js.map +1 -1
  36. package/dist/commands/doctor.d.ts.map +1 -1
  37. package/dist/commands/doctor.js +11 -0
  38. package/dist/commands/doctor.js.map +1 -1
  39. package/dist/commands/refresh.d.ts +1 -0
  40. package/dist/commands/refresh.d.ts.map +1 -1
  41. package/dist/commands/refresh.js +2 -14
  42. package/dist/commands/refresh.js.map +1 -1
  43. package/dist/commands/sync.d.ts.map +1 -1
  44. package/dist/commands/sync.js +0 -5
  45. package/dist/commands/sync.js.map +1 -1
  46. package/dist/commands/tui.d.ts.map +1 -1
  47. package/dist/commands/tui.js +63 -10
  48. package/dist/commands/tui.js.map +1 -1
  49. package/dist/core/adapters/local-storage.d.ts +14 -0
  50. package/dist/core/adapters/local-storage.d.ts.map +1 -0
  51. package/dist/core/adapters/local-storage.js +58 -0
  52. package/dist/core/adapters/local-storage.js.map +1 -0
  53. package/dist/core/adapters/obsidian-storage.d.ts +28 -0
  54. package/dist/core/adapters/obsidian-storage.d.ts.map +1 -0
  55. package/dist/core/adapters/obsidian-storage.js +135 -0
  56. package/dist/core/adapters/obsidian-storage.js.map +1 -0
  57. package/dist/core/adapters/registry.d.ts +8 -0
  58. package/dist/core/adapters/registry.d.ts.map +1 -0
  59. package/dist/core/adapters/registry.js +37 -0
  60. package/dist/core/adapters/registry.js.map +1 -0
  61. package/dist/core/adapters/storage.test.d.ts +2 -0
  62. package/dist/core/adapters/storage.test.d.ts.map +1 -0
  63. package/dist/core/adapters/storage.test.js +106 -0
  64. package/dist/core/adapters/storage.test.js.map +1 -0
  65. package/dist/core/adapters/vault-storage.d.ts +16 -0
  66. package/dist/core/adapters/vault-storage.d.ts.map +1 -0
  67. package/dist/core/adapters/vault-storage.js +77 -0
  68. package/dist/core/adapters/vault-storage.js.map +1 -0
  69. package/dist/core/config.d.ts.map +1 -1
  70. package/dist/core/config.js +28 -4
  71. package/dist/core/config.js.map +1 -1
  72. package/dist/core/plugins/index.d.ts +14 -0
  73. package/dist/core/plugins/index.d.ts.map +1 -0
  74. package/dist/core/plugins/index.js +2 -0
  75. package/dist/core/plugins/index.js.map +1 -0
  76. package/dist/core/plugins/loader.d.ts +2 -0
  77. package/dist/core/plugins/loader.d.ts.map +1 -0
  78. package/dist/core/plugins/loader.js +34 -0
  79. package/dist/core/plugins/loader.js.map +1 -0
  80. package/dist/core/ports/storage.d.ts +59 -0
  81. package/dist/core/ports/storage.d.ts.map +1 -0
  82. package/dist/core/ports/storage.js +10 -0
  83. package/dist/core/ports/storage.js.map +1 -0
  84. package/dist/core/storage.d.ts +10 -0
  85. package/dist/core/storage.d.ts.map +1 -0
  86. package/dist/core/storage.js +29 -0
  87. package/dist/core/storage.js.map +1 -0
  88. package/dist/core/workspace.d.ts.map +1 -1
  89. package/dist/core/workspace.js +110 -16
  90. package/dist/core/workspace.js.map +1 -1
  91. package/dist/generators/base.d.ts.map +1 -1
  92. package/dist/generators/base.js +80 -79
  93. package/dist/generators/base.js.map +1 -1
  94. package/dist/generators/codex.js +11 -11
  95. package/dist/generators/copilot.js +17 -17
  96. package/dist/generators/cursor.js +5 -5
  97. package/dist/generators/diff-context.d.ts +6 -0
  98. package/dist/generators/diff-context.d.ts.map +1 -0
  99. package/dist/generators/diff-context.js +68 -0
  100. package/dist/generators/diff-context.js.map +1 -0
  101. package/dist/generators/index.d.ts +1 -1
  102. package/dist/generators/index.d.ts.map +1 -1
  103. package/dist/generators/index.js +125 -68
  104. package/dist/generators/index.js.map +1 -1
  105. package/dist/generators/map-generator.d.ts.map +1 -1
  106. package/dist/generators/map-generator.js +21 -25
  107. package/dist/generators/map-generator.js.map +1 -1
  108. package/dist/generators/plan-generator.d.ts.map +1 -1
  109. package/dist/generators/plan-generator.js +3 -5
  110. package/dist/generators/plan-generator.js.map +1 -1
  111. package/dist/generators/skills-generator.js +28 -28
  112. package/dist/gui/assets/index-CB-jWded.css +1 -0
  113. package/dist/gui/assets/index-DDXpZZu3.js +25 -0
  114. package/dist/gui/icons.svg +24 -24
  115. package/dist/gui/index.html +18 -18
  116. package/dist/index.js +131 -20
  117. package/dist/index.js.map +1 -1
  118. package/dist/server.d.ts.map +1 -1
  119. package/dist/server.js +46 -43
  120. package/dist/server.js.map +1 -1
  121. package/dist/server.test.js +105 -48
  122. package/dist/server.test.js.map +1 -1
  123. package/dist/types.d.ts +7 -2
  124. package/dist/types.d.ts.map +1 -1
  125. package/dist/utils/local-ai.d.ts.map +1 -1
  126. package/dist/utils/local-ai.js +7 -3
  127. package/dist/utils/local-ai.js.map +1 -1
  128. package/dist/utils/update-check.d.ts.map +1 -1
  129. package/dist/utils/update-check.js +0 -28
  130. package/dist/utils/update-check.js.map +1 -1
  131. package/dist/utils/workflow-advisor.d.ts +16 -0
  132. package/dist/utils/workflow-advisor.d.ts.map +1 -0
  133. package/dist/utils/workflow-advisor.js +100 -0
  134. package/dist/utils/workflow-advisor.js.map +1 -0
  135. package/extension/package-lock.json +6044 -2673
  136. package/extension/package.json +117 -108
  137. package/extension/src/extension.ts +653 -631
  138. package/extension/tsconfig.json +21 -21
  139. package/gui/README.md +73 -73
  140. package/gui/e2e/wizard.spec.ts +346 -346
  141. package/gui/eslint.config.js +26 -26
  142. package/gui/index.html +17 -17
  143. package/gui/package-lock.json +3079 -3079
  144. package/gui/package.json +36 -36
  145. package/gui/playwright.config.ts +41 -41
  146. package/gui/public/icons.svg +24 -24
  147. package/gui/src/App.css +1 -1
  148. package/gui/src/App.tsx +3632 -3407
  149. package/gui/src/assets/vite.svg +1 -1
  150. package/gui/src/features/changes/ChangesViewer.tsx +388 -388
  151. package/gui/src/features/knowledge/KnowledgeBase.tsx +84 -84
  152. package/gui/src/features/onboarding/OnboardingWizard.tsx +230 -230
  153. package/gui/src/features/plan/ImplementationPlan.tsx +32 -32
  154. package/gui/src/features/services/ServiceConsole.tsx +250 -250
  155. package/gui/src/features/sessions/SessionHistory.tsx +195 -195
  156. package/gui/src/features/workspace/WorkspaceList.tsx +666 -666
  157. package/gui/src/index.css +152 -152
  158. package/gui/src/main.tsx +94 -94
  159. package/gui/src/types.ts +62 -62
  160. package/gui/tsconfig.app.json +25 -25
  161. package/gui/tsconfig.json +7 -7
  162. package/gui/tsconfig.node.json +24 -24
  163. package/gui/vite.config.ts +12 -12
  164. package/package.json +55 -56
  165. package/resources/workflows/plan-implement-review.md +8 -8
  166. package/resources/workflows/research-verify.md +6 -6
  167. package/resources/workflows/solo-developer.md +3 -3
  168. package/scripts/simulate-workspaces.ts +55 -55
  169. package/skills-lock.json +11 -0
  170. package/src/analyzers/detect-apis.ts +290 -290
  171. package/src/analyzers/detect-deps.ts +315 -315
  172. package/src/analyzers/detect-existing.ts +74 -74
  173. package/src/analyzers/detect-ports.ts +110 -110
  174. package/src/analyzers/index.ts +97 -97
  175. package/src/analyzers/messaging-analyzer.ts +254 -254
  176. package/src/analyzers/readme-summarizer.ts +102 -102
  177. package/src/analyzers/run-analyzer.ts +269 -269
  178. package/src/analyzers/tech-stack.ts +283 -283
  179. package/src/commands/adapter.ts +348 -0
  180. package/src/commands/add-repo.ts +156 -157
  181. package/src/commands/commands.test.ts +156 -155
  182. package/src/commands/commit.ts +131 -131
  183. package/src/commands/config.ts +52 -0
  184. package/src/commands/create.ts +204 -207
  185. package/src/commands/desktop.ts +128 -128
  186. package/src/commands/diff.ts +125 -125
  187. package/src/commands/doctor.ts +370 -357
  188. package/src/commands/handoff.ts +266 -266
  189. package/src/commands/init.ts +134 -134
  190. package/src/commands/list.ts +46 -46
  191. package/src/commands/logs.ts +63 -63
  192. package/src/commands/mcp.ts +94 -92
  193. package/src/commands/open.ts +129 -129
  194. package/src/commands/refresh.ts +137 -147
  195. package/src/commands/remove.ts +98 -98
  196. package/src/commands/start.ts +117 -117
  197. package/src/commands/status.ts +54 -54
  198. package/src/commands/stop.ts +55 -55
  199. package/src/commands/sync.ts +147 -151
  200. package/src/commands/tui.ts +484 -424
  201. package/src/commands/ui.ts +111 -111
  202. package/src/core/adapters/local-storage.ts +66 -0
  203. package/src/core/adapters/obsidian-storage.ts +151 -0
  204. package/src/core/adapters/registry.ts +44 -0
  205. package/src/core/adapters/storage.test.ts +174 -0
  206. package/src/core/adapters/vault-storage.ts +86 -0
  207. package/src/core/config.test.ts +96 -96
  208. package/src/core/config.ts +140 -115
  209. package/src/core/graph.ts +344 -344
  210. package/src/core/plugins/index.ts +17 -0
  211. package/src/core/plugins/loader.ts +36 -0
  212. package/src/core/ports/storage.ts +71 -0
  213. package/src/core/scanner.test.ts +61 -61
  214. package/src/core/scanner.ts +91 -91
  215. package/src/core/storage.ts +37 -0
  216. package/src/core/workspace.ts +487 -380
  217. package/src/core/worktree.ts +120 -120
  218. package/src/generators/antigravity.ts +32 -32
  219. package/src/generators/base.ts +243 -240
  220. package/src/generators/claude.ts +34 -34
  221. package/src/generators/codex.ts +48 -48
  222. package/src/generators/copilot.ts +56 -56
  223. package/src/generators/cursor.ts +44 -44
  224. package/src/generators/diff-context.ts +75 -0
  225. package/src/generators/index.ts +322 -250
  226. package/src/generators/map-generator.test.ts +159 -159
  227. package/src/generators/map-generator.ts +539 -542
  228. package/src/generators/plan-generator.ts +483 -481
  229. package/src/generators/skills-generator.ts +259 -259
  230. package/src/index.ts +539 -426
  231. package/src/mcp/server.ts +294 -294
  232. package/src/orchestration/detect.ts +313 -313
  233. package/src/orchestration/index.ts +7 -7
  234. package/src/orchestration/runner.ts +283 -283
  235. package/src/server.test.ts +618 -555
  236. package/src/server.ts +1314 -1308
  237. package/src/types.ts +415 -408
  238. package/src/utils/detect-ai.test.ts +44 -44
  239. package/src/utils/detect-ai.ts +84 -84
  240. package/src/utils/detect-editors.test.ts +48 -48
  241. package/src/utils/detect-editors.ts +57 -57
  242. package/src/utils/git.test.ts +74 -74
  243. package/src/utils/git.ts +117 -117
  244. package/src/utils/local-ai.test.ts +130 -130
  245. package/src/utils/local-ai.ts +116 -111
  246. package/src/utils/multi-git.ts +313 -313
  247. package/src/utils/prompts.ts +209 -209
  248. package/src/utils/session-finder.ts +483 -483
  249. package/src/utils/system-scanner.test.ts +89 -89
  250. package/src/utils/system-scanner.ts +96 -96
  251. package/src/utils/update-check.ts +286 -309
  252. package/src/utils/workflow-advisor.ts +118 -0
  253. package/src/utils/workflows.test.ts +114 -114
  254. package/src/utils/workflows.ts +178 -178
  255. package/tsconfig.json +19 -19
  256. package/vitest.config.ts +14 -14
  257. package/.github/workflows/release.yml +0 -112
  258. package/dist/commands/pack.d.ts +0 -7
  259. package/dist/commands/pack.d.ts.map +0 -1
  260. package/dist/commands/pack.js +0 -64
  261. package/dist/commands/pack.js.map +0 -1
  262. package/dist/core/packer.d.ts +0 -14
  263. package/dist/core/packer.d.ts.map +0 -1
  264. package/dist/core/packer.js +0 -87
  265. package/dist/core/packer.js.map +0 -1
  266. package/dist/core/packer.test.d.ts +0 -2
  267. package/dist/core/packer.test.d.ts.map +0 -1
  268. package/dist/core/packer.test.js +0 -82
  269. package/dist/core/packer.test.js.map +0 -1
  270. package/dist/gui/assets/index-Ct3qq-X4.js +0 -25
  271. package/dist/gui/assets/index-P_ZrgHXg.css +0 -1
  272. package/src/commands/pack.ts +0 -73
  273. package/src/core/packer.test.ts +0 -99
  274. package/src/core/packer.ts +0 -107
@@ -0,0 +1,65 @@
1
+ name: Release — npm
2
+
3
+ on:
4
+ workflow_run:
5
+ workflows: [CI]
6
+ branches: [main]
7
+ types: [completed]
8
+
9
+ permissions:
10
+ contents: write
11
+
12
+ jobs:
13
+ publish-npm:
14
+ if: github.event.workflow_run.conclusion == 'success'
15
+ runs-on: ubuntu-latest
16
+ steps:
17
+ - name: Checkout Repository
18
+ uses: actions/checkout@v4
19
+ with:
20
+ ref: ${{ github.event.workflow_run.head_sha }}
21
+
22
+ - name: Setup Node.js
23
+ uses: actions/setup-node@v4
24
+ with:
25
+ node-version: 22
26
+ registry-url: 'https://registry.npmjs.org/'
27
+
28
+ - name: Install Dependencies
29
+ run: npm ci
30
+
31
+ - name: Install GUI Dependencies
32
+ run: npm ci --prefix gui
33
+
34
+ - name: Build Project
35
+ run: npm run build
36
+
37
+ - name: Check version
38
+ id: check-version
39
+ run: |
40
+ VERSION=$(node -e "console.log(require('./package.json').version)")
41
+ echo "version=$VERSION" >> $GITHUB_OUTPUT
42
+ if npm info @mrpatronz/nexusflow@$VERSION --json >/dev/null 2>&1; then
43
+ echo "is_new=false" >> $GITHUB_OUTPUT
44
+ echo "Version $VERSION is already published on npm. Skipping."
45
+ else
46
+ echo "is_new=true" >> $GITHUB_OUTPUT
47
+ echo "Version $VERSION is new."
48
+ fi
49
+ env:
50
+ NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
51
+
52
+ - name: Publish to npm
53
+ if: steps.check-version.outputs.is_new == 'true'
54
+ run: npm publish --access public
55
+ env:
56
+ NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
57
+
58
+ - name: Create GitHub Release
59
+ if: steps.check-version.outputs.is_new == 'true'
60
+ uses: softprops/action-gh-release@v2
61
+ with:
62
+ tag_name: v${{ steps.check-version.outputs.version }}
63
+ name: Release v${{ steps.check-version.outputs.version }}
64
+ generate_release_notes: true
65
+ target_commitish: ${{ github.event.workflow_run.head_sha }}
@@ -0,0 +1,61 @@
1
+ name: Release — VS Code Extension
2
+
3
+ on:
4
+ workflow_run:
5
+ workflows: [CI]
6
+ branches: [main]
7
+ types: [completed]
8
+
9
+ permissions:
10
+ id-token: write # required for OIDC token request
11
+ contents: read
12
+
13
+ jobs:
14
+ publish-extension:
15
+ if: github.event.workflow_run.conclusion == 'success'
16
+ runs-on: ubuntu-latest
17
+ steps:
18
+ - name: Checkout Repository
19
+ uses: actions/checkout@v4
20
+ with:
21
+ ref: ${{ github.event.workflow_run.head_sha }}
22
+
23
+ - name: Setup Node.js
24
+ uses: actions/setup-node@v4
25
+ with:
26
+ node-version: 22
27
+
28
+ - name: Install Extension Dependencies
29
+ run: npm ci --prefix extension
30
+
31
+ - name: Azure Login (OIDC — no stored secrets)
32
+ uses: azure/login@v2
33
+ with:
34
+ client-id: ${{ secrets.AZURE_CLIENT_ID }}
35
+ tenant-id: ${{ secrets.AZURE_TENANT_ID }}
36
+ allow-no-subscriptions: true
37
+
38
+ - name: Check extension version
39
+ id: check-version
40
+ working-directory: extension
41
+ run: |
42
+ VERSION=$(node -e "console.log(require('./package.json').version)")
43
+ echo "version=$VERSION" >> $GITHUB_OUTPUT
44
+ PUBLISHED=$(npx vsce show nexusflow.nexusflow-vscode --json 2>/dev/null \
45
+ | node -e "
46
+ const d=require('fs').readFileSync(0,'utf8');
47
+ try { process.exit(JSON.parse(d).versions?.['$VERSION'] ? 0 : 1); }
48
+ catch { process.exit(1); }
49
+ " && echo "true" || echo "false")
50
+ if [ "$PUBLISHED" = "true" ]; then
51
+ echo "is_new=false" >> $GITHUB_OUTPUT
52
+ echo "Extension version $VERSION already published. Skipping."
53
+ else
54
+ echo "is_new=true" >> $GITHUB_OUTPUT
55
+ echo "Extension version $VERSION is new."
56
+ fi
57
+
58
+ - name: Publish to VS Code Marketplace
59
+ if: steps.check-version.outputs.is_new == 'true'
60
+ working-directory: extension
61
+ run: npx vsce publish --no-dependencies --azure-credential
@@ -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,114 +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. |
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. |
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. |