A Rust + GPUI note-taking app inspired by Logseq. It is not aiming at full Logseq parity — only the parts of logseq I use day-to-day. Uses GPUI for the GUI framework, the same one created for the Zed editor.
- Daily journal pages — an auto-created dated page as the default capture surface.
- Markdown editing with rendered preview — blocks render as formatted markdown when not focused, and switch to raw markdown on edit.
- Outliner / block-based editing — every line is a collapsible, nestable bullet block.
- Bidirectional page links & backlinks —
[[Page Name]]syntax auto-creates pages; each page shows references back to it. - No
#tags— use[[Page]]links instead. (No plan to support Logseq'skey:: valueproperty syntax either.) - Local-first plain-markdown storage — notes are saved as plain
.mdfiles on disk, syncable via Git, Dropbox, iCloud, or any other file sync.
Not currently planned (may be revisited later): graph view, query blocks, task states, flashcards, PDF annotation, whiteboards, and a plugin ecosystem.
Install or upgrade with either command (--git is required because GPUI is a git dependency, so the crate can't be published to crates.io):
# Prebuilt binary via cargo-binstall (https://github.com/cargo-bins/cargo-binstall).
# Covers aarch64-apple-darwin, x86_64-unknown-linux-gnu, aarch64-unknown-linux-gnu
# and x86_64-pc-windows-msvc; other targets fall back to building from source.
cargo binstall --git https://github.com/natemcintosh/gpui-notes gpui-notes
# Or build from source with plain cargo. Slow the first time, and needs the
# platform setup below. Add `--tag v<version>` to pin a release instead of main.
cargo install --locked --git https://github.com/natemcintosh/gpui-notes gpui-notesThe Linux binaries need:
- A Wayland session. Only GPUI's Wayland backend is compiled in by default, and under X11 the app starts with no window and no error message. For X11, use the
x11build (see below). - glibc 2.39 or newer (Ubuntu 24.04, Fedora 40, Debian 13 or later), because the binaries are built on Ubuntu 24.04. Older systems fail at launch with
GLIBC_2.39 not found; build from source there instead. - A Vulkan driver (
libvulkan.so.1plus Mesa's or your GPU vendor's driver), or EGL as a fallback. These are loaded at runtime, solddwon't list them. libxkbcommonandlibwayland-client, which any Wayland desktop already has.
Fonts are read straight from the system font directories, so the fontconfig library isn't needed at runtime.
X11 support is behind the x11 Cargo feature. cargo binstall always installs the default Wayland-only build, so either download the x11 build from the releases page (gpui-notes-<target>-x11-v<version>.tar.gz, for x86_64-unknown-linux-gnu and aarch64-unknown-linux-gnu) and put the gpui-notes binary on your PATH, or build from source:
cargo install --locked --features x11 --git https://github.com/natemcintosh/gpui-notes gpui-notesThat build includes both backends and picks one at startup: Wayland if WAYLAND_DISPLAY is set, otherwise X11 through DISPLAY. It also changes the requirements above:
libxcbandlibxkbcommon-x11are required in every session, Wayland included. The binary links them directly, so without them it won't start at all (error while loading shared libraries). Most desktops already have them.- Building needs their development packages:
libxcb1-devandlibxkbcommon-x11-devon Debian/Ubuntu,libxcb-develandlibxkbcommon-x11-develon Fedora.
X11 is community-supported. CI builds the x11 feature and runs the tests with it, but the tests are headless and never open an X11 window, and the maintainer runs Wayland, so X11-specific bugs (input methods, clipboard, scaling) may go unnoticed.
Upgrading replaces only the binary. Your notes and settings are kept, because neither is stored next to the binary.
Pages are stored as plain .md files in a notes root directory. The app picks the first of these that applies:
- the
GPUI_NOTES_ROOTenvironment variable (must be an absolute path); notes_rootinconfig.toml(absolute, or starting with~/), read by release builds only, so a barecargo runduring development never touches your real graph;gpui-notesin the per-user data directory (~/.local/share/gpui-noteson Linux,~/Library/Application Support/gpui-noteson macOS,%APPDATA%\gpui-noteson Windows), created empty on first run.
To point an installed copy at your Logseq graph, create config.toml:
# ~/.config/gpui-notes/config.toml (%APPDATA%\gpui-notes\config.toml on Windows)
notes_root = "~/logseq"The same directory also holds dictionary.txt, the words added with "Add to dictionary".
just release patch (or minor, major) bumps the version in Cargo.toml (e.g. 0.2.1 => 0.2.2), commits, tags v0.2.2 and pushes. Pushing the tag runs .github/workflows/release.yml, which creates the GitHub release and uploads one gpui-notes-<target>-v<version>.tar.gz (.zip on Windows) per target (plus a .sha256). Those names are what [package.metadata.binstall] in Cargo.toml expects, so change both together.
Building on macOS requires the full Xcode plus the Metal Toolchain — the Command Line Tools alone are not enough. gpui_macos invokes xcrun metal at build time to compile its shaders, and that compiler ships only inside Xcode.app, with the Metal Toolchain as an on-demand component.
One-time setup:
# 1. Install Xcode from the App Store, then:
sudo xcode-select -s /Applications/Xcode.app/Contents/Developer
sudo xcodebuild -license accept
sudo xcodebuild -runFirstLaunch
xcodebuild -downloadComponent MetalToolchainVerify with xcrun metal --version — you should see Apple metal version .... If you instead see unable to find utility "metal" or missing Metal Toolchain, one of the steps above hasn't completed.
Build natively with the MSVC Rust toolchain (stable-x86_64-pc-windows-msvc). You need the Visual Studio Build Tools ("Desktop development with C++") and a Windows 10/11 SDK: gpui_windows compiles its HLSL shaders with the SDK's fxc.exe at build time (override its location with GPUI_FXC_PATH). WSL is not recommended: WSLg has no hardware Vulkan driver, so GPUI falls back to slower rendering paths.
GPUI is not published to crates.io. We depend on it (and gpui_platform) directly from the zed-industries/zed repository. Because that repo is Zed's active development trunk, its API changes without warning — the scaffold emitted by create-gpui-app has already drifted from HEAD at least once (e.g. Application::new() was removed in favor of gpui_platform::application()).
To keep builds reproducible, we pin both crates to a specific rev in Cargo.toml. Rules of the road:
- Never depend on the floating
mainbranch. Always userev = "...". - Both
gpuiandgpui_platformmust share the samerev, or Cargo will pull two copies of the Zed workspace. gpui_platformis declared per-target so each OS gets the right backend features:runtime_shaders+font-kiton macOS,waylandon Linux/FreeBSD (plusx11through this crate's opt-inx11feature), none on Windows. Thefont-kitfeature is required on macOS — without itgpui_macosfalls back to aNoopTextSystemand text shapes but never paints (cursor still renders, so it looks like a styling bug).- To bump: pick a new commit from
zed-industries/zed, update bothrevvalues, runcargo update -p gpui -p gpui_platform, thencargo check. Expect to fix API breakage; check the relevant example inzed/crates/gpui/examples/for the current idiomatic usage. - Commit the resulting
Cargo.lockchange alongside theCargo.tomlbump.