README.md

Logseq

A local-first, non-linear, outliner notebook for organizing and sharing your personal knowledge base.

Use it to organize your todo list, to write your journals, or to record your unique life.

Download our free Desktop app

Sponsor our contributors on Open Collective, Logseq will move to Stripe later!

Why Logseq?

Logseq is a platform for knowledge management and collaboration. It focuses on privacy, longevity, and user control.

The server will never store or analyze your private notes. Your data are plain text files and we currently support both Markdown and Emacs Org mode (more to be added soon).

In the unlikely event that the website is down or cannot be maintained, your data is, and will always be yours.

Sponsors

Our top sponsors are shown below! [Become a sponsor]

Plugins documentation (Draft)

The plugins documentation is at https://logseq.github.io/plugins. Any feedback would be greatly appreciated!

Feature requests

Please go to https://discuss.logseq.com/c/feature-requests/7.

How can I use it?

1. Download the desktop app at https://github.com/logseq/logseq/releases.
2. Start writing and have fun!

FAQ

Please go to https://docs.logseq.com/#/page/faq.

Credits

Logseq is hugely inspired by Roam Research, Org Mode, Tiddlywiki, Workflowy and Cuekeeper, hats off to all of them!

Logseq is also made possible by the following projects:

• Clojure & ClojureScript - A dynamic, functional, general-purpose programming language
• DataScript - Immutable database and Datalog query-engine for Clojure, ClojureScript and JS
• OCaml & Angstrom, for the document parser
• isomorphic-git - A pure JavaScript implementation of Git for node and browsers
• sci - Small Clojure Interpreter

Learn more

• Our blog: https://logseq.com/blog - Please be sure to visit our About page for the latest updates of the app
• Twitter: https://twitter.com/logseq
• Discord: https://discord.gg/KpN4eHY - Where we answer questions, discuss workflows and share tips
• 中文 Discord：https://discord.gg/xYqcrXWymg
• Github: https://github.com/logseq/logseq - everyone is encouraged to report issues!

---

The following is for developers and designers who want to build and run Logseq locally and contribute to this project.

We also have a dedicated page for LogSeq's codebase overview.

Set up development environment

1. Requirements

• Node.js (See build.yml for allowed version) & Yarn
• Java & Clojure. (If you run into Execution error (FileNotFoundException) at java.io.FileInputStream/open0 (FileInputStream.java:-2). -M:cljs (No such file or directory), it means you have a wrong Clojure version installed. Please uninstall it and follow the instructions linked.)

2. Compile to JavaScript

git clone https://github.com/logseq/logseq
cd logseq
yarn
yarn watch

3. Open the browser

Open http://localhost:3001.

4. Build a release

yarn release

5. Run tests

Run ClojureScript tests

yarn test

Run E2E tests

yarn electron-watch
# in another shell
yarn e2e-test # or npx playwright test

Desktop app development

1. Compile to JavaScript

yarn watch

2. Install npm packages for building the desktop app

cd static && yarn install && cd ..

3. Open the dev app

yarn dev-electron-app

4. Build a release

yarn release-electron

Thanks