Skip to content

Latest commit

 

History

1 Commit

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

peek-bridge

A free Obsidian community plugin. Pairs locally with the Peek desktop app to create Markdown stickies that stay on screen even when Obsidian is closed.

This plugin itself is completely free and open source. The Peek desktop app is a separate, paid ($19 one-time) standalone executable and is not included in this repository.

What this plugin does

  • Lists, creates, and opens Peek sticky Markdown notes inside your vault's sticker folder (configurable, defaults to peek-stickers).
  • If the Peek desktop app is installed and not already running, launches it as a local helper process — no arguments, no shell interpretation.
  • Writes a small marker file so the Peek desktop app knows to surface its sticky windows; reads a small presence file that Peek desktop writes back, purely to show an "on desktop" badge and detect orphaned/untracked stickies. Never writes to that presence file.

What this plugin does not do

See SECURITY.md for the full, code-verified security invariants (no remote communication, no dynamic code execution, and exactly what local filesystem/process access this plugin performs and why).

Install

Search "peek-bridge" in Obsidian's Community Plugins browser and install (or clone this repository directly into .obsidian/plugins/peek-bridge).

Peek desktop app

This plugin installs and runs without the Peek desktop app, but its real functionality (window-pinning stickies, stickies that survive Obsidian being closed) requires the Peek app. Peek: https://capernaum-user.github.io/peek/

License

MIT — see LICENSE.

Security

Security-relevant behavior (IPC surface, local process launch, what this plugin can and cannot touch) is documented in SECURITY.md. Report security concerns via issues.

About

Free, MIT Obsidian community plugin for the Peek desktop sticky app - no network access, no dynamic code execution (see SECURITY.md).

Topics

Resources

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages