compartment 3.4__tar.gz → 3.5__tar.gz

{compartment-3.4 → compartment-3.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: compartment
-Version: 3.4
+Version: 3.5
 Summary: Compartment - high-security, fully offline, encrypted vector memory for AI agents (MCP)
 Project-URL: Homepage, https://github.com/MaxFreedomPollard/Compartment
 Project-URL: Source, https://github.com/MaxFreedomPollard/Compartment
@@ -96,8 +96,9 @@ configuration step.
   key, no cloud account, no daemon.
 - On the Mac, open one `.pkg` and you are done. Python, the embedding model
   and every dependency are inside it.
-- A menu bar app runs the whole thing without a terminal: vault state,
-  unlock, lock, and the last five memories it saved.
+- An app runs the whole thing without a terminal on all three systems: vault
+  state, unlock, lock, and the last five memories it saved. The macOS menu
+  bar, the Windows notification area, a window on Linux.
 - Every feature toggles in that panel instead of a config file:
   model-independent capture, starter facts in search, auto-lock.
 - Your vault ships full. The 6,718 seeded facts are ordinary memories,
@@ -196,28 +197,29 @@ backed up first), it exits successfully no matter what - a memory tool must
 never break your editor - and it stays quiet when the vault is locked.
 `compartment hook status | install | uninstall`, or `integrate claude --no-hooks`.
 
-<p align="center">
-  <img src="https://raw.githubusercontent.com/MaxFreedomPollard/Compartment/main/docs/images/menubar-panel.png" width="330"
-       alt="The Compartment panel in the macOS menu bar.">
-  <img src="https://raw.githubusercontent.com/MaxFreedomPollard/Compartment/main/docs/images/windows-tray-panel.png" width="330"
-       alt="The Compartment panel in the Windows notification area.">
-</p>
-
-**A menu bar and system tray app, from the same one install.** `pip install
-compartment && compartment init` sets it up on macOS and on Windows: the app
-starts straight away and comes back at every login. There is no separate
-package, no extra to remember and no second command. On the Mac you can
-instead open **Compartment.pkg** from the
+**An app on all three systems, from the same one install.** `pip install
+compartment && compartment init` sets it up on macOS, Windows and Linux.
+There is no separate package, no extra to remember and no second command. On
+the Mac you can instead open **Compartment.pkg** from the
 [latest release](https://github.com/MaxFreedomPollard/Compartment/releases/latest),
 which carries Python and every dependency inside it, so there is nothing to
 install first. `compartment init --no-app` skips the app for headless boxes
-and CI. Either way it puts Compartment in the status bar: click the icon and a
-panel shows whether the vault is open, how much it has learned, the three
+and CI.
+
+The same panel, in the place each system keeps things like this: the **menu
+bar** on macOS, the **notification area** on Windows, and on **Linux** an
+ordinary window, with Compartment in your applications menu. Linux gets a
+window rather than an icon deliberately. Whether a tray icon appears there
+depends on the desktop, and on GNOME or Wayland it can simply never show up
+with nothing said, which is the worst way for the control that unlocks your
+memories to fail.
+
+The panel shows whether the vault is open, how much it has learned, the three
 settings worth changing day to day (capture hook, whether starter facts join
-searches, auto-lock), and the last five things it remembered. Unlock, lock and
-change your passphrase there too, without opening a terminal. No dock icon,
-no window to manage, and it holds no vault in memory - state comes from the
-CLI, so an idle app costs nothing.
+searches, auto-lock), which agents are connected and buttons to connect them,
+and the last five things it remembered. Unlock, lock and change your
+passphrase there too, without opening a terminal. It holds no vault in
+memory - state comes from the CLI, so an idle app costs nothing.
 
 **See what it just learned.** `compartment recent` lists the newest memories,
 newest last, hiding the thousands of seeded starting facts so the handful

{compartment-3.4 → compartment-3.5}/README.md

@@ -50,8 +50,9 @@ configuration step.
   key, no cloud account, no daemon.
 - On the Mac, open one `.pkg` and you are done. Python, the embedding model
   and every dependency are inside it.
-- A menu bar app runs the whole thing without a terminal: vault state,
-  unlock, lock, and the last five memories it saved.
+- An app runs the whole thing without a terminal on all three systems: vault
+  state, unlock, lock, and the last five memories it saved. The macOS menu
+  bar, the Windows notification area, a window on Linux.
 - Every feature toggles in that panel instead of a config file:
   model-independent capture, starter facts in search, auto-lock.
 - Your vault ships full. The 6,718 seeded facts are ordinary memories,
