grimoire  by goniszewski

Local-first bookmark manager for technical knowledge

Created 3 years ago
2,817 stars

Top 16.2% on SourcePulse

GitHubView on GitHub
Project Summary

Bookmark manager for the wizards 🧙

Grimoire is a local-first, privacy-focused bookmark manager designed for technical users. It enables saving, organizing, and searching technical resources, with optional AI-powered summarization and categorization, ensuring all data remains on the user's machine.

How It Works

The project comprises a React/Vite/TypeScript frontend and a Bun/Hono/SQLite daemon. Bookmark ingestion is a progressive pipeline: a URL is saved, enqueued as a job, its public content fetched, readable text and metadata extracted, and optionally enriched with AI summaries, tags, and embeddings. Search leverages SQLite FTS5 for keywords and semantic embeddings. This approach prioritizes local control and data privacy, offering optional AI features without mandatory external dependencies.

Quick Start & Requirements

Installation is recommended via source checkout (git clone, npm install, bun install for daemon) and running npm run daemon:dev and npm run dev. Docker is also supported via docker compose up -d. Prerequisites include Node.js, npm, npx, and bun. The Vite app runs at http://127.0.0.1:8080, communicating with the daemon at http://127.0.0.1:3210. API reference is available in API.md.

Highlighted Details

  • Saves public HTTP/HTTPS URLs from various sources.
  • Extracts readable content from web pages, PDFs, GitHub, StackOverflow, and YouTube.
  • Stores bookmarks, content, tags, notes, and backups locally in SQLite and files.
  • Offers keyword (SQLite FTS5) and semantic embedding search capabilities.
  • Optional AI integration with providers like OpenAI, Ollama, and Anthropic for enrichment.
  • Includes a browser bookmarklet for easy URL capture.
  • Provides robust local backup and restore functionality.

Maintenance & Community

The project is actively developed with v1.0 being a complete rewrite. A roadmap exists for migrating from legacy versions, though specific community channels or contributor details are not detailed in the README.

Licensing & Compatibility

Grimoire is licensed under the MIT license, permitting broad use and modification. Its local-first, private architecture suggests compatibility with closed-source environments, with no explicit restrictions noted for commercial use.

Limitations & Caveats

Version 1.0 is a significant rewrite, and a direct migration tool from the legacy v0.5.x version is not yet available but is a high priority. The Homebrew installation path is pending validation. Remote access is not a supported mode and requires manual configuration with a reverse proxy or VPN.

Health Check
Last Commit

1 day ago

Responsiveness

Inactive

Pull Requests (30d)
0
Issues (30d)
0
Star History
0 stars in the last 30 days

Explore Similar Projects

Feedback? Help us improve.