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
+55-52Lines changed: 55 additions & 52 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,93 +1,96 @@
1
1
# memory-sync
2
2
3
-
Rats 🐀 are like this: even our own brains, even our memories, are things we haul around while running through this fucked-up world!!!
3
+
A rat is like this. Even its own brain, even its memory, has to be carried around in this rotten world!!!
4
4
5
-
I am a rat. No resources will ever be proactively provided to me.
6
-
So as a rat, I eat whatever I can reach: maggots in the sewer, leftovers in the slop bucket, and in extreme cases even my own kind—this is the survival mode in a world where resource allocation is brutally unfair.
5
+
I am a rat. No resource is going to walk up and offer itself to me.
6
+
So as a rat, I eat whatever I can reach: maggots in the sewer, leftovers in a slop bucket, and in extreme cases even my own kind. That is what survival looks like in a world where resource distribution is brutally unequal.
7
7
8
8
`memory-sync` is the same kind of **tool-rat**:
9
9
10
-
-Does not expect any platform to grant an "official all-in-one solution"
11
-
-Does not rely on privileged interfaces of any single IDE / CLI
12
-
-Treats every readable config, prompt, and memory file as "edible matter" to be carried, dismantled, and recombined
13
-
In this ecosystem, giants monopolise the resources, and developers are thrown into the corner like rats.
14
-
`memory-sync` accepts this cruel reality, does not fantasise about fairness, and focuses on one thing only: **to chew up every fragment of resource you already have, and convert it into portable "memory" that can flow between any AI tool.**
10
+
-It does not wait for any platform to hand out an "official all-in-one solution"
11
+
-It does not rely on the privileged interface of any single IDE or CLI
12
+
-Any configuration, prompt, memory file, or generated artifact it can read becomes something edible: something to haul away, break apart, and recombine
13
+
In this ecosystem, the giants hoard the resources while developers get thrown into a corner like rats.
14
+
`memory-sync` accepts this cruel reality, does not fantasize about fairness, and focuses on one thing only: **to chew through every fragment of resource you already have and turn it into portable "memory" that can flow between AI tools.**
15
15
16
16