@@ -150,28 +151,29 @@ backed up first), it exits successfully no matter what - a memory tool must
 never break your editor - and it stays quiet when the vault is locked.
 `compartment hook status | install | uninstall`, or `integrate claude --no-hooks`.
 
-<p align="center">
-  <img src="https://raw.githubusercontent.com/MaxFreedomPollard/Compartment/main/docs/images/menubar-panel.png" width="330"
-       alt="The Compartment panel in the macOS menu bar.">
-  <img src="https://raw.githubusercontent.com/MaxFreedomPollard/Compartment/main/docs/images/windows-tray-panel.png" width="330"
-       alt="The Compartment panel in the Windows notification area.">
-</p>
-
-**A menu bar and system tray app, from the same one install.** `pip install
-compartment && compartment init` sets it up on macOS and on Windows: the app
-starts straight away and comes back at every login. There is no separate
-package, no extra to remember and no second command. On the Mac you can
-instead open **Compartment.pkg** from the
+**An app on all three systems, from the same one install.** `pip install
+compartment && compartment init` sets it up on macOS, Windows and Linux.
+There is no separate package, no extra to remember and no second command. On
+the Mac you can instead open **Compartment.pkg** from the
 [latest release](https://github.com/MaxFreedomPollard/Compartment/releases/latest),
 which carries Python and every dependency inside it, so there is nothing to
 install first. `compartment init --no-app` skips the app for headless boxes
-and CI. Either way it puts Compartment in the status bar: click the icon and a
-panel shows whether the vault is open, how much it has learned, the three
+and CI.
+
+The same panel, in the place each system keeps things like this: the **menu
+bar** on macOS, the **notification area** on Windows, and on **Linux** an
+ordinary window, with Compartment in your applications menu. Linux gets a
+window rather than an icon deliberately. Whether a tray icon appears there
+depends on the desktop, and on GNOME or Wayland it can simply never show up
+with nothing said, which is the worst way for the control that unlocks your
+memories to fail.
+
+The panel shows whether the vault is open, how much it has learned, the three
 settings worth changing day to day (capture hook, whether starter facts join
-searches, auto-lock), and the last five things it remembered. Unlock, lock and
-change your passphrase there too, without opening a terminal. No dock icon,
-no window to manage, and it holds no vault in memory - state comes from the
-CLI, so an idle app costs nothing.
+searches, auto-lock), which agents are connected and buttons to connect them,
+and the last five things it remembered. Unlock, lock and change your
+passphrase there too, without opening a terminal. It holds no vault in
+memory - state comes from the CLI, so an idle app costs nothing.
 
 **See what it just learned.** `compartment recent` lists the newest memories,
 newest last, hiding the thousands of seeded starting facts so the handful

{compartment-3.4 → compartment-3.5}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "compartment"
-version = "3.4"
+version = "3.5"
 description = "Compartment - high-security, fully offline, encrypted vector memory for AI agents (MCP)"
 readme = "README.md"
 requires-python = ">=3.11"
