obsidian-plugin/powderfirm-ship-it_obsidian-headless-mode
1
0
Fork 0
mirror of https://github.com/powderfirm-ship-it/obsidian-headless-mode.git synced 2026-07-22 07:43:51 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
7 commits 1 branch 6 tags 48 KiB
TypeScript 93.4%
JavaScript 6.6%
Find a file
Malik Townsend e6913c4afe feat: add Buy Me a Coffee funding link (manifest + tray menu); release 1.4.2
2026-06-23 10:42:02 -07:00
.gitignore Headless Mode v1.0.0 — run Obsidian from the menu bar tray, hidden from the Dock 2026-06-12 00:35:10 -07:00
esbuild.config.mjs fix: address Obsidian community plugin review failures 2026-06-12 01:10:35 -07:00
LICENSE Headless Mode v1.0.0 — run Obsidian from the menu bar tray, hidden from the Dock 2026-06-12 00:35:10 -07:00
main.ts feat: add Buy Me a Coffee funding link (manifest + tray menu); release 1.4.2 2026-06-23 10:42:02 -07:00
manifest.json feat: add Buy Me a Coffee funding link (manifest + tray menu); release 1.4.2 2026-06-23 10:42:02 -07:00
package-lock.json feat: add Buy Me a Coffee funding link (manifest + tray menu); release 1.4.2 2026-06-23 10:42:02 -07:00
package.json feat: add Buy Me a Coffee funding link (manifest + tray menu); release 1.4.2 2026-06-23 10:42:02 -07:00
README.md feat: prep for Obsidian community-plugins submission 2026-06-12 00:51:38 -07:00
tsconfig.json Headless Mode v1.0.0 — run Obsidian from the menu bar tray, hidden from the Dock 2026-06-12 00:35:10 -07:00
versions.json feat: add Buy Me a Coffee funding link (manifest + tray menu); release 1.4.2 2026-06-23 10:42:02 -07:00

README.md

Headless Mode

An Obsidian plugin by Meirakami.

Run Obsidian headless: every window hidden, the app removed from the macOS Dock, alive only as a menu bar (tray) icon — until you uncheck Headless from the icon's menu.

Useful when Obsidian is doing background work (sync, automations, plugins that watch the vault) and you don't want it taking up the Dock or window switcher.

How it works

A gem-shaped icon is added to the menu bar (system tray on Windows/Linux). Clicking it opens a menu:

  • Headless (checkbox) — when checked, all Obsidian windows hide and the Dock icon disappears (macOS). Obsidian keeps running. Uncheck to bring the window and Dock icon back.
  • Open Obsidian — shortcut to exit headless mode.
  • Quit Obsidian — fully quits the app.

There are also command palette entries: Toggle headless mode and Go headless.

Settings

  • Start headless — launch Obsidian directly into headless mode.
  • Hide Dock icon while headless (macOS) — on by default; turn off if you want the window hidden but the Dock icon kept.
  • Menu bar icon color — White (default), Black, or Auto. White/Black force an explicit fill; Auto uses a macOS template image that the system tints to match the menu bar.

Cutting a release (maintainer)

  1. Bump version in manifest.json (and versions.json / package.json), commit, push.
  2. npm run build
  3. gh release create <version> main.js manifest.json --title "<version>" — the tag must be the bare semver (no v prefix).

Install (manual)

  1. Build: npm install && npm run build
  2. Copy main.js and manifest.json into <your-vault>/.obsidian/plugins/headless-mode/
  3. Reload Obsidian, then enable Headless Mode under Settings → Community plugins.

Notes

  • Desktop only (isDesktopOnly: true). Dock hiding is macOS-only; on Windows/Linux the tray toggle still hides/shows windows.
  • The plugin always restores the window and Dock icon when it unloads, so disabling it can never strand a hidden app.
  • Quitting from the tray is the reliable way to quit while headless; with the Dock icon hidden there's nothing else to click.