Skip to content

armgit / mimik

Public Imported from GitHub
0

🎬 A browser extension and desktop app that turns your clicks into step-by-step guides with annotated screenshots πŸ“–

docs: note discard, the new commands and electron fuses in the agent rules

Luis Ortiz50c31eba8bb9
diff --git a/AGENTS.md b/AGENTS.md
index 08b4d44..1cf7581 100644
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -30,7 +30,8 @@ pnpm build extension build
pnpm dev:desktop desktop app
pnpm pack:desktop unpacked desktop app in apps/desktop/dist
pnpm test vitest, all packages
-pnpm lint biome, then the one-export-per-file check
+pnpm lint biome, the repository checks, jscpd and knip
+pnpm size extension bundle sizes, after pnpm build
pnpm typecheck root and desktop
pnpm --filter @mimik/desktop check:pipeline also check:storage, check:overlay, check:capture
pnpm --filter @mimik/capture-native build
@@ -51,7 +52,7 @@ capture code in core, also run the desktop checks (under `xvfb-run` on Linux).
- **Same names for the same thing on both surfaces:**
- the capture states and events from core's machine;
- `isLive`;
- - message and IPC names (`captureStep`, `createGuide`, `deleteStep`, `getState`);
+ - message and IPC names (`captureStep`, `createGuide`, `deleteStep`, `discardRecording`, `getState`);
- the insert fields (`insertTargetGuideId`, `insertAtIndex`);
- the narration phases (`VoicePhase`).
Different code is fine where the platforms differ; different words for the same concept are not.
diff --git a/apps/desktop/AGENTS.md b/apps/desktop/AGENTS.md
index 5a8cf6e..b979e85 100644
--- a/apps/desktop/AGENTS.md
+++ b/apps/desktop/AGENTS.md
@@ -12,6 +12,8 @@ exactly as the extension does. The preload exposes `window.mimik` with context i
reason `area`.
- Main bundles `@mimik/core` (it is excluded from `externalizeDepsPlugin`), so value imports from
core work there. Every other dependency stays external.
+- A packed app has its Electron fuses flipped (`scripts/flip-fuses.cjs`): no run-as-node, no
+ `NODE_OPTIONS` and no `--inspect`. Pack with `MIMIK_INSPECTABLE=1` to keep the inspector.
- `out/main` stays flat (`chunkFileNames` is pinned), because main resolves `../renderer` and
`../preload` from `__dirname`.
- Every AI and provider request goes through main (`mimik:ai:fetch`). A renderer `fetch` to a