You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+52-22Lines changed: 52 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
Zharwing Memory is a local-first project context manager for AI-assisted coding workflows. It is not the coding agent. External agents such as Codex, Claude Code, Gemini CLI, Ollama-based tools, LM Studio workflows, and future MCP-capable clients do the engineering work. Zharwing Memory provides their durable, project-scoped memory layer.
4
4
5
-
The product keeps project knowledge, AI session history, context bundles, diagrams, decisions, commands, gotchas, and optional review proposals organized per project. A human can open the desktop app to understand current work, inspect AI context, inspect the graph, search previous work, and enable review workflows only when wanted.
5
+
The product keeps project knowledge, AI session history, context bundles, diagrams, decisions, commands, gotchas, and optional review proposals organized per project. A human can open the local browser UI or native desktop app to understand current work, inspect AI context, inspect the graph, search previous work, and enable review workflows only when wanted.
6
6
7
7
> **Status: standalone personal developer preview.** The current product is
8
8
> intended for a trusted developer using a local, single-user environment. It
@@ -130,7 +130,7 @@ check.
130
130
131
131
```text
132
132
apps/
133
-
desktop/ Tauri + React human control plane
133
+
desktop/ Shared React browser UI and Tauri human control plane
134
134
daemon/ Localhost JSON-RPC daemon
135
135
cli/ zharwing-memory command-line helper
136
136
mcp-server/ MCP-style stdio adapter
@@ -150,6 +150,7 @@ packages/
150
150
151
151
docs/
152
152
README.md Documentation index
153
+
WEB_UI.md Local browser startup, auth, usage, and troubleshooting
Browser and Tauri runtime modes, lightweight sidebar model, first-run setup,
37
-
import workflow, opt-in session graph visibility, and Trash behavior.
35
+
-[Browser UI](WEB_UI.md)
36
+
Complete local browser startup, daemon and token configuration, daily use,
37
+
browser-versus-desktop differences, and troubleshooting.
38
+
39
+
-[Browser And Desktop UI](DESKTOP_UI.md)
40
+
Shared navigation, browser and Tauri runtime modes, first-run setup, import
41
+
workflow, opt-in session graph visibility, and Trash behavior.
38
42
39
43
-[Diagrams](DIAGRAMS.md)
40
44
Mermaid diagrams: architecture, UML class diagram, ERD, sequence diagrams, state machines, user flow, context pipeline, storage layout, and backup flow.
@@ -68,18 +72,19 @@ This folder contains product and engineering documentation for the Zharwing Memo
68
72
2. Read [Architecture](ARCHITECTURE.md).
69
73
3. Review [Diagrams](DIAGRAMS.md) for system shape.
70
74
4. Use [User Flows](USER_FLOWS.md) to understand behavior.
71
-
5. Use [Desktop UI](DESKTOP_UI.md) when operating the browser or Tauri app.
72
-
6. Use [API Reference](API_REFERENCE.md) when wiring clients.
73
-
7. Use [Agent Protocol](AGENT_PROTOCOL.md) when wiring agents or generating agent-specific instructions.
74
-
8. Use [MCP Setup](MCP_SETUP.md) when connecting Codex, Claude, or another MCP client.
75
-
9. Use [Agent Automation](AGENT_AUTOMATION.md) when configuring bootstrap files or the generic skill.
76
-
10. Use [Repositories](REPOSITORIES.md) when linking multiple repos to one memory project.
77
-
11. Use [Workstreams](WORKSTREAMS.md) when grouping multi-day topics.
78
-
12. Use [Importing](IMPORTING.md) when bringing in existing Markdown memory or session folders.
79
-
13. Use [Graph Rules](GRAPH_RULES.md) when imported memory needs better graph hubs.
80
-
14. Use [Semantic Graph Analysis](SEMANTIC_GRAPH.md) when enabling AI-reviewed relationships.
81
-
15. Use [Testing With AI Providers](AI_TESTING.md) when checking LM Studio, session TLDR generation, or another model-backed provider.
82
-
16. Use [Operations](OPERATIONS.md) when running or packaging the app.
75
+
5. Use [Browser UI](WEB_UI.md) to run Memory in a browser.
76
+
6. Use [Browser And Desktop UI](DESKTOP_UI.md) for the shared navigation and workflows.
77
+
7. Use [API Reference](API_REFERENCE.md) when wiring clients.
78
+
8. Use [Agent Protocol](AGENT_PROTOCOL.md) when wiring agents or generating agent-specific instructions.
79
+
9. Use [MCP Setup](MCP_SETUP.md) when connecting Codex, Claude, or another MCP client.
80
+
10. Use [Agent Automation](AGENT_AUTOMATION.md) when configuring bootstrap files or the generic skill.
81
+
11. Use [Repositories](REPOSITORIES.md) when linking multiple repos to one memory project.
82
+
12. Use [Workstreams](WORKSTREAMS.md) when grouping multi-day topics.
83
+
13. Use [Importing](IMPORTING.md) when bringing in existing Markdown memory or session folders.
84
+
14. Use [Graph Rules](GRAPH_RULES.md) when imported memory needs better graph hubs.
85
+
15. Use [Semantic Graph Analysis](SEMANTIC_GRAPH.md) when enabling AI-reviewed relationships.
86
+
16. Use [Testing With AI Providers](AI_TESTING.md) when checking LM Studio, session TLDR generation, or another model-backed provider.
87
+
17. Use [Operations](OPERATIONS.md) when running or packaging the app.
0 commit comments