Feature overview

[DanCharousek]

• b2 add [name] (mostly done)

  1. [x] Prompts user for an entry description
  2. [x] Creates new directory in ~/b2/[name]
  3. [ ] ...if the name is not provided generates random name (something like python's friendlywords)

  4. [x] Creates file metadata.yaml in the newly created directory with following structure:

     description: Lorem ipsum dolor sit amet.
     created_at: "2024-10-15 20:12:59"
     matching_queries:
       - Lorem ipsum dolor sit amet.

  5. [x] Spawns new shell with change CWD to the newly created directory

  

• b2 find [query]

  1. [ ] If the query is not provided, prompts user for a one
  2. [x] Calculates hash of the query

  3. [ ] Checks ~/b2/.history.yaml (structure bellow), if the hash is present, spawns new shell in the target directory

     type Query struct {
     Content    string `yaml:"content"`
     Target     string `yaml:"target"`
     LastUsedAt string `yaml:"last_used_at"`
     }
     
     type SearchHistory struct {
     Queries map[string]Query `yaml:"queries"`
     }

  4. [ ] ... if the hash is missing, reads description field from all ~/b2/**/metadata.yaml files and prompts a LLM (ChatGPT - but eventually should be flexible enough to use any other platform) to suggest top n best matching results (dirname - description)
  5. [ ] ... user then selects the "correct" entry
  6. [ ] ... the query is then written into the coresponding ~/b2/[dirname]/metadata.yaml under matching_quries field
  7. [ ] ... the search itself is then obviously written to the ~/b2/.history.yaml file

• b2 summarize

  1. [ ] Iterates over all matching_queries from ~/b2/**/metadata.yaml and prompts AI to summarize those and the original description into concise summary stored in the ai_summary field in the metadata.yaml file

[meeko291]

@DanCharousek

Generating random names:

Package that could suit us (and kinda only package that I found for this feature): github.com/goombaio/namegenerator. Example output:

old-shape
delicate-paper
withered-dawn
frosty-wave

But I'm thinking about creating separate package for it. Something that would be more configurable (e.g. : choosing your separator, choosing just nouns...).

add - name already exists

How should the program behave if we provide (or generate 🫠 ) name that already exits in a dir structure? RN the data will be overwritten.

Should we check the dir; if exits throw an error?