The workspace window

Your served folders open in the same workspace interface as Hyperclay’s hosted dashboard, either in a dedicated Hyperclay Local desktop window or in your web browser. From the workspace, you can browse your folder tree, search for documents by name or content, create new documents from templates, and edit documents in place.

Open the workspace window#

You can open the Hyperclay Local window (1200 by 800 pixels) in three ways:

1. Click the Hyperclay Local tray icon and click Open workspace on the home view or on a folder card, or click a folder’s localhost:<port> address in the popover. If that folder’s server is not running yet, Hyperclay Local starts it first and opens the folder in the workspace.
2. Right-click the tray icon and choose Open workspace from the tray menu.
3. Open an .html or .htmlclay file inside any served folder with Hyperclay Local from Finder or your system file manager (see Open With). The workspace window opens directly to that document.

If the workspace window is already open, choosing any of these actions brings the existing window to the front and navigates to the folder or document you picked.

Open the workspace in your browser#

You can also use the workspace in your default web browser:

• Open a folder’s ⋯ menu in the popover (or its submenu in the tray) and click Open in Browser.
• Visit http://localhost:<port>/ directly in a browser tab (for example, http://localhost:4321/ for your personal folder).

A top-level browser visit to http://localhost:<port>/ redirects to the workspace using a one-time ticket valid for 60 seconds, which sets a session cookie for that port valid for 24 hours. If the workspace server cannot start, or when / is requested via HEAD or inside an iframe, the server falls back to the folder’s directory listing (see Addresses and reserved routes).

Browse, search, and manage files#

Inside the workspace, each served folder provides:

• File tree and folder listings: browse the full directory tree or view paged folder listings sorted by name, updated time, or size. Changes on disk stream into the workspace live.
• Name and content search: search matches file names as well as the text inside your documents using a local search index built on your computer.
• New documents from templates: create a new document from the bundled templates: Document, Blank document, DevLog, Kanban, or Landing. These templates are byte-for-byte identical to the templates on hyperclay.com. An Untitled Document renames itself to its first heading after its last editor leaves.
• File actions: create folders, rename, move, duplicate, or move items to Trash (.trash/), restore items from Trash, empty Trash, or reveal a file in your system file manager.

Edit documents in the workspace#

When you open a document in the workspace, it loads inside a frame from its own localhost:<port> origin. Documents load their ClayJS editing runtime offline from a bundle built into the workspace window, so editing works with no internet connection.

Main-frame navigation stays within the workspace, and document frames stay within your running folders. Clicking an external link or calling window.open opens the address in your default browser.

Framed documents in a running folder can use clipboard write and fullscreen permissions. All other browser permission requests and hardware device prompts (USB, serial, HID, and Bluetooth) are refused.

Closing the window and quitting#

Closing the Hyperclay Local window hides the window (and hides the Dock icon on macOS) without stopping your servers or sync. The app keeps running in the system tray.

When you quit Hyperclay Local, turn off serving, change a folder’s port, or remove a folder, the app waits for open workspace frames and browser tabs to finish saving. If a document still has unsaved changes, Hyperclay Local shows the warning Some edits aren’t saved yet. with Retry and Cancel buttons so you do not lose work.