@@ -36,13 +36,13 @@ dependencies = [
     "tokenizers>=0.15",
     "numpy>=1.26",
     "mcp>=1.0",
-    # The status bar app ships with every install, on the platforms that have
-    # one. It is not an add-on: unlocking, locking and changing the passphrase
-    # are things people do through the icon, not through a terminal, so an
-    # install that only lays down a CLI is an incomplete install. The markers
-    # keep it honest - nothing macOS-only is fetched on Windows, nothing
-    # Windows-only on macOS, and Linux (which has no status bar app here)
-    # installs neither and compiles nothing.
+    # The app ships with every install. It is not an add-on: unlocking,
+    # locking and changing the passphrase are things people do through a
+    # panel, not through a terminal, so an install that only lays down a CLI
+    # is an incomplete install. The markers keep it honest - nothing
+    # macOS-only is fetched on Windows and nothing Windows-only on macOS.
+    # Linux needs neither: its panel is Tk, which is in the standard library,
+    # so nothing here is fetched and nothing is compiled there.
     "pyobjc-framework-Cocoa>=10.0; sys_platform == 'darwin'",
     "pystray>=0.19; sys_platform == 'win32'",
     "pillow>=10; sys_platform == 'win32'",

{compartment-3.4 → compartment-3.5}/src/compartment/__init__.py

@@ -1,6 +1,6 @@
 """Compartment - high-security, fully offline, encrypted vector memory for AI agents."""
 
-__version__ = "3.4"
+__version__ = "3.5"
 
 from . import offline_guard as _og
 

{compartment-3.4 → compartment-3.5}/src/compartment/cli.py

@@ -167,10 +167,10 @@ def cmd_init(args) -> None:
     st = v.status()
     v.save()
     if args.no_app:
-        print("  command-line only install (--no-app): no status bar app")
+        print("  command-line only install (--no-app): no app")
     elif _cli_only_requested():
-        print("  command-line only install: no status bar app, no login item")
-        print("  add it later with `compartment menubar --login on`")
+        print("  command-line only install: no app")
+        print("  add it later with `compartment panel --login on`")
     else:
         _start_status_bar_app(path)
     print(f"\nVault ready: {st['records']} records, projected RAM "
@@ -219,6 +219,32 @@ def _cli_only_requested(seconds: float = 5.0) -> bool:
         return False                     # never let this block an install
 
 
+def _linux_has_display() -> bool:
+    """Is there a desktop to draw on?
+
+    Most Linux installs of a memory server are headless: a box over SSH, a
+    container, a CI runner. Starting a window there fails, and an
+    applications menu entry on a machine with no applications menu is
+    litter. Neither is a broken install - it is a server, and the CLI and
+    the MCP server are the whole product on one."""
+    return bool(os.environ.get("DISPLAY")
+                or os.environ.get("WAYLAND_DISPLAY"))
+
+
+def _linux_gui_available() -> bool:
+    """Can this Python draw the panel?
+
+    tkinter is in the standard library but not in every Linux distribution's
+    Python package, and pip cannot install it. Checked here so an install
+    says so plainly, rather than a launcher entry that opens nothing.
+    """
+    try:
+        import tkinter                                # noqa: F401
+        return True
+    except Exception:                                 # noqa: BLE001
+        return False
+
+
 def _start_status_bar_app(vault: str) -> None:
     """Put the status bar app up now, and again at every login.
 
@@ -229,18 +255,36 @@ def _start_status_bar_app(vault: str) -> None:
     platform with no status bar still gets a perfectly good CLI and MCP
     server, so a failure here is reported and stepped over.
     """
-    if sys.platform not in ("darwin", "win32"):
-        return                                   # no status bar app here
     try:
         app = _tray_app()
     except Exception as exc:                     # noqa: BLE001
-        print(f"  status bar app unavailable ({exc}); the CLI is unaffected")
+        print(f"  app unavailable ({exc}); the CLI is unaffected")
+        return
+    linux = sys.platform not in ("darwin", "win32")
+    if linux and not _linux_has_display():
+        print("  headless machine (no DISPLAY): no panel and no menu entry.")
+        print("  The CLI and the MCP server are ready, and `compartment "
+              "dash` opens the vault in a browser.")
         return
     try:
         state = app.set_login(True)
-        print(f"  start at login: {state}")
+        # On Linux this is the applications menu entry. Nothing starts at
+        # login there: without a tray icon to sit quietly in, an app that
+        # started itself would just be a window in your face at every
+        # sign-in.
+        print(f"  {'applications menu entry' if linux else 'start at login'}"
+              f": {state}")
     except Exception as exc:                     # noqa: BLE001
-        print(f"  could not enable start at login ({exc})")
+        print(f"  could not register the app ({exc})")
+    if linux and not _linux_gui_available():
+        print("  the panel needs tkinter, which this Python does not have.")
+        print("  Quickest fix, a Python that includes it:")
+        print("    uv tool install compartment")
+        print("  or install your distribution's package (Debian/Ubuntu: "
+              "python3-tk, Fedora: python3-tkinter).")
+        print("  Everything else works now: the CLI, the MCP server, and "
+              "`compartment dash`.")
+        return
     try:
         exe = shutil.which("compartment")
         argv = ([exe, "--vault", vault, "menubar"] if exe else
@@ -253,12 +297,17 @@ def _start_status_bar_app(vault: str) -> None:
         else:
             kwargs["start_new_session"] = True            # outlive this shell
         subprocess.Popen(argv, **kwargs)
-        print("  status bar app started - look for the icon in your "
-              + ("menu bar" if sys.platform == "darwin"
-                 else "notification area"))
+        if sys.platform == "darwin":
+            print("  app started - look for the icon in your menu bar")
+        elif sys.platform == "win32":
+            print("  app started - look for the icon in your notification "
+                  "area")
+        else:
+            print("  app started - its window is open, and Compartment is "
+                  "in your applications menu")
     except Exception as exc:                     # noqa: BLE001
-        print(f"  could not start the status bar app ({exc}); run "
-              "`compartment menubar` yourself")
+        print(f"  could not start the app ({exc}); run "
+              "`compartment panel` yourself")
 
 
 def _install_kind() -> tuple[str, list[str]]:
@@ -314,17 +363,29 @@ def _restart_status_bar_app(vault: str) -> None:
 def cmd_uninstall(args) -> None:
     """Remove Compartment from this machine. The vault is KEPT unless asked."""
     print(f"Compartment {__version__} - uninstalling")
-    if sys.platform in ("darwin", "win32"):
+    try:
+        app = _tray_app()
         try:
-            app = _tray_app()
-            try:
-                app.quit_running()
-                print("  status bar app stopped")
-            except Exception:                            # noqa: BLE001
-                pass
-            print(f"  start at login: {app.set_login(False)}")
+            app.quit_running()
+            print("  app stopped")
+        except Exception:                                # noqa: BLE001
+            pass
+        linux = sys.platform not in ("darwin", "win32")
+        print(f"  {'applications menu entry' if linux else 'start at login'}"
+              f": {app.set_login(False)}")
+    except Exception as exc:                             # noqa: BLE001
+        print(f"  app: nothing to remove ({exc})")
+    if sys.platform == "darwin":
+        # Only the small bundle a pip install writes for its own login item.
+        # A .pkg install is left alone: that one was not ours to create and
+        # its receipt is what removes it.
+        try:
+            from .menubar import USER_APP_BUNDLE, _is_generated
+            if _is_generated(USER_APP_BUNDLE):
+                shutil.rmtree(USER_APP_BUNDLE, ignore_errors=True)
+                print(f"  removed {USER_APP_BUNDLE}")
         except Exception as exc:                         # noqa: BLE001
-            print(f"  status bar app: nothing to remove ({exc})")
+            print(f"  login bundle: {exc}")
     try:
         if claude_hooks.is_installed():
             claude_hooks.uninstall()
@@ -486,14 +547,20 @@ def cmd_recent(args) -> None:
 
 
 def _tray_app():
-    """The platform's front end: the macOS menu bar item, or the Windows tray
-    icon. Both are thin shells over the same data layer in `menubar`, so the
-    command is the same everywhere and only the widgets differ."""
-    if sys.platform == "win32":
-        from . import systray
-        return systray
-    from . import menubar
-    return menubar
+    """The platform's front end: the macOS menu bar item, the Windows tray
+    icon, or on Linux the same panel as an ordinary window. All three are
+    thin shells over the same data layer in `menubar`, so the command is the
+    same everywhere and only the widgets differ.
+
+    Linux gets a window rather than an icon on purpose. Whether a tray icon
+    appears there depends on the desktop, and on GNOME or Wayland it can
+    simply never show up with nothing said - which is the worst way for the
+    control that unlocks your memories to fail."""
+    if sys.platform == "darwin":
+        from . import menubar
+        return menubar
+    from . import systray
+    return systray
 
 
 def cmd_menubar(args) -> None:
@@ -1316,19 +1383,23 @@ def main(argv: list[str] | None = None) -> None:
     p.add_argument("--json", action="store_true")
     p.set_defaults(fn=cmd_recent)
 
-    p = sub.add_parser("menubar", aliases=["tray"],
-                       help="menu bar app on macOS, tray app on Windows "
-                            "(settings + recent memories)")
+    # One command, three front ends. "panel" is the name that is true on
+    # every platform, and the older names keep working.
+    p = sub.add_parser("menubar", aliases=["tray", "panel"],
+                       help="the app: menu bar on macOS, notification area "
+                            "on Windows, a window on Linux (unlock, "
+                            "settings, connect an agent, recent memories)")
     p.add_argument("--show", action="store_true",
-                   help="open the popover immediately on launch")
+                   help="open the panel immediately on launch")
     p.add_argument("--self-check", action="store_true",
-                   help="print what the popover would show, no window")
+                   help="print what the panel would show, no window")
     p.add_argument("--render", metavar="PNG",
-                   help="write the popover to a PNG and exit (macOS, UI check)")
+                   help="write the panel to a PNG and exit (macOS, UI check)")
     p.add_argument("--login", nargs="?", const="status",
                    choices=["on", "off", "status"],
                    help="start Compartment at login or sign-in (on/off), or "
-                        "show the state")
+                        "show the state. On Linux this is the applications "
+                        "menu entry, since there is no icon to start")
     p.set_defaults(fn=cmd_menubar)
 
     ph = sub.add_parser("hook", help="Claude Code capture hook (deterministic "