Summary

This project offers a local-first, cross-platform desktop knowledge base application. It targets users needing a powerful, self-hosted solution for note-taking, information organization, and knowledge synthesis, featuring full-text search, bidirectional links, and AI assistance without cloud dependencies.

How It Works

Built on Tauri 2.x, React 19, and Rust, it uses SQLite for local storage and FTS5 for efficient full-text search. The local-first architecture minimizes cloud reliance, supporting granular synchronization via WebDAV, S3, or cloud drives. AI capabilities integrate with OpenAI-compatible APIs or Ollama for Q&A and planning via a tool-calling framework.

Quick Start & Requirements

Install via pnpm install, then run pnpm tauri dev for development or pnpm tauri build for production. Prerequisites include Node.js with pnpm and Rust. Documentation is available at https://kb.ruoyi.plus/.

Highlighted Details

• Markdown editor, bidirectional links, and knowledge graph visualization.
• Multi-device sync (WebDAV/S3/cloud drives) with incremental updates and ZIP backups.
• AI integration (OpenAI compatible/Ollama) for Q&A and intelligent planning.
• Import support (.md/.txt/.pdf/.docx) and Vault encryption with PIN protection.
• Cross-platform (Win/macOS/Linux) with in-app auto-updates.

Maintenance & Community

Active maintenance is indicated by community channels like QQ (1090770702), Bilibili (https://space.bilibili.com/520725002), and documentation (https://kb.ruoyi.plus/). Contributions require signing a CLA.

Licensing & Compatibility

Released under GNU AGPL-3.0 with a dual-licensing model. Personal, research, non-commercial, and internal enterprise use are free under AGPL-3.0. Commercial use, proprietary redistribution, or SaaS requires a separate commercial license.

Limitations & Caveats

The AGPL-3.0 license's strong copyleft provisions restrict closed-source commercial use and SaaS deployments, mandating a commercial license for such scenarios. Users must secure appropriate authorization for these use cases.