Skip to content

Haasie/VaultArchitect

Repository files navigation

Object Structure Plugin for Obsidian

This plugin structures and organizes your Obsidian vault using an object-type approach with local NLP categorization powered by Ollama.

Features

  • Object Type Model: Organize notes based on 16 different object types including code, books, ideas, prompts, and more
  • Templates: Pre-made templates for each object type to ensure consistent formatting
  • Automatic Categorization: Uses Ollama for local NLP to automatically categorize notes
  • Metadata Extraction: Automatically extracts and organizes metadata from your notes
  • Folder Organization: Optionally organizes files into folders based on their object type
  • Customizable: Configure Ollama integration and organization preferences

Object Types

This plugin provides structured templates and organization for the following object types:

  • Code: Programming code snippets and examples
  • Books: Book notes, summaries and reviews
  • Ideas: Concepts, brainstorms and creative thoughts
  • Prompts: AI prompts and prompt engineering
  • Templates: Reusable templates and formats
  • Quotes: Quotes and citations
  • Persons: People, contacts and biographical information
  • Images: Images and visual resources
  • Audio: Audio recordings and notes
  • PDFs: PDF documents and annotations
  • Files: General files and attachments
  • Weblinks: Weblinks and bookmark resources
  • Tags: Tag collections and organizations
  • Social Media: Social media posts and content
  • Daily Notes: Daily journals and logs
  • Recipes: Cooking recipes and food notes

Installation

  1. Install the plugin from the Obsidian Community Plugins browser
  2. Enable the plugin in the Community Plugins section of Obsidian settings
  3. Configure the plugin settings

Requirements

  • Ollama: For automatic categorization, you need to have Ollama installed and running on your system
  • LLM Model: Download a compatible model in Ollama (e.g., ollama pull mistral)

Usage

Assigning Object Types

  • Manually: Use the "Assign Object Type" command or click the ribbon icon
  • Automatically: New notes can be automatically categorized using Ollama

Creating New Object-Typed Notes

  • Use the "Create New Note By Object Type" command to create a note with the selected object type's template

Plugin Settings

  • Ollama Endpoint: URL of your Ollama instance (default: http://localhost:11434)
  • Ollama Model: The LLM model to use for categorization
  • Templates Folder: Location of object type templates
  • Organization Options: Configure automatic folder organization and metadata extraction

Development

This plugin is built with TypeScript and uses the Obsidian Plugin API.

Building

  1. Clone this repository
  2. Install dependencies: npm install
  3. Build the plugin: npm run build

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgements

  • Obsidian for the amazing knowledge base platform
  • Ollama for providing local LLM inference

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published