`bd remember` is a leaf command with ExactArgs(1), so a mistaken `bd remember recall` (or any bare bd command name like `status`, `forget`, `memories`) silently stored that word as a memory instead of doing what the user intended — no dispatch, no confirmation (GH#4401). Guard the content argument: if it is a single bare word that matches the name or alias of a top-level bd command, refuse with an actionable hint instead of writing a memory. Genuine insights are phrases (they contain whitespace) so they pass untouched, and an explicit --key signals deliberate intent and bypasses the guard, so storing the literal word is still possible. Adds a pure-Go regression test for the matcher. Fixes gastownhall/beads#4401 Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
424 lines
12 KiB
Go
424 lines
12 KiB
Go
package main
|
|
|
|
import (
|
|
"fmt"
|
|
"os"
|
|
"regexp"
|
|
"sort"
|
|
"strings"
|
|
|
|
"github.com/spf13/cobra"
|
|
|
|
"github.com/steveyegge/beads/internal/metrics"
|
|
"github.com/steveyegge/beads/internal/storage/kvkeys"
|
|
)
|
|
|
|
// memoryPrefix is prepended (after kvPrefix) to all memory keys.
|
|
const memoryPrefix = kvkeys.MemoryPrefix
|
|
|
|
// memoryKeyFlag allows explicit key override for bd remember.
|
|
var memoryKeyFlag string
|
|
|
|
// slugify converts a string to a URL-friendly slug for use as a memory key.
|
|
// Takes the first ~8 words, lowercases, replaces non-alphanumeric with hyphens.
|
|
func slugify(s string) string {
|
|
s = strings.ToLower(s)
|
|
// Replace non-alphanumeric chars with hyphens
|
|
re := regexp.MustCompile(`[^a-z0-9]+`)
|
|
s = re.ReplaceAllString(s, "-")
|
|
s = strings.Trim(s, "-")
|
|
|
|
// Limit to first ~8 "words" (hyphen-separated segments)
|
|
parts := strings.SplitN(s, "-", 10)
|
|
if len(parts) > 8 {
|
|
parts = parts[:8]
|
|
}
|
|
slug := strings.Join(parts, "-")
|
|
|
|
// Cap total length
|
|
if len(slug) > 60 {
|
|
slug = slug[:60]
|
|
// Don't end on a hyphen
|
|
slug = strings.TrimRight(slug, "-")
|
|
}
|
|
return slug
|
|
}
|
|
|
|
// matchesKnownCommand reports whether insight is a single bare word that
|
|
// matches the name or an alias of a top-level bd command. It is used to catch
|
|
// `bd remember <subcommand>` mistakes before they become accidental memories.
|
|
// Multi-word insights (the normal case) always pass, since they contain
|
|
// whitespace and so cannot be a single command token.
|
|
func matchesKnownCommand(cmd *cobra.Command, insight string) (string, bool) {
|
|
word := strings.TrimSpace(insight)
|
|
if word == "" || strings.ContainsAny(word, " \t\r\n") {
|
|
return "", false
|
|
}
|
|
for _, c := range cmd.Root().Commands() {
|
|
if strings.EqualFold(c.Name(), word) {
|
|
return c.Name(), true
|
|
}
|
|
for _, alias := range c.Aliases {
|
|
if strings.EqualFold(alias, word) {
|
|
return c.Name(), true
|
|
}
|
|
}
|
|
}
|
|
return "", false
|
|
}
|
|
|
|
// rememberCmd stores a memory.
|
|
var rememberCmd = &cobra.Command{
|
|
Use: `remember "<insight>"`,
|
|
Short: "Store a persistent memory",
|
|
Long: `Store a memory that persists across sessions and account rotations.
|
|
|
|
Memories are injected at prime time (bd prime) so you have them
|
|
in every session without manual loading.
|
|
|
|
The positional arg is the memory CONTENT (the key is auto-generated from it
|
|
unless --key is given). As a convenience, if the arg is a bare key naming an
|
|
existing memory, it is RECALLED instead of stored (same as 'bd recall');
|
|
a bare key naming nothing is refused. Use --key to store slug-like content.
|
|
|
|
Examples:
|
|
bd remember "always run tests with -race flag"
|
|
bd remember "Dolt phantom DBs hide in three places" --key dolt-phantoms
|
|
bd remember "auth module uses JWT not sessions" --key auth-jwt
|
|
bd remember dolt-phantoms # bare existing key: reads it (= bd recall)`,
|
|
GroupID: "setup",
|
|
Args: cobra.ExactArgs(1),
|
|
SilenceUsage: true,
|
|
SilenceErrors: true,
|
|
RunE: func(cmd *cobra.Command, args []string) error {
|
|
CheckReadonly("remember")
|
|
|
|
evt := metrics.NewCommandEvent("remember")
|
|
defer func() {
|
|
if c := metrics.Global(); c != nil {
|
|
c.CloseEventAndAdd(evt)
|
|
}
|
|
}()
|
|
|
|
if err := ensureDirectMode("remember requires direct database access"); err != nil {
|
|
return HandleError("%v", err)
|
|
}
|
|
|
|
insight := args[0]
|
|
if strings.TrimSpace(insight) == "" {
|
|
return HandleErrorRespectJSON("memory content cannot be empty")
|
|
}
|
|
|
|
// Guard against a subcommand-like first argument being silently stored
|
|
// as memory content. `bd remember` is a leaf command, so a mistaken
|
|
// `bd remember recall` (or any bare bd command name) would otherwise
|
|
// store the word "recall" as a memory instead of doing what the user
|
|
// intended (GH#4401). A genuine insight is a phrase, so only a single
|
|
// bare word that matches a known command is treated as suspect, and an
|
|
// explicit --key signals deliberate intent and bypasses the guard.
|
|
if memoryKeyFlag == "" {
|
|
if name, ok := matchesKnownCommand(cmd, insight); ok {
|
|
return HandleErrorWithHintRespectJSON(
|
|
fmt.Sprintf("%q looks like a command, not something to remember", insight),
|
|
fmt.Sprintf("Did you mean 'bd %s'? To store %q as a memory anyway, give it an explicit key: bd remember %q --key <key>", name, insight, insight),
|
|
)
|
|
}
|
|
}
|
|
|
|
// Generate or use provided key
|
|
key := memoryKeyFlag
|
|
if key == "" {
|
|
key = slugify(insight)
|
|
}
|
|
if key == "" {
|
|
return HandleErrorRespectJSON("could not generate key from content; use --key to specify one")
|
|
}
|
|
|
|
storageKey := kvPrefix + memoryPrefix + key
|
|
|
|
ctx := rootCtx
|
|
|
|
existing, _ := store.GetConfig(ctx, storageKey)
|
|
verb := "Remembered"
|
|
if existing != "" {
|
|
verb = "Updated"
|
|
}
|
|
|
|
// Desire path + footgun guard: `bd remember <x>` is a WRITE whose positional arg is
|
|
// the CONTENT, not a key -- but "remember X" reads as a getter in English, so agents
|
|
// routinely type `bd remember some-key` meaning "do you remember X?". The tell-tale of
|
|
// a mistyped read is content that round-trips through slugify unchanged (a bare slug);
|
|
// real prose insights never do. When that happens and no explicit --key was given:
|
|
// - the key EXISTS -> pave the desire path: recall it instead of writing
|
|
// - no such key -> refuse; storing a key-like token as its own content would
|
|
// create a junk memory that hides the mistake
|
|
// Passing --key states write intent and bypasses both branches.
|
|
if memoryKeyFlag == "" && slugify(insight) == insight {
|
|
if existing != "" {
|
|
if jsonOutput {
|
|
return outputJSON(map[string]interface{}{
|
|
"key": key,
|
|
"value": existing,
|
|
"found": true,
|
|
"action": "recalled",
|
|
})
|
|
}
|
|
fmt.Fprintf(os.Stderr,
|
|
"(recalled %q -- a bare existing key READS. To overwrite: `bd remember \"<new content>\" --key %s`)\n",
|
|
key, key)
|
|
fmt.Printf("%s\n", existing)
|
|
return nil
|
|
}
|
|
return HandleErrorRespectJSON(
|
|
"no memory named %q to recall -- and refusing to store a bare key-like token as its own content. "+
|
|
"`bd remember` WRITES (its positional arg is CONTENT, not a key). "+
|
|
"To store it anyway: `bd remember %q --key %s`. To browse keys: `bd memories`",
|
|
key, insight, key)
|
|
}
|
|
|
|
if err := store.SetConfig(ctx, storageKey, insight); err != nil {
|
|
return HandleErrorRespectJSON("storing memory: %v", err)
|
|
}
|
|
commandDidWrite.Store(true)
|
|
|
|
if jsonOutput {
|
|
return outputJSON(map[string]string{
|
|
"key": key,
|
|
"value": insight,
|
|
"action": strings.ToLower(verb),
|
|
})
|
|
}
|
|
fmt.Printf("%s [%s]: %s\n", verb, key, truncateMemory(insight, 80))
|
|
return nil
|
|
},
|
|
}
|
|
|
|
// memoriesCmd lists and searches memories.
|
|
var memoriesCmd = &cobra.Command{
|
|
Use: "memories [search]",
|
|
Short: "List or search persistent memories",
|
|
Long: `List all memories, or search by keyword.
|
|
|
|
Examples:
|
|
bd memories # list all memories
|
|
bd memories dolt # search for memories about dolt
|
|
bd memories "race flag" # search for a phrase`,
|
|
GroupID: "setup",
|
|
Args: cobra.MaximumNArgs(1),
|
|
SilenceUsage: true,
|
|
SilenceErrors: true,
|
|
RunE: func(cmd *cobra.Command, args []string) error {
|
|
evt := metrics.NewCommandEvent("memories")
|
|
defer func() {
|
|
if c := metrics.Global(); c != nil {
|
|
c.CloseEventAndAdd(evt)
|
|
}
|
|
}()
|
|
|
|
if err := ensureDirectMode("memories requires direct database access"); err != nil {
|
|
return HandleError("%v", err)
|
|
}
|
|
|
|
ctx := rootCtx
|
|
allConfig, err := store.GetAllConfig(ctx)
|
|
if err != nil {
|
|
return HandleErrorRespectJSON("listing memories: %v", err)
|
|
}
|
|
|
|
// Filter for kv.memory.* keys
|
|
fullPrefix := kvkeys.MemoryConfigKeyPrefix
|
|
memories := make(map[string]string)
|
|
for k, v := range allConfig {
|
|
if strings.HasPrefix(k, fullPrefix) {
|
|
userKey := strings.TrimPrefix(k, fullPrefix)
|
|
memories[userKey] = v
|
|
}
|
|
}
|
|
|
|
var search string
|
|
if len(args) > 0 {
|
|
search = strings.ToLower(args[0])
|
|
}
|
|
if search != "" {
|
|
filtered := make(map[string]string)
|
|
for k, v := range memories {
|
|
if strings.Contains(strings.ToLower(k), search) ||
|
|
strings.Contains(strings.ToLower(v), search) {
|
|
filtered[k] = v
|
|
}
|
|
}
|
|
memories = filtered
|
|
}
|
|
|
|
if jsonOutput {
|
|
return outputJSON(memories)
|
|
}
|
|
|
|
if len(memories) == 0 {
|
|
if search != "" {
|
|
fmt.Printf("No memories matching %q\n", search)
|
|
} else {
|
|
fmt.Println("No memories stored. Use 'bd remember \"insight\"' to add one.")
|
|
}
|
|
return nil
|
|
}
|
|
|
|
keys := make([]string, 0, len(memories))
|
|
for k := range memories {
|
|
keys = append(keys, k)
|
|
}
|
|
sort.Strings(keys)
|
|
|
|
if search != "" {
|
|
fmt.Printf("Memories matching %q:\n\n", search)
|
|
} else {
|
|
fmt.Printf("Memories (%d):\n\n", len(memories))
|
|
}
|
|
for _, k := range keys {
|
|
v := memories[k]
|
|
fmt.Printf(" %s\n", k)
|
|
fmt.Printf(" %s\n\n", truncateMemory(v, 120))
|
|
}
|
|
return nil
|
|
},
|
|
}
|
|
|
|
// forgetCmd removes a memory.
|
|
var forgetCmd = &cobra.Command{
|
|
Use: "forget <key>",
|
|
Short: "Remove a persistent memory",
|
|
Long: `Remove a memory by its key.
|
|
|
|
Use 'bd memories' to see available keys.
|
|
|
|
Examples:
|
|
bd forget dolt-phantoms
|
|
bd forget auth-jwt`,
|
|
GroupID: "setup",
|
|
Args: cobra.ExactArgs(1),
|
|
SilenceUsage: true,
|
|
SilenceErrors: true,
|
|
RunE: func(cmd *cobra.Command, args []string) error {
|
|
CheckReadonly("forget")
|
|
|
|
evt := metrics.NewCommandEvent("forget")
|
|
defer func() {
|
|
if c := metrics.Global(); c != nil {
|
|
c.CloseEventAndAdd(evt)
|
|
}
|
|
}()
|
|
|
|
if err := ensureDirectMode("forget requires direct database access"); err != nil {
|
|
return HandleError("%v", err)
|
|
}
|
|
|
|
key := args[0]
|
|
storageKey := kvPrefix + memoryPrefix + key
|
|
|
|
ctx := rootCtx
|
|
|
|
existing, _ := store.GetConfig(ctx, storageKey)
|
|
if existing == "" {
|
|
if jsonOutput {
|
|
if jerr := outputJSON(map[string]string{
|
|
"key": key,
|
|
"found": "false",
|
|
}); jerr != nil {
|
|
return jerr
|
|
}
|
|
return SilentExit()
|
|
}
|
|
fmt.Fprintf(os.Stderr, "No memory with key %q\n", key)
|
|
return SilentExit()
|
|
}
|
|
|
|
if err := store.DeleteConfig(ctx, storageKey); err != nil {
|
|
return HandleErrorRespectJSON("forgetting memory: %v", err)
|
|
}
|
|
commandDidWrite.Store(true)
|
|
|
|
if jsonOutput {
|
|
return outputJSON(map[string]string{
|
|
"key": key,
|
|
"deleted": "true",
|
|
})
|
|
}
|
|
fmt.Printf("Forgot [%s]: %s\n", key, truncateMemory(existing, 80))
|
|
return nil
|
|
},
|
|
}
|
|
|
|
// recallCmd retrieves a specific memory by key.
|
|
var recallCmd = &cobra.Command{
|
|
Use: "recall <key>",
|
|
Short: "Retrieve a specific memory",
|
|
Long: `Retrieve the full content of a memory by its key.
|
|
|
|
Examples:
|
|
bd recall dolt-phantoms
|
|
bd recall auth-jwt`,
|
|
GroupID: "setup",
|
|
Args: cobra.ExactArgs(1),
|
|
SilenceUsage: true,
|
|
SilenceErrors: true,
|
|
RunE: func(cmd *cobra.Command, args []string) error {
|
|
evt := metrics.NewCommandEvent("recall")
|
|
defer func() {
|
|
if c := metrics.Global(); c != nil {
|
|
c.CloseEventAndAdd(evt)
|
|
}
|
|
}()
|
|
|
|
if err := ensureDirectMode("recall requires direct database access"); err != nil {
|
|
return HandleError("%v", err)
|
|
}
|
|
|
|
key := args[0]
|
|
storageKey := kvPrefix + memoryPrefix + key
|
|
|
|
ctx := rootCtx
|
|
value, err := store.GetConfig(ctx, storageKey)
|
|
if err != nil {
|
|
return HandleErrorRespectJSON("recalling memory: %v", err)
|
|
}
|
|
|
|
if jsonOutput {
|
|
if jerr := outputJSON(map[string]interface{}{
|
|
"key": key,
|
|
"value": value,
|
|
"found": value != "",
|
|
}); jerr != nil {
|
|
return jerr
|
|
}
|
|
if value == "" {
|
|
return SilentExit()
|
|
}
|
|
return nil
|
|
}
|
|
if value == "" {
|
|
fmt.Fprintf(os.Stderr, "No memory with key %q\n", key)
|
|
return SilentExit()
|
|
}
|
|
fmt.Printf("%s\n", value)
|
|
return nil
|
|
},
|
|
}
|
|
|
|
// truncateMemory shortens a string to maxLen for display.
|
|
func truncateMemory(s string, maxLen int) string {
|
|
// Replace newlines with spaces for single-line display
|
|
s = strings.ReplaceAll(s, "\n", " ")
|
|
if len(s) <= maxLen {
|
|
return s
|
|
}
|
|
return s[:maxLen-3] + "..."
|
|
}
|
|
|
|
func init() {
|
|
rememberCmd.Flags().StringVar(&memoryKeyFlag, "key", "", "Explicit key for the memory (auto-generated from content if not set). If a memory with this key already exists, it will be updated in place")
|
|
|
|
rootCmd.AddCommand(rememberCmd)
|
|
rootCmd.AddCommand(memoriesCmd)
|
|
rootCmd.AddCommand(forgetCmd)
|
|
rootCmd.AddCommand(recallCmd)
|
|
}
|