silverbullet  by silverbulletmd

Programmable, private, browser-based knowledge management platform

Created 4 years ago
4,564 stars

Top 10.8% on SourcePulse

GitHubView on GitHub
Project Summary

Summary SilverBullet is an open-source, self-hosted, browser-based personal knowledge management (PKM) platform designed for power users. It addresses the need for a private, highly customizable note-taking environment by combining a robust Markdown editor with the extensibility of Lua scripting.

How It Works

SilverBullet employs a client-server architecture, with the frontend built in TypeScript (using CodeMirror 6 and Preact, bundled via Deno/ESBuild) and the backend written in Go. User content is stored as Markdown files within a "Space," navigable via traditional links or a page picker, featuring bi-directional linking akin to a wiki. Its core innovation lies in Space Lua, a dialect of Lua, enabling dynamic content generation, custom commands, page templates, and interactive widgets, allowing deep personalization beyond static note-taking.

Quick Start & Requirements

  • Prerequisites: Deno and Go are required for local development and building.
  • Installation: Can be built locally using make (requires Deno/Go) or via Docker (docker build -t silverbullet .).
  • Running: Execute ./silverbullet <PATH-TO-YOUR-SPACE> locally or docker run -p 3000:3000 -v <PATH-TO-YOUR-SPACE>:/space silverbullet. Development is streamlined with air for automatic rebuilds.
  • Documentation: Further details are available at silverbullet.md.

Highlighted Details

  • Programmable PKM: Extensible via Space Lua for custom commands, templates, and widgets.
  • Rich Editor Features: Includes live Markdown preview, outlining tools, task management, and a database-like object/query system.
  • Privacy & Control: Fully self-hosted and browser-based, ensuring data privacy.
  • Bi-directional Linking: Wiki-style linking with explicit backlink tracking.

Maintenance & Community

No specific details regarding maintainers, community channels (like Discord/Slack), or roadmap were found in the provided README snippet.

Licensing & Compatibility

The license type is not specified in the provided README. This absence is a critical factor for evaluating commercial use or integration into closed-source projects, as it leaves usage rights ambiguous.

Limitations & Caveats

The README mentions an "LLM use policy," suggesting potential considerations or restrictions related to AI features, though specifics are not detailed. No other explicit limitations, such as alpha/beta status or known bugs, were noted.

Health Check
Last Commit

2 days ago

Responsiveness

Inactive

Pull Requests (30d)
9
Issues (30d)
31
Star History
211 stars in the last 30 days

Explore Similar Projects

Feedback? Help us improve.