Updated README.md

This commit is contained in:
2026-02-07 11:29:00 -06:00
parent 8197aa6d5f
commit ffeee8eb6b
2 changed files with 15 additions and 7 deletions
BIN
View File
Binary file not shown.
+15 -7
View File
@@ -2,18 +2,29 @@
Automatically tag your Obsidian notes and add SEO metadata using a local LLM.
The script requires 4 frontmatter fields named as such:
- tags
- seo-title
- seo-description
- seo-keywords
## Setup
1. **Install dependencies:**
```bash
pip install pyyaml requests
```
2. **Make sure LM Studio is running** on `http://192.168.68.84:1234` with the `openai/gpt-oss-20b` model loaded
3. **Place these files in a directory:**
- `tag-notes.py` (the main script)
- `tag-taxonomy.yaml` (your tag taxonomy)
4. **Adjust Variables in 'tag-notes.py'**
- Edit the 'NOTES_FOLDER' variable to change the folder it searches
- Edit the 'MODEL_NAME' variable to change the LLM model
- Edit the 'LM_STUDIO_URL' variable to change URL of the LLM API
5. **Adjust preset tags**
- Edit the `tag-taxonomy.yaml` file to change what tags you want it to use.
## Usage
@@ -22,10 +33,7 @@ Simply run the script:
./tag-notes.py
```
It will automatically process all markdown files in:
`~/Documents/ejl-zk/40 Public/41 Notes/`
To change the folder, edit the `NOTES_FOLDER` variable at the top of `tag-notes.py`.
It will automatically process all markdown files in the 'NOTES_FOLDER'.
## What it does
@@ -63,7 +71,7 @@ Processing: /path/to/note.md
## Troubleshooting
**LLM connection errors:**
- Check that LM Studio is running: `curl http://192.168.68.84:1234/v1/models`
- Check that LM Studio is running: `curl http://localhost:1234/v1/models`
- Verify the model is loaded in LM Studio
**No frontmatter found:**
@@ -71,4 +79,4 @@ Processing: /path/to/note.md
**Fields already populated:**
- Script skips notes where all four fields are already filled
- To re-process a note, clear the specific fields you want regenerated
- To re-process a note, clear the specific fields you want regenerated