qwen-code/docs/users/features/memory.md
顾盼 24ebfbc13e
feat(memory): load .qwen/QWEN.local.md as project-local context (#4091) (#4394)
* feat(memory): load .qwen/QWEN.local.md as project-local context (#4091)

Adds a per-developer, project-scoped context file slot at
`<projectRoot>/.qwen/QWEN.local.md`. Loaded after all hierarchical
QWEN.md / AGENTS.md files so local instructions can supplement or
override shared ones.

Use case: project-specific but personal instructions (local cluster IDs,
container registry namespaces, accounts) that shouldn't live in the
shared root `QWEN.md` (exposes them to the team) or in the global
`~/.qwen/QWEN.md` (applies to every project). Mirrors Claude Code's
`.claude/CLAUDE.local.md` convention.

The slot is single and fixed (project root only — not searched in CWD
subdirectories or via upward traversal), gated by the same trust and
explicit-only checks as the rest of project-level discovery, and counted
in `fileCount` so the `/memory` panel surfaces it. Users must gitignore
the file themselves; `.qwen/` is not auto-ignored and `.qwen/settings.json`
is commonly committed.

* fix(memory): support .git-file repos when locating QWEN.local.md slot

`findProjectRoot()` only accepted `.git` as a directory, so in git
worktrees and submodules (where `.git` is a file containing a `gitdir:`
pointer) it returned `null`. The new `.qwen/QWEN.local.md` slot then
fell back to `<cwd>/.qwen/QWEN.local.md`, silently breaking the
documented "single fixed slot at project root" behavior for users
inside worktrees — including the developer of this feature.

Two changes:

1. `findProjectRoot()` now accepts `.git` as either a directory or a
   regular file. This also incidentally repairs pre-existing breakage
   in `rulesDiscovery` / hierarchical-search stop boundary, both of
   which consume the same helper.

2. The local-context-file slot now requires a real `foundRoot` (the
   `null` case is no longer covered by the `effectiveRoot` fallback).
   Without this guard:
     - a deep cwd in a non-git workspace turned the slot into a
       per-cwd file, opposite the design;
     - `cwd === homedir` resolved the slot to `~/.qwen/QWEN.local.md`,
       colliding with the global Qwen directory.

Three regression tests pin the new behavior: `.git`-as-file is
recognized, no-`.git`-ancestor skips the slot, `cwd === homedir`
without `.git` does not promote a global file to project-local.

* refactor(memory): extract findProjectRoot to shared utility (#4091)

Two duplicate `findProjectRoot` helpers existed in
`packages/core/src/utils/`: one in `memoryDiscovery.ts` (returns
`Promise<string | null>`) and one in `memoryImportProcessor.ts`
(returns `Promise<string>`, falls back to startDir). The previous fix
in 97c6fb41f only updated the first copy for `.git`-file support, so
`@import` resolution under git worktrees and submodules was still
silently broken — the QWEN.local.md file would load, but its imports
would resolve against the wrong root.

Extract the helper into `utils/projectRoot.ts`, with the unified
nullable return type. Rewire both call sites; `memoryImportProcessor`
preserves its previous fallback semantics at the call site
(`?? path.resolve(basePath)`). Adds 5 unit tests for the utility
(directory / file / null / deep / symlink) and 1 test for the
previously-unverified dedup guard in `memoryDiscovery.ts` (exercised
via `extensionContextFilePaths`).

Addresses inline + cross-file findings from wenshao on PR #4394.
2026-05-25 11:22:55 +08:00

185 lines
7.1 KiB
Markdown

# Memory
Every Qwen Code session starts with a fresh context window. Two mechanisms carry knowledge across sessions so you don't have to re-explain yourself every time:
- **QWEN.md** — instructions _you_ write once and Qwen reads every session
- **Auto-memory** — notes Qwen writes itself based on what it learns from you
---
## QWEN.md: your instructions to Qwen
QWEN.md is a plain text file where you write things Qwen should always know about your project or your preferences. Think of it as a permanent briefing that loads at the start of every conversation.
### What to put in QWEN.md
Add things you'd otherwise have to repeat every session:
- Build and test commands (`npm run test`, `make build`)
- Coding conventions your team follows ("all new files must have JSDoc comments")
- Architectural decisions ("we use the repository pattern, never call the database directly from controllers")
- Personal preferences ("always use pnpm, not npm")
Don't include things Qwen can figure out by reading your code. QWEN.md works best when it's short and specific — the longer it gets, the less reliably Qwen follows it.
### Where to create QWEN.md
| File | Who it applies to |
| ----------------------------- | ------------------------------------------------ |
| `~/.qwen/QWEN.md` | You, across all your projects |
| `QWEN.md` in the project root | Your whole team (commit it to source control) |
| `.qwen/QWEN.local.md` | Only you, only in this project (keep out of git) |
You can have any combination of these. Qwen loads all of them when you start a session.
If your repository already has an `AGENTS.md` file for other AI tools, Qwen reads that too. No need to duplicate instructions.
#### When to use `.qwen/QWEN.local.md`
Use it for **project-specific but personal** instructions — things that belong to this project but shouldn't be shared with the team:
- Your own cluster ID, container registry namespace, or cloud account
- A personal debug command that hardcodes your local environment
- Notes you want Qwen to know about your work-in-progress, but not commit
It loads **after** the shared project `QWEN.md`, so your local instructions can supplement or override the team's.
**You must gitignore it yourself.** Although `.qwen/` is often treated as a local directory, qwen-code does not generate a `.gitignore` for you, and some projects commit `.qwen/settings.json`. Add this line to your `.gitignore` (or to your global git ignore):
```
.qwen/QWEN.local.md
```
### Generate one automatically with `/init`
Run `/init` and Qwen will analyze your codebase to create a starter QWEN.md with build commands, test instructions, and conventions it finds. If one already exists, it suggests additions instead of overwriting.
### Reference other files
You can point QWEN.md at other files so Qwen reads them too:
```markdown
See @README.md for project overview.
# Conventions
- Git workflow: @docs/git-workflow.md
```
Use `@path/to/file` anywhere in QWEN.md. Relative paths resolve from the QWEN.md file itself.
---
## Auto-memory: what Qwen learns about you
Auto-memory runs in the background. After each of your conversations, Qwen quietly saves useful things it learned — your preferences, feedback you gave, project context — so it can use them in future sessions without you repeating yourself.
This is different from QWEN.md: you don't write it, Qwen does.
### What Qwen saves
Qwen looks for four kinds of things worth remembering:
| What | Examples |
| ----------------------- | -------------------------------------------------------- |
| **About you** | Your role, background, how you like to work |
| **Your feedback** | Corrections you made, approaches you confirmed |
| **Project context** | Ongoing work, decisions, goals not obvious from the code |
| **External references** | Dashboards, ticket trackers, docs links you mentioned |
Qwen doesn't save everything — only things that would actually be useful next time.
### Where it's stored
Auto-memory files live at `~/.qwen/projects/<project>/memory/`. All branches and worktrees of the same repository share the same memory folder, so what Qwen learns in one branch is available in others.
Everything saved is plain markdown — you can open, edit, or delete any file at any time.
### Periodic cleanup
Qwen periodically goes through its saved memories to remove duplicates and clean up outdated entries. This runs automatically in the background once a day after enough sessions have accumulated. You can trigger it manually with `/dream` if you want it to run now.
While cleanup is running, **✦ dreaming** appears in the corner of the screen. Your session continues normally.
### Turning it on or off
Auto-memory is on by default. To toggle it, open `/memory` and use the switches at the top. You can turn off just the automatic saving, just the periodic cleanup, or both.
You can also set them in `~/.qwen/settings.json` (applies to all projects) or `.qwen/settings.json` (this project only):
```json
{
"memory": {
"enableManagedAutoMemory": true,
"enableManagedAutoDream": true
}
}
```
---
## Commands
### `/memory`
Opens the Memory panel. From here you can:
- Turn auto-memory saving on or off
- Turn periodic cleanup (dream) on or off
- Open your personal QWEN.md (`~/.qwen/QWEN.md`)
- Open the project QWEN.md
- Browse the auto-memory folder
### `/init`
Generates a starter QWEN.md for your project. Qwen reads your codebase and fills in build commands, test instructions, and conventions it discovers.
### `/remember <text>`
Immediately saves something to auto-memory without waiting for Qwen to pick it up automatically:
```
/remember always use snake_case for Python variable names
/remember the staging environment is at staging.example.com
```
### `/forget <text>`
Removes auto-memory entries that match your description:
```
/forget old workaround for the login bug
```
### `/dream`
Runs the memory cleanup now instead of waiting for the automatic schedule:
```
/dream
```
---
## Troubleshooting
### Qwen isn't following my QWEN.md
Open `/memory` to see which files are loaded. If your file isn't listed, Qwen can't see it — make sure it's in the project root or `~/.qwen/`.
Instructions work better when they're specific:
-`Use 2-space indentation for TypeScript files`
-`Format code nicely`
If you have multiple QWEN.md files with conflicting instructions, Qwen may behave inconsistently. Review them and remove any contradictions.
### I want to see what Qwen has saved
Run `/memory` and select **Open auto-memory folder**. All saved memories are readable markdown files you can browse, edit, or delete.
### Qwen keeps forgetting things
If auto-memory is on but Qwen doesn't seem to remember things across sessions, try running `/dream` to force a cleanup pass. Also check `/memory` to confirm both toggles are enabled.
For things you always want Qwen to remember, add them to QWEN.md instead — auto-memory is best-effort, QWEN.md is guaranteed.