{"id":13471377,"url":"https://github.com/silverbulletmd/silverbullet","last_synced_at":"2026-10-18T23:10:37.218Z","repository":{"id":41098347,"uuid":"459944886","full_name":"silverbulletmd/silverbullet","owner":"silverbulletmd","description":"The malleable knowledge base for you and your team. Powered by Markdown and Lua.","archived":false,"fork":false,"pushed_at":"2026-10-18T09:22:53.000Z","size":70880,"stargazers_count":6347,"open_issues_count":363,"forks_count":516,"subscribers_count":25,"default_branch":"main","last_synced_at":"2026-10-18T20:27:59.301Z","etag":null,"topics":["end-user-programming","knowledge-management","lua","markdown","note-taking","personal-knowledge-management"],"latest_commit_sha":null,"homepage":"https://silverbullet.md","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/silverbulletmd.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"docs/Security Profiles.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"claude":null,"gemini":null,"cursor":null,"copilot":null,"dco":null,"cla":null,"disclosure":null},"funding":{"github":"silverbulletmd","liberapay":"zef","patreon":"silverbulletmd","custom":"https://paypal.me/zefhemel"}},"created_at":"2022-02-16T09:56:34.000Z","updated_at":"2026-10-18T19:43:40.000Z","dependencies_parsed_at":"2026-10-01T15:38:50.522Z","dependency_job_id":null,"html_url":"https://github.com/silverbulletmd/silverbullet","commit_stats":{"total_commits":704,"total_committers":25,"mean_commits":28.16,"dds":"0.10653409090909094","last_synced_commit":"eb731244816571acd5908d44eb67e6baf3b13938"},"previous_names":[],"tags_count":119,"template":false,"template_full_name":null,"purl":"pkg:github/silverbulletmd/silverbullet","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/silverbulletmd%2Fsilverbullet","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/silverbulletmd%2Fsilverbullet/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/silverbulletmd%2Fsilverbullet/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/silverbulletmd%2Fsilverbullet/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/silverbulletmd","download_url":"https://codeload.github.com/silverbulletmd/silverbullet/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/silverbulletmd%2Fsilverbullet/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":344872684,"owners_count":38343411,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-10-03T21:59:58.778Z","status":"online","status_checked_at":"2026-10-18T02:00:06.448Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["end-user-programming","knowledge-management","lua","markdown","note-taking","personal-knowledge-management"],"created_at":"2024-07-31T16:00:43.922Z","updated_at":"2026-10-18T23:10:37.208Z","avatar_url":"https://github.com/silverbulletmd.png","language":"TypeScript","funding_links":["https://github.com/sponsors/silverbulletmd","https://liberapay.com/zef","https://patreon.com/silverbulletmd","https://paypal.me/zefhemel"],"categories":["TypeScript","Table of Contents","lua","note-taking","markdown","Open Source"],"sub_categories":["Note Taking","Web UI"],"readme":"![GitHub Repo stars](https://img.shields.io/github/stars/silverbulletmd/silverbullet)\n![Docker Pulls](https://img.shields.io/docker/pulls/zefhemel/silverbullet)\n![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/silverbulletmd/silverbullet/total)\n![GitHub contributors](https://img.shields.io/github/contributors/silverbulletmd/silverbullet)\n[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/silverbulletmd/silverbullet)\n\n# SilverBullet\nSilverBullet is a Programmable, Private, Browser-based, Open Source, Self Hosted, Personal Knowledge Database — a fancy term for a \"notes app on steroids\".\n\n_Yowza!_ That surely is a lot of adjectives to describe a browser-based Markdown editor programmable with Lua.\n\nLet’s get more specific.\n\nSilverBullet combines a clean live-preview editor with wiki-style linking, a built-in database and query language, and a fully integrated Space Lua scripting environment, turning your notes into a programmable system that grows with you.\n\nIn SilverBullet you keep your content as a collection of Markdown Pages (called a Space). You navigate your space using the Page Picker like a traditional notes app, or through Links like a wiki (except they are bi-directional).\n\nIf you are the **writer** type, you’ll appreciate SilverBullet as a clean Markdown editor with Live Preview. If you have more of an **outliner** personality, SilverBullet has Outlining tools for you. Productivity freak? Have a look at Tasks. More of a **database** person? You will appreciate Objects and Queries (SLIQ). \n\nAnd if you are comfortable **programming** a little bit — now we’re really talking. You will love _dynamically generating content_ with Space Lua (SilverBullet’s Lua dialect), or to use it to create custom Commands, Page Templates or Widgets.\n\nYou were told there’s no such thing as a silver bullet. You were told wrong.\n\n[Much more detail can be found on silverbullet.md](https://silverbullet.md)\n\n## Installing SilverBullet\nCheck out the [instructions](https://docs.silverbullet.md/Install).\n\n## Developing SilverBullet\nSilverBullet's frontend (\"client\") is written in [TypeScript](https://www.typescriptlang.org/) and built on top of the excellent [CodeMirror 6](https://codemirror.net/) editor component. Additional UI is built using [Preact](https://preactjs.com). [ESBuild](https://esbuild.github.io) is used to build the frontend.\n\nThe server backend is written in [Rust](https://www.rust-lang.org/) (a Cargo workspace). It serves the pre-built client bundle, the file/space HTTP API, authentication, and a headless-Chrome runtime for server-side Lua.\n\n## Code structure\n* `bin/silverbullet/`: The standalone `silverbullet` server binary (Rust) (this is the one you generally run)\n* `bin/sb/`: The `sb` CLI client (Rust)\n* `bin/plug-compile.ts`: the plug compiler\n* `client/`: The SilverBullet client (browser, TypeScript)\n* `server/`: The SilverBullet server library (Rust): HTTP router, handlers, auth, runtime seam\n* `server-common/`: Shared Rust crate (space primitives, shared types)\n* `server-runtime-chrome/`: Headless-Chrome runtime backend (Rust)\n* `plugs`: Set of built-in plugs (TypeScript) that are distributed with SilverBullet\n* `libraries`: A set of libraries (space scripts, page templates, slash templates) distributed with SilverBullet (Space Lua)\n* `plug-api/`: Useful APIs for use in plugs and published to NPM\n  * `lib/`: Useful libraries to be used in plugs\n  * `syscalls/`: TypeScript wrappers around syscalls\n  * `types/`: Various (client) types that can be references from plugs\n* `scripts/`: Useful scripts\n* `docs/`: documentation (published as docs.silverbullet.md and bundled as Desktop's Help)\n\n### Requirements\n* [Node.js](https://nodejs.org/) 24+ and npm 10+: Used to build the frontend (client) and plugs\n* [Rust](https://www.rust-lang.org/tools/install) (stable, via `rustup`): Used to build the server\n\nThe project includes `.nvmrc` and `.node-version` files. If you use [nvm](https://github.com/nvm-sh/nvm) or another Node version manager, it will automatically use the correct Node.js version:\n\n```shell\nnvm use  # If using nvm\n```\n\nFirst, install dependencies:\n\n```shell\nmake setup\n```\n\nTo create a (release) build:\n\n```shell\nmake\n```\n\nThis will produce `silverbullet` and `cli` binaries in `./target/release/`, run `./target/release/silverbullet` to run the server.\n\n### Development workflow\n\nSilverBullet has two halves you rebuild **independently**:\n\n* The **client** (TypeScript: `client/`) is built by ESBuild into `client_bundle/`, which the server then serves.\n* The **server** (Rust: `server/`, `server-common/`, `server-runtime-chrome/`, `bin/silverbullet/`) is a compiled binary.\n\nRun the server in development with `cargo run`. A **debug** build serves the client bundle **live from `client_bundle/` on disk** (a release build embeds it instead):\n\n```shell\nnpm run build\ncargo run \u003cPATH-TO-YOUR-DATA-FOLDER\u003e\n```\n\n**When you change only the client** (TypeScript in `client/`): you do **not** need to restart the server. Rebuild just the client bundle and reload the page in your browser — the debug server serves the freshly-built bundle straight from disk:\n\n```shell\nnpm run build\n```\n\nTo build a self-contained **release** binary (with the client bundle embedded), and run it:\n\n```shell\nmake\n./target/release/silverbullet \u003cPATH-TO-YOUR-DATA-FOLDER\u003e\n```\n\n### Useful development tasks\n\n```shell\n# Clean all generated files\nmake clean\n# Typecheck and lint all code\nmake check\n# Format all code\nmake fmt\n# Run all tests\nmake test\n# Run benchmarks\nmake bench\n```\n\n### Build a docker container\nNote, you do not need Node.js nor Rust locally installed for this to work:\n\n```shell\ndocker build -t silverbullet .\n```\n\nTo run:\n```shell\ndocker run -p 3000:3000 -v \u003cPATH-TO-YOUR-DATA-FOLDER\u003e:/data silverbullet\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsilverbulletmd%2Fsilverbullet","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsilverbulletmd%2Fsilverbullet","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsilverbulletmd%2Fsilverbullet/lists"}