Hyperclay Local
  1. Hyperclay Local
  2. Docs
  3. The app
  4. Popover and tray

Popover and tray

Control serving, cloud sync, folder actions, notices, and options from the Hyperclay Local tray icon and popover.

Hyperclay Local runs in your system tray. Left-clicking the tray icon opens the popover panel (340x500 px), and right-clicking opens the system tray menu. Closing the workspace window hides the window (and hides the dock icon on macOS) while the app continues running in the tray.

The tray popover#

Home view and folder cards#

The popover’s Home view adapts to the number of folders you have configured:

  • Single folder: Shows a hero card for your personal folder with its localhost:4321 address link, status readout, and an Open workspace button.
  • Multiple folders: Shows an Open workspace button at the top, a FOLDERS list with one card per folder (switching to compact rows when you have more than 4 folders), and a THIS COMPUTER status section.

Each folder card shows its name, local address (localhost:<port>, starts at :<port> when stopped, or a grey localhost:<port> when the port is taken), and its current sync or serve status (see Status messages explained).

  • Clicking Open workspace or clicking a folder’s live localhost:<port> address starts that folder’s server if needed and opens it in the workspace window.
  • A team you can edit on hyperclay.com that is not yet on your computer appears as not on this computer with a Set up → action.
  • A team where your role is viewer appears dimmed with viewers use the site and a hyperclay.com ↗ (Open on hyperclay.com) link.

Serve and Sync switches#

Above the popover footer, two switches control all folders on your computer:

  • Serve (Turn server on / Turn server off): Starts or stops the local HTTP servers for all folders. The readout shows Serving (at localhost:<port> or <n> folders on this computer), Starting…, Not serving (Turn on to open your documents), or Can't serve.
  • Sync: Starts or stops cloud sync across all folders. When no API key is saved, the switch is replaced by Connect sync → (Not synced / Only on this computer). With a key saved, it shows Sync off (Changes stay on this computer) or Sync on / Syncing / Synced as @<username>.

Banners#

When an account-wide issue or an app update needs attention, a banner plate appears at the top of the Home view:

  • Sync key no longer works. with a Reconnect → button that opens the sync key form.
  • hyperclay.com needs an update before sync can run. Folders are still served.
  • Restart to update to v<version> when an in-place update is ready (changing to Finishing sync… while saves and sync finish), or Update v<version> available (linking to https://hyperclaylocal.com/) when the app copy cannot replace itself. See Updates.

Folder ⋯ menu#

Click ⋯ on a folder card to open its actions menu:

  • Open in Browser: Opens http://localhost:<port> in your default browser.
  • Copy Address: Copies http://localhost:<port> to the clipboard.
  • Reveal Folder: Opens the folder in Finder or your system file manager.
  • Backups: Opens <folder>/.hyperclay/versions/ in your file manager, creating the directory first if it does not exist yet.
  • Export a File as Zip…: Prompts you to pick an .html, .htm, or .htmlclay file in that folder and packages it with its linked uploads into a .zip file (see Export as zip).
  • Disconnect…: Offered on synced folders. Stops sync for that folder while keeping the folder on your computer and served on localhost:<port>.
  • Remove Folder…: Offered on team folders. Stops sync and stops serving localhost:<port>, leaving the folder and its files on disk. (Your personal folder cannot be removed; change it from Options then Change Personal Folder….)

When another program is using a folder’s port, the card also shows inline Retry and (for team folders) Use port <n>… buttons. When a folder is paused, it shows an inline Disconnect… button unless an account-wide banner is active.

Notices and Activity tabs#

  • Notices (the bell icon, showing an unread badge up to 9+): Lists sync conflicts with Keep mine, Keep theirs, and Keep both buttons; held mass attachment deletions with Delete on server and Restore here; attachments that exceed your plan’s file-size limit with Show File; and filename or folder-depth validation errors. Shows All quiet when empty.
  • Activity: Shows a combined feed of recent file uploads, downloads, and deletions across all folders. Shows Transfers show up here when empty.

The Options menu#

Click Options in the popover footer to open the options menu:

  • Change Personal Folder…: Opens the folder picker to move your personal root (served on port 4321) to another folder inside your home directory.
  • AI Editing: Checkbox (checked by default) that turns in-page AI editing on or off.
  • Helper Programs: Submenu listing approved document helper programs with Remove per program and Forget All Document Permissions.
  • Profile…: Opens the profile view with the Use my profile in files switch, your Hyperclay account profile (Change name on Hyperclay, Refresh profile) or local Display name field (Save name), and Done. See Settings and profile.
  • Sync Key…: Opens the sync key dialog (Username, API Key, Connect & Enable Sync, Cancel, and Get API key).
  • Refresh Teams: Checks hyperclay.com immediately for new or updated team memberships.
  • View Sync Logs: Opens <logs>/sync in your file manager.
  • View Error Logs: Opens <logs>/errors in your file manager.
  • Autostart on Login: Checkbox to launch Hyperclay Local automatically when you log in to your computer.
  • About Hyperclay Local: Shows the app version and build details.
  • Quit: Flushes open saves, stops sync and local servers, and exits the app.

The system tray menu#

Hovering over the tray icon shows Hyperclay Local when all folders are healthy, or Hyperclay Local: <n> folders, <count> <state> when any folder has an error, conflict, taken port, or paused state.

Right-clicking the tray icon opens a native menu with:

  • Open workspace
  • Three read-only status lines: Server: On (or Off), Sync: On (or Off), and AI Editing: On (or Off)
  • Start Server / Stop Server
  • Enable Sync / Disable Sync
  • Enable AI Editing / Disable AI Editing
  • One submenu per non-viewer folder (<Title> localhost:<port>, <Title> (not set up), <Title> (port <port> in use), or <Title> (not served)), containing the folder’s actions (Open in Browser, Reveal Folder, Backups, Retry, Use port <n>…, Disconnect…, Remove Folder…)
  • View Sync Logs and View Error Logs
  • About Hyperclay Local and Quit