Skip to content

docs: restructure README with improved installation and architecture … #36

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
TrueNine merged 1 commit into from
Feb 22, 2026
Merged

docs: restructure README with improved installation and architecture … #36

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
133 changes: 69 additions & 64 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,92 +18,97 @@ In this ecosystem, giants monopolise the resources, and developers are thrown in

What can it help you do?

- A **universal prompt specification**: teaches you how to write Global / Root / Child / Skill / Command / Agent prompts in a unified structure.
- **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.
- 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.
- Provides **fine-grained control**: you can choose what to sync by project, by Agent, by tool type, avoiding "one-size-fits-all" overwrites.
- 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.

## Who is this for

- You are writing code in a forgotten sewer.\
No one will proactively feed you, not even with a tiny free quota, not even with a half-decent document.
- As a rat, you can barely get your hands on anything good:\
you can only scurry between free tiers, trial credits, education discounts, and random third-party scripts.
- What can you do?\
You keep darting between IDEs, CLIs, browser extensions, and cloud Agents, copying and pasting the same memory a hundred times.
- You leech API offers from vendors day after day:\
today one platform runs a discount so you top up a little; tomorrow another launches a promo so you rush to scrape it.
- Once they have harvested the telemetry, user profiles, and usage patterns they want,\
they can kick you—this stinking rat—away at any moment: price hikes, rate limits, account bans, leaving you with no channel to complain.
- **`.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.
- A **universal prompt spec**: write Global / Root / Child / Skill / Command / Agent prompts in a unified structure.
- **Auto-write tool config files**: AGENTS.md, .cursorrules, .kiro/, CLAUDE.md, etc.—if there is an entry point, it stuffs your memory in.
- **Generate copy-ready one-shot prompts**: package project context, tech stack, and current task into AI-friendly Markdown, paste into any chat box directly.
- 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.
- **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.
- **Read-only source files**: never modifies your original repository directly, only reads and transforms, then materialises the result on the target tool side.
- **Full wipe**: on sync, erases all stale prompt traces in target tools—prompts are fully computable and auditable, leaving no residue for bad actors.
- **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.

## Install

```sh
npm install -g @truenine/memory-sync
```

If you are barely surviving in this environment, `memory-sync` is built for you:\
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.
## Supported Tools

## Who is NOT welcome
| Type | Tools |
| ---- | --------------------------------------- |
| IDE | Cursor, Kiro, Windsurf, JetBrains AI |
| CLI | Claude CLI, Gemini CLI, Codex CLI, Warp |

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

In other words:\
**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.**
## Architecture

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

- [TrueNine](https://github.com/TrueNine)
- [zjarlin](https://github.com/zjarlin)
## FAQ

## License
**When AI tools finally have a unified standard, what use will this project be?**

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

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

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

## Quick Start
`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.

### Prerequisites
**Is there anything in your prompts you don't want to leave behind?**

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

### Installation

```bash
pnpm add -g @truenine/memory-sync
```

Or use directly:
## Who is this for

```bash
npx @truenine/memory-sync
```
To use `memory-sync` you need:

### Run
- Solid development experience, years of working with various dev tools
- Proficiency with version control (Git)
- Proficiency with the terminal

```bash
tnmsc
```
---

### Update
- You are writing code in a forgotten sewer.\
No one will proactively feed you, not even a tiny free quota, not even a half-decent document.
- As a rat, you can barely get your hands on anything good:\
scurrying between free tiers, trial credits, education discounts, and random third-party scripts.
- What can you do?\
Keep darting between IDEs, CLIs, browser extensions, and cloud Agents, copying and pasting the same memory a hundred times.
- You leech API offers from vendors day after day:\
today one platform runs a discount so you top up a little; tomorrow another launches a promo so you rush to scrape it.
- Once they have harvested the telemetry, user profiles, and usage patterns they want,\
they can kick you—this stinking rat—away at any moment: price hikes, rate limits, account bans, and you have no channel to complain.

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

## GUI Desktop App
## Who is NOT welcome

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

```bash
pnpm tauri:build
```
In other words:\
**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.**

## Created by

Expand Down
Loading