Skip to content

Commit dcc44c8

Browse files
authored
Merge pull request #36 from TrueNine/dev
docs: restructure README with improved installation and architecture …
2 parents 3bda42b + dc39da4 commit dcc44c8

1 file changed

Lines changed: 69 additions & 64 deletions

File tree

README.md

Lines changed: 69 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -18,92 +18,97 @@ In this ecosystem, giants monopolise the resources, and developers are thrown in
1818

1919
What can it help you do?
2020

21-
- A **universal prompt specification**: teaches you how to write Global / Root / Child / Skill / Command / Agent prompts in a unified structure.
22-
- **Sync these prompts into as many AI coding tools as possible**: Cursor, Kiro, Warp, Claude CLI, Gemini CLI, Codex CLI, and more—if there is an entry point, it will stuff your memory into it.
23-
- Like a rat gnawing on cables, it **gnaws structured memory out of existing directory structures and config files**, instead of asking you to rewrite everything from scratch.
24-
- Provides **fine-grained control**: you can choose what to sync by project, by Agent, by tool type, avoiding "one-size-fits-all" overwrites.
25-
- Guarantees **read-only source files**: it never modifies your original repository directly, only reads and transforms, then materialises the result on the target tool side.
26-
27-
## Who is this for
28-
29-
- You are writing code in a forgotten sewer.\
30-
No one will proactively feed you, not even with a tiny free quota, not even with a half-decent document.
31-
- As a rat, you can barely get your hands on anything good:\
32-
you can only scurry between free tiers, trial credits, education discounts, and random third-party scripts.
33-
- What can you do?\
34-
You keep darting between IDEs, CLIs, browser extensions, and cloud Agents, copying and pasting the same memory a hundred times.
35-
- You leech API offers from vendors day after day:\
36-
today one platform runs a discount so you top up a little; tomorrow another launches a promo so you rush to scrape it.
37-
- Once they have harvested the telemetry, user profiles, and usage patterns they want,\
38-
they can kick you—this stinking rat—away at any moment: price hikes, rate limits, account bans, leaving you with no channel to complain.
21+
- **`.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.
22+
- A **universal prompt spec**: write Global / Root / Child / Skill / Command / Agent prompts in a unified structure.
23+
- **Auto-write tool config files**: AGENTS.md, .cursorrules, .kiro/, CLAUDE.md, etc.—if there is an entry point, it stuffs your memory in.
24+
- **Generate copy-ready one-shot prompts**: package project context, tech stack, and current task into AI-friendly Markdown, paste into any chat box directly.
25+
- 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.
26+
- **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.
27+
- **Read-only source files**: never modifies your original repository directly, only reads and transforms, then materialises the result on the target tool side.
28+
- **Full wipe**: on sync, erases all stale prompt traces in target tools—prompts are fully computable and auditable, leaving no residue for bad actors.
29+
- **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.
30+
31+
## Install
32+
33+
```sh
34+
npm install -g @truenine/memory-sync
35+
```
3936

40-
If you are barely surviving in this environment, `memory-sync` is built for you:\
41-
it helps you carry fewer bricks, copy prompts fewer times, and at least on the "memory" front, you are no longer completely on the passive receiving end.
37+
## Supported Tools
4238

43-
## Who is NOT welcome
39+
| Type | Tools |
40+
| ---- | --------------------------------------- |
41+
| IDE | Cursor, Kiro, Windsurf, JetBrains AI |
42+
| CLI | Claude CLI, Gemini CLI, Codex CLI, Warp |
4443

45-
- Your income is already fucking high.\
46-
You have a stable salary, project revenue share, and a budget to sign official APIs yearly.
47-
- And yet you still come down here,\
48-
competing with us filthy sewer rats for the scraps in the slop bucket.
49-
- If you can afford APIs and enterprise plans, then pay for them.\
50-
Go and do things that actually create more value—like paying properly and giving proper feedback, nudging the ecosystem slightly in the right direction.
51-
- Instead of turning back,\
52-
stripping away the tiny gap that was originally left for marginalised developers, and squeezing out the last crumbs with us.
44+
More platforms being added continuously.
5345

54-
In other words:\
55-
**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.**
46+
## Architecture
5647

57-
## Created by
48+
- **CLI** (`@truenine/memory-sync`): core sync engine—reads config, writes target tool files, generates copy-ready prompts.
49+
- **Core** (Rust): file I/O, directory traversal, format conversion.
50+
- **Config DSL** (YAML / JSON): place a config file at the project root to describe sync rules and target tools.
51+
- **GUI** (Tauri): desktop app that calls the CLI as its backend, providing a visual interface.
5852

59-
- [TrueNine](https://github.com/TrueNine)
60-
- [zjarlin](https://github.com/zjarlin)
53+
## FAQ
6154

62-
## License
55+
**When AI tools finally have a unified standard, what use will this project be?**
6356

64-
[AGPL-3.0](LICENSE)
57+
Then it will have completed its historical mission.
6558

66-
# memory-sync
59+
**There's already AGENTS.md, agentskills, and the MCP standard—why do I still need this junk?**
6760

68-
Cross-AI programming tool prompt synchronization tool. One rule set, multi-platform adaptation.
61+
Native-friendly, plus targeted conditional prompt authoring.
6962

70-
## Quick Start
63+
`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.
7164

72-
### Prerequisites
65+
**Is there anything in your prompts you don't want to leave behind?**
7366

74-
Node.js >= 25.2.1, pnpm >= 10
67+
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.
7568

76-
### Installation
77-
78-
```bash
79-
pnpm add -g @truenine/memory-sync
80-
```
81-
82-
Or use directly:
69+
## Who is this for
8370

84-
```bash
85-
npx @truenine/memory-sync
86-
```
71+
To use `memory-sync` you need:
8772

88-
### Run
73+
- Solid development experience, years of working with various dev tools
74+
- Proficiency with version control (Git)
75+
- Proficiency with the terminal
8976

90-
```bash
91-
tnmsc
92-
```
77+
---
9378

94-
### Update
79+
- 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+
- 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.
9589

96-
```bash
97-
pnpm update -g @truenine/memory-sync --latest
98-
```
90+
If you are barely surviving in this environment, `memory-sync` is built for you:\
91+
carry fewer bricks, copy prompts fewer times—at least on the "memory" front, you are no longer completely on the passive receiving end.
9992

100-
## GUI Desktop App
93+
## Who is NOT welcome
10194

102-
GUI package provides Tauri desktop application, build in `gui/` directory:
95+
- Your income is already fucking high.\
96+
Stable salary, project revenue share, budget to sign official APIs yearly.
97+
- And yet you still come down here,\
98+
competing with us filthy sewer rats for the scraps in the slop bucket.
99+
- If you can afford APIs and enterprise plans, go pay for them.\
100+
Do things that actually create value—pay properly, give proper feedback, nudge the ecosystem slightly in the right direction.
101+
- Instead of coming back down\
102+
to strip away the tiny gap left for marginalised developers, squeezing out the last crumbs with us rats.
103+
- You are a freeloader.\
104+
Everything must be pre-chewed and spoon-fed; you won't even touch a terminal.
105+
- You love the grind culture.\
106+
Treating "hustle" as virtue, "996" as glory, stepping on peers as a promotion strategy.
107+
- You leave no room for others.\
108+
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.
103109

104-
```bash
105-
pnpm tauri:build
106-
```
110+
In other words:\
111+
**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.**
107112

108113
## Created by
109114

0 commit comments

Comments
 (0)