Auto tagging obsidian notes w/ AI
Update README to reflect multi-provider support including OpenRouter
Co-authored-by: jaspermayone <65788728+jaspermayone@users.noreply.github.com>
+26
-16
+26
-16
README.md
+26
-16
README.md
···
1
1
# AI Tagger for Obsidian
2
2
3
-
This Obsidian plugin uses Claude AI to automatically generate tags for your notes and add them to the frontmatter. It analyzes the content of your notes and suggests relevant tags based on the text.
3
+
This Obsidian plugin uses AI to automatically generate tags for your notes and add them to the frontmatter. It analyzes the content of your notes and suggests relevant tags based on the text.
4
4
5
5
## Features
6
6
7
-
- Automatically generate tags for your notes using Claude AI
7
+
- Automatically generate tags for your notes using AI
8
+
- Support for multiple AI providers: Anthropic (Claude), OpenAI (GPT), Mistral AI, Google (Gemini), OpenRouter, and custom endpoints
8
9
- Add the generated tags to your note's frontmatter
9
10
- Tag a single note or batch tag all notes in your vault
10
11
- Customize the prompt used to generate tags
11
-
- Choose from different Claude models
12
+
- Choose from different AI models
12
13
- Configure maximum number of tags per note
13
14
14
15
## Installation
15
16
16
17
1. In Obsidian, go to Settings > Community plugins
17
18
2. Disable Safe mode
18
-
3. Click "Browse" and search for "Claude AI Tagger"
19
+
3. Click "Browse" and search for "AI Tagger"
19
20
4. Install the plugin
20
21
5. Enable the plugin after installation
21
22
22
23
Alternatively, you can manually install the plugin:
23
24
24
25
1. Download the `main.js`, `styles.css`, and `manifest.json` files
25
-
2. Create a folder named `claude-ai-tagger` in your vault's `.obsidian/plugins/` directory
26
+
2. Create a folder named `obsidian-ai-tagger` in your vault's `.obsidian/plugins/` directory
26
27
3. Place the downloaded files in this folder
27
28
4. Enable the plugin in Obsidian's Community Plugins settings
28
29
29
30
## Setup
30
31
31
-
Before using the plugin, you need to configure your Claude API key:
32
+
Before using the plugin, you need to configure your AI provider and API key:
32
33
33
-
1. Get a Claude API key from [Anthropic's Console](https://console.anthropic.com/)
34
-
2. In Obsidian, go to Settings > Claude AI Tagger
35
-
3. Enter your API key in the appropriate field
36
-
4. Configure other settings as desired
34
+
1. Get an API key from your chosen provider:
35
+
- [Anthropic (Claude)](https://console.anthropic.com/)
36
+
- [OpenAI (GPT)](https://platform.openai.com/api-keys)
37
+
- [Mistral AI](https://console.mistral.ai/api-keys/)
38
+
- [Google (Gemini)](https://aistudio.google.com/app/apikey)
39
+
- [OpenRouter](https://openrouter.ai/keys) - Access to multiple models through one API
40
+
- Or use your own custom OpenAI-compatible endpoint
41
+
2. In Obsidian, go to Settings > AI Tagger
42
+
3. Select your AI provider from the dropdown
43
+
4. Enter your API key in the appropriate field
44
+
5. Choose your preferred model
45
+
6. Configure other settings as desired
37
46
38
47
## Usage
39
48
40
49
### Tag Current Note
41
50
42
51
1. Open the note you want to tag
43
-
2. Use the command palette (Ctrl/Cmd + P) and search for "Tag current note with Claude"
52
+
2. Use the command palette (Ctrl/Cmd + P) and search for "Tag current note with AI"
44
53
3. The plugin will analyze your note and add relevant tags to the frontmatter
45
54
46
55
### Tag All Notes
47
56
48
-
1. Use the command palette (Ctrl/Cmd + P) and search for "Tag all notes with Claude"
57
+
1. Use the command palette (Ctrl/Cmd + P) and search for "Tag all notes with AI"
49
58
2. Confirm the action in the dialog that appears
50
59
3. The plugin will process all notes in your vault and add tags to each one
51
60
···
53
62
54
63
## Settings
55
64
56
-
- **Claude API Key**: Your Anthropic API key for Claude
57
-
- **Claude Model**: Choose which Claude model to use (Claude 3.5 Sonnet, Claude 3 Opus, etc.)
65
+
- **AI Provider**: Choose which AI provider to use (Anthropic, OpenAI, Mistral, Google, OpenRouter, or Custom)
66
+
- **API Key**: Your API key for the selected provider
67
+
- **AI Model**: Choose which model to use (options vary by provider)
58
68
- **Maximum Number of Tags**: Set how many tags should be generated per note (1-20)
59
-
- **Prompt Template**: Customize the prompt sent to Claude to generate tags
69
+
- **Prompt Style**: Choose from predefined prompt styles or create your own custom prompt
60
70
61
71
## Customizing the Prompt
62
72
63
-
You can customize the prompt sent to Claude using the following placeholders:
73
+
You can customize the prompt sent to the AI using the following placeholders:
64
74
65
75
- `{maxTags}`: Will be replaced with the maximum number of tags setting
66
76
- `{content}`: Will be replaced with the note content