fegger
59df2f6856
Update error handling and improve streaming capabilities in the Ollama client and related components. Key changes include: - Simplify error types and improve error handling - Refactor streaming logic to use async generators - Update tool execution and vault indexing - Improve utility functions and types - Update test files to reflect changes
66 lines
1.6 KiB
Markdown
Executable File
66 lines
1.6 KiB
Markdown
Executable File
# Ollama Chat Plugin for Obsidian
|
|
|
|
A plugin that integrates Ollama with Obsidian to create a chat interface that can access your vault content.
|
|
|
|
## Features
|
|
|
|
- Chat with Ollama models directly in Obsidian
|
|
- Vault context search - the assistant can reference your notes
|
|
- Tool integration - create files based on chat responses
|
|
- Streaming responses
|
|
- Customizable model and URL settings
|
|
|
|
## Installation
|
|
|
|
1. Install the plugin via Obsidian's community plugins
|
|
2. Make sure you have Ollama installed and running
|
|
|
|
## Setup
|
|
|
|
1. **Install Ollama**: Follow the instructions at [ollama.ai](https://ollama.ai) to install Ollama
|
|
2. **Start Ollama service**: `ollama serve`
|
|
3. **Pull a model**: `ollama pull llama3` (or any other model you prefer)
|
|
|
|
## Configuration
|
|
|
|
1. Open the plugin settings via Obsidian's settings panel
|
|
2. Configure the Ollama URL (default: `http://localhost:11434`)
|
|
3. Configure the model name (default: `llama3`)
|
|
4. Restart the plugin if needed
|
|
|
|
## Usage
|
|
|
|
1. Click the ribbon icon to open the chat view
|
|
2. Type your message in the input box
|
|
3. Press Enter or click Send to send your message
|
|
4. Click the "New Chat" button to start a fresh conversation
|
|
|
|
## Supported Models
|
|
|
|
Any model supported by Ollama should work, including:
|
|
|
|
- llama3
|
|
- llama2
|
|
- mistral
|
|
- codellama
|
|
- etc.
|
|
|
|
## Development
|
|
|
|
To build from source:
|
|
|
|
```bash
|
|
npm install
|
|
npm run build
|
|
```
|
|
|
|
## Troubleshooting
|
|
|
|
- **Connection issues**: Ensure Ollama is running and accessible at the configured URL
|
|
- **Model not found**: Make sure you've pulled the model (`ollama pull <modelname>`)
|
|
- **Permission issues**: Check that your Obsidian vault has proper write permissions
|
|
|
|
## License
|
|
|
|
MIT
|