Update README.md, document context injection
This commit is contained in:
15
README.md
15
README.md
@@ -11,6 +11,8 @@ Give your notes AI capability by embedding Opencode [OpenCode](https://opencode.
|
|||||||
- Query and explore your knowledge base
|
- Query and explore your knowledge base
|
||||||
- Generate outlines and structured notes
|
- Generate outlines and structured notes
|
||||||
|
|
||||||
|
This plugin uses OpenCode's web view that can be embedded directly into Obsidian window. Usually similar plugins would use the ACP protocol, but I want to see how how much is possible without having to implement (and manage) a custom chat UI - I want the full power of OpenCode in my Obsidian.
|
||||||
|
|
||||||
_Note: plugin author is not afiliated with OpenCode or Obsidian - this is a 3rd party software._
|
_Note: plugin author is not afiliated with OpenCode or Obsidian - this is a 3rd party software._
|
||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
@@ -32,13 +34,14 @@ _Note: plugin author is not afiliated with OpenCode or Obsidian - this is a 3rd
|
|||||||
- `Cmd/Ctrl+Shift+O` to toggle the panel
|
- `Cmd/Ctrl+Shift+O` to toggle the panel
|
||||||
- Server starts automatically when you open the panel
|
- Server starts automatically when you open the panel
|
||||||
|
|
||||||
### Commands
|
## Context injection (experimental)
|
||||||
|
|
||||||
| Command | Description |
|
This plugin can automatically inject context to the running OC instance: list of open notes and currently selected text.
|
||||||
|---------|-------------|
|
|
||||||
| Toggle OpenCode panel | Show/hide sidebar |
|
It can be configured form the plugin settings.
|
||||||
| Start OpenCode server | Manual start |
|
|
||||||
| Stop OpenCode server | Manual stop |
|
Currently, this is work-in-progress feature with some limitations:
|
||||||
|
- It won't work when creating new session from OC interface.
|
||||||
|
|
||||||
## Settings
|
## Settings
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user