Skip to content

Commit f9f0b19

Browse files
committed
chore(extension): add marketplace icon and README
1 parent 37b5b64 commit f9f0b19

3 files changed

Lines changed: 89 additions & 0 deletions

File tree

extension/README.md

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
# HackLM Memory
2+
3+
<p align="center">
4+
<img src="icon.png" alt="HackLM Memory" width="128" />
5+
</p>
6+
7+
<p align="center">
8+
A long-term memory layer for VS Code Copilot.<br/>
9+
Learns from your conversations. Stays local. Gets smarter over time.
10+
</p>
11+
12+
---
13+
14+
## What It Does
15+
16+
HackLM Memory gives Copilot a persistent memory across sessions. It stores decisions, preferences, quirks, and security rules in plain Markdown files inside your project.
17+
18+
- **Learns passively** — picks up preferences and rules from natural conversation
19+
- **Never stores duplicates** — deduplication runs on every write
20+
- **Self-cleaning** — periodic cleanup merges similar entries and prunes stale ones
21+
- **Workspace-scoped** — each project has its own `.memory/` folder
22+
- **Fully local** — no cloud sync, no telemetry
23+
24+
---
25+
26+
## Getting Started
27+
28+
1. Install the extension
29+
2. Open a workspace — memory files are created automatically in `.memory/`
30+
3. Start chatting with Copilot — it will read and write memories automatically
31+
4. Click **Memory** in the status bar to open the control panel
32+
33+
---
34+
35+
## Memory Categories
36+
37+
| Category | What It Stores |
38+
|----------|----------------|
39+
| **Instruction** | How Copilot should behave in this project |
40+
| **Quirk** | Non-obvious project-specific knowledge |
41+
| **Preference** | Style, tone, and design choices |
42+
| **Decision** | Architectural commitments |
43+
| **Security** | Rules that must never be broken |
44+
45+
---
46+
47+
## Commands
48+
49+
| Command | Description |
50+
|---------|-------------|
51+
| `HackLM Memory: Open Control Panel` | Browse all actions in one place |
52+
| `HackLM Memory: List Memories` | View all stored entries |
53+
| `HackLM Memory: Delete Memory` | Remove a specific entry |
54+
| `HackLM Memory: Run Cleanup` | Merge duplicates and prune stale entries |
55+
| `HackLM Memory: Review Session` | Find decisions not yet captured |
56+
| `HackLM Memory: Open Memory Folder` | Browse `.memory/` files directly |
57+
58+
---
59+
60+
## Settings
61+
62+
| Setting | Default | Description |
63+
|---------|---------|-------------|
64+
| `hacklm-memory.lmFamily` | `gpt-5-mini` | Model family for LM operations |
65+
| `hacklm-memory.autoApproveStore` | `false` | Skip confirmation when saving memories |
66+
| `hacklm-memory.manageInstructionFile` | `true` | Manage `.github/copilot-instructions.md` automatically |
67+
| `hacklm-memory.autoCleanupFrequency` | `10` | Run cleanup automatically every N store operations |
68+
| `hacklm-memory.categoryLimit.*` | `20` | Max entries per category |
69+
70+
---
71+
72+
## Privacy
73+
74+
All memory is stored locally in your workspace `.memory/` folder. Nothing leaves your machine.
75+
Add `.memory/` to `.gitignore` if any contents are sensitive.
76+
77+
---
78+
79+
## Requirements
80+
81+
- VS Code 1.99 or later
82+
- GitHub Copilot (for LM tool integration)
83+
84+
---
85+
86+
## License
87+
88+
[GPL-3.0](https://github.com/vchan-in/memory/blob/main/LICENSE)

extension/icon.png

8.79 KB
Loading

extension/package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
"description": "Persistent memory layer for VS Code Copilot — learn from interactions, retain insights, improve over time",
55
"version": "1.0.0",
66
"publisher": "hacklm",
7+
"icon": "icon.png",
78
"license": "GPL-3.0-only",
89
"repository": {
910
"type": "git",

0 commit comments

Comments
 (0)