feat: obsidian integration plugin

agent/package.json

@@ -69,6 +69,7 @@
         "@elizaos/plugin-web-search": "workspace:*",
         "@elizaos/plugin-genlayer": "workspace:*",
         "@elizaos/plugin-open-weather": "workspace:*",
+        "@elizaos/plugin-obsidian": "workspace:*",
         "readline": "1.3.0",
         "ws": "8.18.0",
         "yargs": "17.7.2"
@@ -80,4 +81,4 @@
         "ts-node": "10.9.2",
         "tsup": "8.3.5"
     }
-}
+}

agent/src/index.ts

@@ -53,7 +53,7 @@ import { echoChambersPlugin } from "@elizaos/plugin-echochambers";
 import { evmPlugin } from "@elizaos/plugin-evm";
 import { flowPlugin } from "@elizaos/plugin-flow";
 import { fuelPlugin } from "@elizaos/plugin-fuel";
-import { genLayerPlugin } from "@elizaos/plugin-genlayer";
+//import { genLayerPlugin } from "@elizaos/plugin-genlayer";
 import { imageGenerationPlugin } from "@elizaos/plugin-image-generation";
 import { multiversxPlugin } from "@elizaos/plugin-multiversx";
 import { nearPlugin } from "@elizaos/plugin-near";
@@ -68,10 +68,10 @@ import { teeMarlinPlugin } from "@elizaos/plugin-tee-marlin";
 import { tonPlugin } from "@elizaos/plugin-ton";
 import { webSearchPlugin } from "@elizaos/plugin-web-search";
 import { zksyncEraPlugin } from "@elizaos/plugin-zksync-era";
-
 import { availPlugin } from "@elizaos/plugin-avail";
 import { openWeatherPlugin } from "@elizaos/plugin-open-weather";
 import { stargazePlugin } from "@elizaos/plugin-stargaze";
+import { obsidianPlugin } from "@elizaos/plugin-obsidian";
 import Database from "better-sqlite3";
 import fs from "fs";
 import net from "net";
@@ -645,14 +645,15 @@ export async function createAgent(
                 ? echoChambersPlugin
                 : null,
             getSecret(character, "STARGAZE_ENDPOINT") ? stargazePlugin : null,
-            getSecret(character, "GENLAYER_PRIVATE_KEY")
-                ? genLayerPlugin
-                : null,
-            getSecret(character, "AVAIL_SEED") ? availPlugin : null,
-            getSecret(character, "AVAIL_APP_ID") ? availPlugin : null,
+            //getSecret(character, "GENLAYER_PRIVATE_KEY")
+            //    ? genLayerPlugin
+            //    : null,
+            //getSecret(character, "AVAIL_SEED") ? availPlugin : null,
+            //getSecret(character, "AVAIL_APP_ID") ? availPlugin : null,
             getSecret(character, "OPEN_WEATHER_API_KEY")
                 ? openWeatherPlugin
                 : null,
+            getSecret(character, "OBSIDIAN_API_TOKEN") ? obsidianPlugin : null,
         ].filter(Boolean),
         providers: [],
         actions: [],

packages/plugin-obsidian/.npmignore

