{"id":13393437,"url":"https://github.com/org-roam/org-roam","last_synced_at":"2026-01-27T00:37:09.693Z","repository":{"id":37240709,"uuid":"231891986","full_name":"org-roam/org-roam","owner":"org-roam","description":"Rudimentary Roam replica with Org-mode","archived":false,"fork":false,"pushed_at":"2026-01-01T21:23:06.000Z","size":42158,"stargazers_count":5874,"open_issues_count":96,"forks_count":493,"subscribers_count":93,"default_branch":"main","last_synced_at":"2026-01-01T22:47:44.600Z","etag":null,"topics":["hacktoberfest","memex","org-mode","pkm","roam","zettelkasten"],"latest_commit_sha":null,"homepage":"https://www.orgroam.com","language":"Emacs Lisp","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/org-roam.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":["jethrokuan"],"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2020-01-05T09:00:15.000Z","updated_at":"2026-01-01T11:34:13.000Z","dependencies_parsed_at":"2023-02-09T16:15:27.646Z","dependency_job_id":"6d9cd13c-db17-42ef-aab3-aab9ef3f35e2","html_url":"https://github.com/org-roam/org-roam","commit_stats":null,"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"purl":"pkg:github/org-roam/org-roam","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/org-roam%2Forg-roam","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/org-roam%2Forg-roam/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/org-roam%2Forg-roam/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/org-roam%2Forg-roam/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/org-roam","download_url":"https://codeload.github.com/org-roam/org-roam/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/org-roam%2Forg-roam/sbom","scorecard":{"id":712106,"data":{"date":"2025-08-11","repo":{"name":"github.com/org-roam/org-roam","commit":"89dfaef38b6caa3027f20f96a551dc8f194ac533"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":5.3,"checks":[{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Code-Review","score":5,"reason":"Found 12/24 approved changesets -- score normalized to 5","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Maintained","score":10,"reason":"12 commit(s) and 12 issue activity found in the last 90 days -- score normalized to 10","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/docs.yml:1","Warn: no topLevel permission defined: .github/workflows/test.yml:1","Warn: no topLevel permission defined: .github/workflows/tidy-issues.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: GNU General Public License v3.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docs.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/org-roam/org-roam/docs.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/docs.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/org-roam/org-roam/docs.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yml:46: update your workflow using https://app.stepsecurity.io/secureworkflow/org-roam/org-roam/test.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:50: update your workflow using https://app.stepsecurity.io/secureworkflow/org-roam/org-roam/test.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/tidy-issues.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/org-roam/org-roam/tidy-issues.yml/main?enable=pin","Warn: downloadThenRun not pinned by hash: .github/workflows/test.yml:54","Info:   0 out of   3 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   2 third-party GitHubAction dependencies pinned","Info:   0 out of   1 downloadThenRun dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 20 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-22T08:26:39.402Z","repository_id":37240709,"created_at":"2025-08-22T08:26:39.402Z","updated_at":"2025-08-22T08:26:39.402Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28793840,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-26T21:49:50.245Z","status":"ssl_error","status_checked_at":"2026-01-26T21:48:29.455Z","response_time":59,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["hacktoberfest","memex","org-mode","pkm","roam","zettelkasten"],"created_at":"2024-07-30T17:00:52.743Z","updated_at":"2026-01-27T00:37:09.680Z","avatar_url":"https://github.com/org-roam.png","language":"Emacs Lisp","funding_links":["https://github.com/sponsors/jethrokuan"],"categories":["Emacs Lisp","Knowledge Management","hacktoberfest","Personal Knowledge Management","知识管理_wiki知识库","Platforms, Applications and Tools"],"sub_categories":["资源传输下载"],"readme":"# Org-roam [![GitHub Release][release-badge]][release] [![MELPA][melpa-badge]][melpa] [![License GPL 3][gpl3-badge]][gpl3]\n\n\u003cimg src=\"https://www.orgroam.com/img/logo.svg\" align=\"right\" alt=\"Org-roam Logo\" width=\"240\"\u003e\n\nOrg-roam is a plain-text knowledge management system. It brings some of\n[Roam's][roamresearch] more powerful features into the [Org-mode][org]\necosystem.\n\nOrg-roam borrows principles from the Zettelkasten method, providing a solution\nfor non-hierarchical note-taking. It should also work as a plug-and-play\nsolution for anyone already using Org-mode for their personal wiki.\n\n- **Private and Secure**: Edit your personal wiki completely offline, entirely\n  in your control. Encrypt your notes with GPG. Take lasting notes in\n  plain-text.\n- **Networked Thought**: Connect notes and thoughts together with ease using\n  backlinks. Discover surprising and previously unseen connections in your notes\n  with the built-in graph visualization.\n- **Extensible and Powerful**: Leverage Emacs' fantastic text-editing interface,\n  and the mature Emacs and Org-mode ecosystem of packages.\n- **Free and Open Source**: Org-roam is licensed under the GNU General Public\n  License version 3 or later.\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://www.orgroam.com/img/screenshot.png\" alt=\"Org-roam Screenshot\" width=\"738\"\u003e\n\u003c/p\u003e\n\n- **[Documentation][docs]**\n- **[Discourse][discourse]**\n- **[Slack][slack]**\n- **[Frequently Asked Questions][faq]**\n- **[Changelog](CHANGELOG.md)**\n\n## Installation\n\nDown below you will find basic installation instructions for how to quickly\ninstall `org-roam` using various environments for various purposes. For more\ndetailed information, please read the [manual][docs].\n\n### Using `package.el`\n\u003cdetails\u003e\n\u003csummary\u003eToggle instructions\u003c/summary\u003e\n\nYou can install `org-roam` from [MELPA](https://melpa.org/) or [MELPA\nStable](https://stable.melpa.org/) using `package.el`:\n\n```\nM-x package-install RET org-roam RET\n```\n\u003c/details\u003e\n\n### Using `straight.el`\n\u003cdetails\u003e\n\u003csummary\u003eToggle instructions\u003c/summary\u003e\n\nInstallation from MELPA or MELPA Stable using `straight.el`:\n\n```emacs-lisp\n(straight-use-package 'org-roam)\n```\n\nOr with `use-package`:\n\n```emacs-lisp\n(use-package org-roam\n  :straight t\n  ...)\n```\n\nIf you need to install the package directly from the source repository, instead\nof from MELPA, the next sample shows how to do so:\n\n```emacs-lisp\n(use-package org-roam\n  :straight (:host github :repo \"org-roam/org-roam\"\n             :files (:defaults \"extensions/*\"))\n  ...)\n```\n\nIf you plan to use your own local fork for the development and contribution, the\nnext sample will get you there:\n\n```emacs-lisp\n(use-package org-roam\n  :straight (:local-repo \"/path/to/org-roam-fork\"\n             :files (:defaults \"extensions/*\")\n             :build (:not compile))\n  ...)\n```\n\u003c/details\u003e\n\n### Using Doom Emacs\n\u003cdetails\u003e\n\u003csummary\u003eToggle instructions\u003c/summary\u003e\n\nDoom's `:lang org` module comes with support for `org-roam`, but it's not\nenabled by default. To activate it pass `+roam2` flag to `org` module in your\n`$DOOMDIR/init.el` (e.g. `(org +roam2)`), save the file and run `doom sync -u`\nin your shell.\n\nTo provide better stability, Doom pins the package to a specific commit. If you\nneed to unpin it *(not recommended doing that, request Doom to bump the package\ninstead)* use the next in your `packages.el`:\n\n```emacs-lisp\n(unpin! org-roam)\n```\n\nIf for some reasons you want to use a different recipe for `org-roam`, you can\nuse the next form in your `packages.el` to install the package from a recipe\nrepository (e.g. MELPA):\n\n```emacs-lisp\n(package! org-roam)\n```\n\nYou can pass `:pin \"commit hash\"` to pin the package to a specific commit.\n\nWith the next sample you can install the package directly from the source\nrepository:\n\n```emacs-lisp\n(package! org-roam\n  :recipe (:host github :repo \"org-roam/org-roam\"\n           :files (:defaults \"extensions/*\")))\n```\n\nAnd if you plan to use your own local fork for the development or contribution,\nthe next sample will get you there:\n\n```emacs-lisp\n(package! org-roam\n  :recipe (:local-repo \"/path/to/org-roam-fork\"\n           :files (:defaults \"extensions/*\")\n           :build (:not compile)))\n```\n\u003c/details\u003e\n\n### Without a package manager\n\u003cdetails\u003e\n\u003csummary\u003eToggle instructions\u003c/summary\u003e\n\nTo install the package without using a package manager you have the next two\noptions:\n\n1. Install the package by cloning it with `git` from the source repository.\n2. Or install the package by downloading the latest [release\n   version](https://github.com/org-roam/org-roam/releases).\n   \nIn both of the cases you will need to ensure that you have all the required\ndependencies. These include:\n\n- dash\n- org (9.6 is the minimum required version!)\n- emacsql\n- magit-section\n\nAfter installing the package, you will need to properly setup `load-path` to the\npackage:\n\n``` emacs-lisp\n(add-to-list 'load-path \"/path/to/org-roam/\")\n(add-to-list 'load-path \"/path/to-org-roam/extensions/\")\n```\n\nAfter which you should be able to resolve `(require 'org-roam)` call without any\nproblems.\n\nOrg-roam also comes with `.texi` files to integrate with Emacs' built-in Info\nsystem. Read the manual to find more details for how to install them manually.\n\u003c/details\u003e\n\n## Configuration\n\nHere's a very basic sample for configuration of `org-roam` using `use-package`:\n\n```emacs-lisp\n(use-package org-roam\n  :ensure t\n  :custom\n  (org-roam-directory (file-truename \"/path/to/org-files/\"))\n  :bind ((\"C-c n l\" . org-roam-buffer-toggle)\n         (\"C-c n f\" . org-roam-node-find)\n         (\"C-c n g\" . org-roam-graph)\n         (\"C-c n i\" . org-roam-node-insert)\n         (\"C-c n c\" . org-roam-capture)\n         ;; Dailies\n         (\"C-c n j\" . org-roam-dailies-capture-today))\n  :config\n  ;; If you're using a vertical completion framework, you might want a more informative completion interface\n  (setq org-roam-node-display-template (concat \"${title:*} \" (propertize \"${tags:10}\" 'face 'org-tag)))\n  (org-roam-db-autosync-mode)\n  ;; If using org-roam-protocol\n  (require 'org-roam-protocol))\n```\n\nNote that the `file-truename` function is only necessary when you use symbolic\nlink to `org-roam-directory`. Org-roam won't automatically resolve symbolic link\nto the directory.\n## Getting Started\n\n[David Wilson](https://github.com/daviwil) of [System\nCrafters](https://www.youtube.com/c/SystemCrafters) has produced an introductory\nvideo that covers the basic commands:\n\n[![Getting Started with Org Roam - Build a Second Brain in Emacs](https://img.youtube.com/vi/AyhPmypHDEw/0.jpg)](https://www.youtube.com/watch?v=AyhPmypHDEw)\n\n## Getting Help\n\nBefore creating a new topic/issue, please be mindful of our time and ensure that\nit has not already been addressed on [GitHub][issues] or on\n[Discourse][discourse].\n\n- If you are new to Emacs and have problem setting up Org-roam, please ask your\n  question on [Slack, channel #how-do-i][slack].\n- For quick questions, please ask them on [Slack, channel\n  #troubleshooting][slack].\n- If something is not working as it should, or if you would like to suggest a\n  new feature, please [create a new issue][issues].\n- If you have questions about your workflow with the slip-box method, please\n  find a relevant topic on [Discourse][discourse], or create a new one.\n\n## Knowledge Bases using Org-roam\n\n- [Jethro Kuan](https://braindump.jethro.dev/)\n  ([Source](https://github.com/jethrokuan/braindump/tree/master/org))\n- [Alexey Shmalko](https://www.alexeyshmalko.com/)\n- [Sidharth Arya](https://sidhartharya.github.io/braindump/index.html)\n- [Martin Edström](https://edstrom.dev/)\n\n## Contributing\n\nTo report bugs and suggest new feature use the issue tracker. If you\nhave some code which you would like to be merged, then open a pull\nrequest. Please also see [CONTRIBUTING.md](.github/CONTRIBUTING.md).\n\n## License\n\nCopyright © Jethro Kuan and contributors. Distributed under the GNU\nGeneral Public License, Version 3.\n\n[roamresearch]: https://www.roamresearch.com/\n[org]: https://orgmode.org/\n[gpl3-badge]: https://img.shields.io/badge/license-GPL_3-green.svg\n[gpl3]: http://www.gnu.org/licenses/gpl-3.0.txt\n[melpa-badge]: https://melpa.org/packages/org-roam-badge.svg\n[melpa]: https://melpa.org/#/org-roam\n[release-badge]: https://img.shields.io/github/v/release/org-roam/org-roam\n[release]: https://github.com/org-roam/org-roam/releases\n[docs]: https://www.orgroam.com/manual.html\n[discourse]: https://org-roam.discourse.group/\n[slack]: https://join.slack.com/t/orgroam/shared_invite/zt-wuoize1z-x3UyQnQ0WHF0RhuEQ2NLnQ\n[issues]: https://github.com/org-roam/org-roam/issues\n[faq]: https://www.orgroam.com/manual.html#FAQ\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Forg-roam%2Forg-roam","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Forg-roam%2Forg-roam","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Forg-roam%2Forg-roam/lists"}