From 8250c139d4a9ff10547a26dcfe2ef0589aa153a2 Mon Sep 17 00:00:00 2001
From: Amolith <amolith@secluded.site>
Date: Mon, 15 Sep 2025 18:00:18 -0600
Subject: [PATCH] feat: load user CRUSH.md and AGENTS.md from config

Issue: charmbracelet/crush#1050
---
 README.md                 | 25 +++++++++++++++++++++++++
 internal/config/config.go |  1 +
 internal/config/load.go   | 12 ++++++++++++
 schema.json               | 11 +++++++++++
 4 files changed, 49 insertions(+)

diff --git a/README.md b/README.md
index 85f7376d7a9d30ecb55f26ce159ada1120ae64fa..db84c3409c84485ad77563486de481c570771b2f 100644
--- a/README.md
+++ b/README.md
@@ -301,6 +301,31 @@ using `$(echo $VAR)` syntax.
 }
 ```
 
+### Memory
+
+Crush automatically includes two memory files for cross-project instructions.
+
+- `~/.config/crush/CRUSH.md`: Crush-specific rules that would confuse other
+  agentic coding tools. If you only use Crush, this is the only one you need to
+  edit.
+- `~/.config/AGENTS.md`: generic instructions that other coding tools might
+  read. Avoid referring to Crush-specific tools or workflows here.
+
+You can customize these paths using the `memory_paths` option in your
+configuration:
+
+```json
+{
+  "$schema": "https://charm.land/crush.json",
+  "options": {
+    "memory_paths": [
+      "/path/to/custom/memory/file.md",
+      "/path/to/folder/of/files/" // recursively load all .md files in folder
+    ]
+  }
+}
+```
+
 ### Ignoring Files
 
 Crush respects `.gitignore` files by default, but you can also create a
diff --git a/internal/config/config.go b/internal/config/config.go
index 5cc519c110476683928b8e329a0e4bf1e18c4074..118a95308a6df544f5b421ddb15dd082cdc251a3 100644
--- a/internal/config/config.go
+++ b/internal/config/config.go
@@ -193,6 +193,7 @@ func (Attribution) JSONSchemaExtend(schema *jsonschema.Schema) {
 
 type Options struct {
 	ContextPaths              []string     `json:"context_paths,omitempty" jsonschema:"description=Paths to files containing context information for the AI,example=.cursorrules,example=CRUSH.md"`
+	MemoryPaths               []string     `json:"memory_paths,omitempty" jsonschema:"description=Paths to files containing memory information for the AI,default=~/.config/crush/CRUSH.md,default=~/.config/AGENTS.md"`
 	TUI                       *TUIOptions  `json:"tui,omitempty" jsonschema:"description=Terminal user interface options"`
 	Debug                     bool         `json:"debug,omitempty" jsonschema:"description=Enable debug logging,default=false"`
 	DebugLSP                  bool         `json:"debug_lsp,omitempty" jsonschema:"description=Enable debug logging for LSP servers,default=false"`
diff --git a/internal/config/load.go b/internal/config/load.go
index f4aec7bfbe3a08b3af3f78e8f1ebc6ce94e3328b..91f6a3554cf442c2edb8336def936237cf54cc35 100644
--- a/internal/config/load.go
+++ b/internal/config/load.go
@@ -314,6 +314,15 @@ func (c *Config) setDefaults(workingDir, dataDir string) {
 	if c.Options.ContextPaths == nil {
 		c.Options.ContextPaths = []string{}
 	}
+	if c.Options.MemoryPaths == nil {
+		crushConfigDir := filepath.Dir(GlobalConfig())
+		c.Options.MemoryPaths = []string{
+			filepath.Join(crushConfigDir, "CRUSH.md"),
+			filepath.Join(filepath.Dir(crushConfigDir), "AGENTS.md"),
+		}
+	}
+	c.Options.ContextPaths = append(c.Options.ContextPaths, c.Options.MemoryPaths...)
+
 	if dataDir != "" {
 		c.Options.DataDirectory = dataDir
 	} else if c.Options.DataDirectory == "" {
@@ -344,6 +353,9 @@ func (c *Config) setDefaults(workingDir, dataDir string) {
 
 	// Add the default context paths if they are not already present
 	c.Options.ContextPaths = append(defaultContextPaths, c.Options.ContextPaths...)
+
+	// The ordering of contexts can be important; maybe the user's stuff should
+	// go at the bottom? Or top?
 	slices.Sort(c.Options.ContextPaths)
 	c.Options.ContextPaths = slices.Compact(c.Options.ContextPaths)
 
diff --git a/schema.json b/schema.json
index 9fb49e12fa81d287832fbe5639420e1598711ad5..85eaf1ff0006996e56714ef4f37dd0bcfb7fc241 100644
--- a/schema.json
+++ b/schema.json
@@ -357,6 +357,17 @@
           "type": "array",
           "description": "Paths to files containing context information for the AI"
         },
+        "memory_paths": {
+          "items": {
+            "type": "string"
+          },
+          "type": "array",
+          "description": "Paths to files containing memory information for the AI",
+          "default": [
+            "~/.config/crush/CRUSH.md",
+            "~/.config/AGENTS.md"
+          ]
+        },
         "tui": {
           "$ref": "#/$defs/TUIOptions",
           "description": "Terminal user interface options"