@@ -0,0 +1,6 @@
+*
+
+!dist/**
+!package.json
+!readme.md
+!tsup.config.ts

packages/plugin-obsidian/README.md

@@ -0,0 +1,234 @@
+# @elizaos/plugin-obsidian
+
+An Obsidian plugin for ELIZA OS that provides seamless integration with Obsidian vaults, enabling powerful file and note management capabilities.
+
+## Features
+
+1. Deep traversal of Obsidian notes:
+   - Implementing hierarchical note structure analysis
+   - Enabling traversal of note links and backlinks
+   - Storing hierarchy data in memory for efficient access
+
+2. Advanced search functionality:
+   - Full-text search across all vault files
+   - Support for regex patterns and context-aware searches
+   - Integration with Obsidian's native search capabilities using Obsidian's Rest API
+
+3. Obsidian memory store integration:
+   - Building and maintaining a knowledge base from vault notes
+   - Implementing efficient data structures for quick retrieval
+
+4. Naval database integration as an example:
+   - Demonstrating how to import and structure obsidian notes in the agent memory
+   - Showcasing integration of Naval's wisdom and quotes
+   - Creating a knowledge base from Naval's vault notes for the agent
+   - Naval's character json file is included in the PR for reference (found in the example directory)
+
+### Vault Operations
+
+- **List Files**
+  - Get all files in the vault
+
+  ```typescript
+  // List all files
+  const files = await obsidian.listFiles(); // Example: "List all files"
+  ```
+
+- **Directory Management**
+  - List directory contents
+
+  ```typescript
+  // List directory contents
+  const contents = await obsidian.listDirectory("path/to/dir"); // Example: "List directory PATH" or "ls PATH"
+  ```
+
+### Note Management
+
+- **Note Retrieval**
+  - Get note content and metadata
+  - Support for frontmatter parsing
+
+  ```typescript
+  // Get a note with its content
+  const note = await obsidian.getNote("path/to/note.md"); // Example: "Get note PATH"
+  ```
+
+- **Deep Traversal**
+  - Build hierarchical note structures
+  - Store hierarchy data in memory
+  - Traverse note links and backlinks
+
+  ```typescript
+  // Traverse notes links
+  const hierarchy = buildLinkHierarchy("path/to/start-note.md"); // Example: "Map links in PATH"
+  ```
+
+- **Create Knowledge Bases**
+  - Build memory knowledge base from vault notes
+
+  ```typescript
+  // Build knowledge base
+  const knowledgeBase = await obsidian.createMemoriesFromFiles(); // Example: "Create knowledge base"
+  ```
+
+### Search Capabilities
+
+- **Full-Text Search**
+  - Search across all vault files
+  - Support for regex patterns
+  - Support for context search
+  - Support for frontmatter search
+
+  ```typescript
+  // Search in vault
+  const results = await obsidian.search("query");
+  // Examples: "Search QUERY" or "find notes with 'YOUR QUERY'" or "search notes named 'FILENAME'"
+  ```
+
+### File Operations
+
+- **Read Files**
+  - Read files in the Obsidian Vault
+
+  ```typescript
+  // Open a file in Obsidian
+  await obsidian.readFile("DOCUMENTS/report.txt"); // Example: "Read DOCUMENTS/report.txt"
+  ```
+
+- **Create/Save Files**
+  - Create new files with automatic directory creation
+  - Save content to existing files
+  - Support for various file types
+
+  ```typescript
+  // Create or update a file
+  await obsidian.saveFile("DOCUMENTS/report.txt", "Content", true); // Example: "Save DOCUMENTS/report.txt"
+  ```
+
+- **Open Files**
+  - Open files in the Obsidian Vault
+  - Seamless integration with Obsidian's Rest API
+
+  ```typescript
+  // Open a file in Obsidian
+  await obsidian.openFile("DOCUMENTS/report.txt"); // Example: "Open DOCUMENTS/report.txt"
+  ```
+
+- **Update Files**
+  - Update existing files without creating new ones
+  - Line-specific updates supported
+
+  ```typescript
+  // Update an existing file
+  await obsidian.patchFile("DOCUMENTS/report.txt", "New content"); // Example: "Update DOCUMENTS/report.txt"
+  ```
+
+## Installation
+
+```bash
+npm install @elizaos/plugin-obsidian
+# or
+yarn add @elizaos/plugin-obsidian
+# or
+pnpm add @elizaos/plugin-obsidian
+```
+
+## Configuration
+
+The plugin requires the following character secret settings:
+
+```json
+{
+    "settings": {
+        "secrets": {
+            "OBSIDIAN_API_TOKEN": "your-obsidian-api-token",
+            "OBSIDIAN_API_PORT": "your-obsidian-api-port", // Optional (default: 27123)
+            "OBSIDIAN_API_URL": "https://your-obsidian-api-url" , // Optional (default: "http://127.0.0.1:27123")
+        },
+        // other settings...
+    }
+}
+```
+
+## Usage
+
+Import and register the plugin in your Eliza agent configuration:
+
+```typescript
+import { obsidianPlugin } from '@elizaos/plugin-obsidian';
+
+export default {
+  plugins: [
+    // other plugins...
+    getSecret(character, "OBSIDIAN_API_TOKEN") ? obsidianPlugin : null,
+    // other plugins...
+  ]
+};
+```
+
+## Development
+
+```bash
+# Build the plugin
+pnpm build
+
+# Run in development mode
+pnpm dev
+
+# Run tests
+pnpm test
+
+# Run linting
+pnpm lint
+```
+
+## Actions
+
+The plugin provides several actions that can be used with ELIZA OS:
+
+- `SAVE_FILE`: Create or update files
+- `OPEN_FILE`: Open files in Obsidian
+- `UPDATE_FILE`: Update existing files
+- `GET_NOTE`: Retrieve note content
+- `NOTE_TRAVERSAL`: Build note hierarchies
+- `SEARCH`: Search vault contents
+- `LIST_FILES`: List vault files
+- `LIST_DIRECTORY`: List directory contents
+- `CREATE_KNOWLEDGE`: Generate knowledge bases
+- `GET_ACTIVE_NOTE`: Get current note
+- `SUMMARIZE_ACTIVE_NOTE`: Summarize current note
+
+## Error Handling
+
+The plugin provides detailed error messages and proper error handling:
+
+```typescript
+try {
+  await obsidian.saveFile("path/to/file", "content");
+} catch (error) {
+  if (error.code === 'FILE_NOT_FOUND') {
+    // Handle file not found
+  }
+  // Handle other errors
+}
+```
+
+## Contributing
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE file for details.
+
+## Support
+
+For support, please:
+
+1. Check the [documentation](https://docs.elizaos.com)
+2. Open an issue in the repository
+3. Join our [Discord community](https://discord.gg/elizaos)

packages/plugin-obsidian/eslint.config.mjs

@@ -0,0 +1,3 @@
+import eslintGlobalConfig from "../../eslint.config.mjs";
+
+export default [...eslintGlobalConfig];

packages/plugin-obsidian/package.json

@@ -0,0 +1,23 @@
+{
+    "name": "@elizaos/plugin-obsidian",
+    "version": "0.1.7",
+    "main": "dist/index.js",
+    "type": "module",
+    "types": "dist/index.d.ts",
+    "dependencies": {
+        "@elizaos/core": "workspace:*",
+        "file-type-checker": "^1.1.2",
+        "mrmime": "^2.0.0",
+        "tsup": "8.3.5"
+    },
+    "scripts": {
+        "build": "tsup --format esm --dts",
+        "dev": "tsup --format esm --dts --watch",
+        "test": "vitest run",
+        "test:watch": "vitest",
+        "lint": "eslint --fix --cache ."
+    },
+    "peerDependencies": {
+        "whatwg-url": "7.1.0"
+    }
+}