17
17
18
-
What can it help you do?
19
-
20
-
-**`.mdx` as the prompt source format**: write your prompts in MDX; `memory-sync` reads, transforms, and writes them into each tool's native config format—you maintain one source, it handles the rest.
21
-
- A **universal prompt spec**: write Global / Root / Child / Skill / Command / Agent prompts in a unified structure.
22
-
-**Auto-write tool config files**: AGENTS.md, .cursorrules, .kiro/, CLAUDE.md, etc.—if there is an entry point, it stuffs your memory in.
23
-
-**Generate copy-ready one-shot prompts**: package project context, tech stack, and current task into AI-friendly Markdown, paste into any chat box directly.
24
-
- Like a rat gnawing on cables, **gnaw structured memory out of existing directory structures and config files**, instead of asking you to rewrite everything from scratch.
25
-
-**Fine-grained control**: describe rules in YAML / JSON config files, choose what to sync by project, by Agent, by tool type—no "one-size-fits-all" overwrites.
26
-
-**Read-only source files**: never modifies your original repository directly, only reads and transforms, then materialises the result on the target tool side.
27
-
-**Full wipe**: on sync, erases all stale prompt traces in target tools—prompts are fully computable and auditable, leaving no residue for bad actors.
28
-
-**Prompts grow with you only**: memory follows you as a person, not the project. Someone else takes over the project—they cannot take your context. You move to a new project—your accumulated knowledge moves with you intact.
18
+
What can it do for you?
19
+
20
+
-**Use `.mdx` / `.src.mdx` as the source of truth**: you maintain one source, and `memory-sync` turns it into native tool configs plus managed generated artifacts.
21
+
-**Use one unified input-asset model**: Global / Workspace / Project Memory, Skills, Commands, Sub-agents, Rules, README-like outputs, and related assets all fit into one structure.
22
+
-**Auto-write native tool configs**: AGENTS.md, Claude Code CLI, Codex CLI, Cursor, Windsurf, Qoder, Trae, Warp, JetBrains AI Assistant Codex, and more. If a native entry point exists, it can write there.
23
+
-**Manage derived artifacts**: besides target-tool configs, it can maintain English prompt outputs, skill exports, README-like outputs, and other helper configs.
24
+
-**Provide multiple entry points**: the public entry is the `tnmsc` CLI; internally there is also a private SDK, an MCP stdio server, and a Tauri GUI, all working around the same source-of-truth model.
25
+
-**Control write scope precisely**: use `outputScopes`, `cleanupProtection`, and related settings to constrain writes and cleanup by project, topic, and tool.
26
+
-**Keep source and derived outputs auditable**: source files, generated artifacts, and target-tool configs stay clearly separated. No hidden source edits. No hidden residue.
27
+
-**Let memory grow with you**: memory follows you as a person instead of leaking with the project. If a project changes hands, they do not get your context. If you move to another project, your accumulated memory goes with you unchanged.
29
28
## Install
30
29
31
30
```sh
32
-
npm install -g @truenine/memory-sync
31
+
npm install -g @truenine/memory-sync-cli
33
32
```
34
33
35
-
## Docs
34
+
Optional MCP server:
36
35
37
-
`https://docs.truenine.org/tnmsc`
36
+
```sh
37
+
npm install -g @truenine/memory-sync-mcp
38
+
```
38
39
39
40
## Supported Tools
40
41
41
42
| Type | Tools |
42
43
| --- | --- |
43
-
| IDE | Cursor, Kiro, Windsurf, JetBrains AI |
44
-
| CLI | Claude CLI, Gemini CLI, Codex CLI, Warp |
44
+
| IDE / Editor | Cursor, Windsurf, Qoder, Trae, Trae CN, JetBrains AI Assistant Codex, Zed, VS Code |
-**GUI** (Tauri): the desktop workflow entry, consuming the `tnmsc` crate from `sdk`.
54
57
## FAQ
55
58
56
59
**When AI tools finally have a unified standard, what use will this project be?**
57
60
58
61
Then it will have completed its historical mission.
59
62
60
-
**There's already AGENTS.md, agentskills, and the MCP standard—why do I still need this junk?**
63
+
**There's already AGENTS.md, agentskills, and the MCP standard. Why do I still need this junk?**
61
64
62
-
Native-friendly, plus targeted conditional prompt authoring.
65
+
Because native targets still differ, and because conditional prompt authoring still has to land somewhere concrete.
63
66
64
-
`AGENTS.md` is the spec;`memory-sync` is the hauler—it writes the same memory into the native config formats of a dozen tools simultaneously, sparing you the manual copy-paste grind.
67
+
`AGENTS.md` is the format.`memory-sync` is the hauler plus assembler. It writes the same source of truth into multiple native configs and managed artifacts at once, so you do not have to do the copy-paste labor by hand. CLI, SDK, MCP, and GUI are just different entry points around that same model.
65
68
66
-
**Is there anything in your prompts you don't want to leave behind?**
69
+
**Is there anything in the prompt or generated output that I may not want to leave behind?**
67
70
68
-
Yes. That's why `memory-sync`provides a full-wipe mode: after sync, only the content you explicitly authorised remains in the target tools—everything else is erased. Prompts are fully computable, no hidden residue, no backdoor left for anyone else.
71
+
Yes. That is why `memory-sync`gives you cleanup and protection boundaries. After sync, only the managed outputs you explicitly allow should remain. Anything else should either be cleaned or protected on purpose. Prompts and derived artifacts should stay computable, auditable, and residue-free.
69
72
70
73
## Who is this for
71
74
72
75
To use `memory-sync` you need:
73
76
74
-
- Solid development experience, years of working with various dev tools
75
-
-Proficiency with version control (Git)
76
-
-Proficiency with the terminal
77
+
- Solid development experience and long-term exposure to dev tools
78
+
-Competence with version control (Git)
79
+
-Competence with the terminal
77
80
---
78
81
79
82
- You are writing code in a forgotten sewer.
80
-
No one will proactively feed you, not even a tiny free quota, not even a half-decent document.
81
-
- As a rat, you can barely get your hands on anything good:
82
-
scurrying between free tiers, trial credits, education discounts, and random third-party scripts.
83
+
No one is going to proactively feed you, not even a tiny free quota, not even a decent document.
84
+
- As a rat, you were never going to get good food anyway:
85
+
you keep scurrying between free tiers, trial credits, education discounts, and random third-party scripts.
83
86
- What can you do?
84
-
Keep darting between IDEs, CLIs, browser extensions, and cloud Agents, copying and pasting the same memory a hundred times.
85
-
- You leech API offers from vendors day after day:
86
-
today one platform runs a discount so you top up a little; tomorrow another launches a promo so you rush to scrape it.
87
-
- Once they have harvested the telemetry, user profiles, and usage patterns they want,
88
-
they can kick you—this stinking rat—away at any moment: price hikes, rate limits, account bans, and you have no channel to complain.
87
+
Keep darting between IDEs, CLIs, browser extensions, and cloud agents, copying and pasting the same memory a hundred times.
88
+
- You keep scraping vendor API deals day after day:
89
+
today one platform discounts something, so you top up a little; tomorrow another launches a promotion, so you rush over there too.
90
+
- Once they have harvested the telemetry, user profile, and usage pattern they wanted,
91
+
they can kick youaway at any moment: price hikes, quotas, bans, and no real channel for complaint.
89
92
If you are barely surviving in this environment, `memory-sync` is built for you:
90
-
carry fewer bricks, copy prompts fewer times—at least on the "memory" front, you are no longer completely on the passive receiving end.
93
+
to help you carry a little less brick, paste the same prompt a few fewer times, and at least stop being completely passive around "memory".
91
94
92
95
## Who is NOT welcome
93
96
@@ -96,17 +99,17 @@ Stable salary, project revenue share, budget to sign official APIs yearly.
96
99
- And yet you still come down here,
97
100
competing with us filthy sewer rats for the scraps in the slop bucket.
98
101
- If you can afford APIs and enterprise plans, go pay for them.
99
-
Do things that actually create value—pay properly, give proper feedback, nudge the ecosystem slightly in the right direction.
102
+
Do things that actually create value: pay properly, give proper feedback, and nudge the ecosystem slightly in the right direction.
100
103
- Instead of coming back down
101
-
to strip away the tiny gap left for marginalised developers, squeezing out the last crumbs with us rats.
104
+
to strip away the tiny gap left for marginalized developers, squeezing out the last crumbs with us rats.
102
105
- You are a freeloader.
103
-
Everything must be pre-chewed and spoon-fed; you won't even touch a terminal.
104
-
- You love the grind culture.
106
+
Everything must be pre-chewed and spoon-fed; you will not even touch a terminal.
107
+
- You love grind culture.
105
108
Treating "hustle" as virtue, "996" as glory, stepping on peers as a promotion strategy.
106
109
- You leave no room for others.
107
-
Not about whether you share—it's about actively stomping on people, competing maliciously, sustaining your position by suppressing peers, using others' survival space as your stepping stone.
110
+
This is not about whether you share everything. It is about actively stomping on people, competing maliciously, and treating other people's survival space as your stepping stone.
108
111
In other words:
109
-
**this is not a tool for optimising capital costs, but a small counterattack prepared for the "rats with no choice" in a world of extreme resource inequality.**
112
+
**this is not a tool for optimizing capital cost. It is a small counterattack for the "rats with no choice" in a world of extreme resource inequality.**
0 commit comments