WikiOS transforms an Obsidian vault into a local, searchable web application, offering a clean interface for exploring notes. It targets users who manage their knowledge base in Obsidian and desire a web-based, local-first browsing experience without cloud dependencies. The primary benefit is enhanced discoverability and navigation of personal knowledge graphs.

How It Works

WikiOS connects to an Obsidian-compatible Markdown folder, building a local, searchable index (using SQLite) of the notes. It provides a web interface featuring a homepage, article pages, a graph view, and statistics. The system automatically watches the vault for file changes, updating the index and web view in real-time. The architecture separates a React-based client UI from a Fastify backend server, enabling efficient development and deployment.

Quick Start & Requirements

• Primary install/run command: Clone the repository (git clone https://github.com/Ansub/wiki-os.git), navigate into the directory (cd wiki-os), and run npm run first-run for initial setup and launch. Alternatively, use Docker: docker compose up --build.
• Prerequisites: Node.js and npm are required for the npm workflow. Docker is needed for the containerized setup.
• Resource footprint: WikiOS is designed for local-first operation, requiring no cloud services. Indexing large vaults may consume resources.
• Relevant pages: The GitHub repository serves as the primary source of information.

Highlighted Details

• Local-First: Operates entirely locally, ensuring data privacy and offline accessibility.
• Automatic Updates: Filesystem watching automatically updates the index and UI upon note changes.
• Rich Navigation: Features include a dynamic homepage, fast search, article pages, a graph visualization, and statistics.
• Customizable People Model: Offers flexible configuration for recognizing and displaying people mentioned in notes, with explicit control over data inference.

Maintenance & Community

The project is developed by Ansub, co-founder of Supafast. The README does not currently list specific community channels (like Discord or Slack), a public roadmap, or notable sponsorships/partnerships.

Licensing & Compatibility

WikiOS is released under the MIT License. This permissive license allows for broad compatibility, including use within commercial and closed-source applications without significant restrictions.

Limitations & Caveats

The provided README does not explicitly detail limitations, alpha/beta status, or known bugs. Setup requires familiarity with Node.js/npm or Docker environments. The effectiveness of the "People" model may depend on consistent note-taking conventions.