overmux 0.0.5 → 0.0.6

package/dist/docs/400-reference/600-client/200-theming.md

@@ -2,93 +2,208 @@
 title: Theming and CSS
 ---
 
-Your app owns its UI and CSS. Overmux provides scoped component styles and optional CSS variables for customization.
+Your Overmux UI owns its CSS. Overmux provides shared theme variables, light/dark defaults, and theme scopes for individual sections.
 
-## Appearance
+## Load your CSS
 
-Set `appearance` in `defineOvermuxClient({ appearance, commands, component })`. Types are exported from `overmux/client`.
+Import your stylesheet from your browser entry point:
 
-| Property | Values | Default | Behavior |
-| --- | --- | --- | --- |
-| `scheme` | `"light"`, `"dark"`, `"system"` | `"system"` | Selects the fallback palette and CSS `color-scheme`. System follows `prefers-color-scheme`. |
-| `contrast` | `"normal"`, `"high"`, `"auto"` | `"auto"` | High selects system-color fallbacks; auto responds to `prefers-contrast: more`. |
+```tsx
+import { OvermuxHost } from "overmux/client";
+import { createRoot } from "react-dom/client";
+
+import definition from "./app";
+import "./styles.css";
+
+createRoot(document.getElementById("root")!).render(
+  <OvermuxHost definition={definition} />,
+);
+```
 
-Browser forced colors apply regardless of `contrast`, with `forced-color-adjust: auto`. Explicit color tokens override palette fallbacks; test custom colors in each mode. Appearance does not persist preferences or configure third-party themes.
+Overmux components load their own styles automatically. Use ordinary CSS and component `className` props to customize them. Overmux defaults use CSS layers, so normal unlayered application styles take precedence.
 
-## Tokens
+## Choose light or dark
 
-Set public tokens on `:root` for the whole document, or on a theme scope for one subtree. `OvermuxStyle` provides typed inline styles for these tokens alongside React CSS properties.
+Set appearance in your client definition:
 
-| Token | CSS value | Purpose |
-| --- | --- | --- |
-| `--om-color-canvas` | Color | Page background |
-| `--om-color-surface` | Color | Main surface |
-| `--om-color-panel` | Color | Secondary background |
-| `--om-color-fg` | Color | Primary text |
-| `--om-color-muted` | Color | Secondary text |
-| `--om-color-border` | Color | Borders and separators |
-| `--om-color-accent` | Color | Interactive accents |
-| `--om-color-accent-fg` | Color | Foreground on accent backgrounds, where consumed |
-| `--om-color-danger` | Color | Errors and destructive states |
-| `--om-color-success` | Color | Success and added-content states |
-| `--om-font-sans` | Font-family list | Interface text |
-| `--om-font-mono` | Font-family list | Code and diagnostics |
-| `--om-spacing` | Length | Spacing unit; components may scale it |
-| `--om-radius` | Length | Corner radius; components may scale it |
-| `--om-elevation` | Box-shadow | Panel and popover shadows |
-| `--om-focus-ring` | Box-shadow | Focus-ring shadows |
-| `--om-motion-duration` | Time | Transition duration |
+```tsx
+import { defineOvermuxClient } from "overmux/client";
+
+export default defineOvermuxClient({
+  commands: {},
+  component: App,
+  appearance: {
+    scheme: "dark",
+    contrast: "auto",
+  },
+});
+```
 
-Tokens apply only where components consume them. Fallbacks vary by component; runtime palette variables beginning with `--_om-` are private. **Public tokens are not populated with default palette values:** app CSS using `var(--om-color-canvas)` must define it or provide a fallback. Explicit tokens inherit normally and do not change automatically with the scheme.
+- `scheme`: `"system"` (default), `"light"`, or `"dark"`.
+- `contrast`: `"auto"` (default), `"normal"`, or `"high"`.
 
-## `OvermuxThemeScope`
+`"system"` follows the system color preference. `"auto"` follows the system preference for increased contrast.
 
-Import from `overmux/client`. The host already supplies an outer scope; add scopes for local themes or portal placement.
+Appearance applies to your app and Overmux-owned UI inside `OvermuxHost`. It changes built-in defaults, not custom CSS variables.
+
+## Set colors, fonts, and other theme variables
+
+Define shared variables in your stylesheet. This example supplies a custom dark palette and every shared theme variable:
+
+```css
+:root {
+  --om-color-canvas: #111318;
+  --om-color-surface: #191c24;
+  --om-color-panel: #222735;
+  --om-color-fg: #eef0f6;
+  --om-color-muted: #a3adc2;
+  --om-color-border: #394156;
+  --om-color-accent: #b59aff;
+  --om-color-accent-fg: #111318;
+  --om-color-danger: #ff8b82;
+  --om-color-success: #65d6a2;
+
+  --om-font-sans: "Inter", sans-serif;
+  --om-font-mono: "JetBrains Mono", monospace;
+
+  --om-spacing: 0.75rem;
+  --om-radius: 0.5rem;
+  --om-elevation: 0 0.75rem 2rem rgb(0 0 0 / 30%);
+  --om-focus-ring: 0 0 0 3px rgb(181 154 255 / 30%);
+  --om-motion-duration: 120ms;
+}
+```
+
+### Colors
+
+- `--om-color-canvas`: page background.
+- `--om-color-surface`: content surface background.
+- `--om-color-panel`: panel and grouped-content background.
+- `--om-color-fg`: primary text.
+- `--om-color-muted`: secondary text.
+- `--om-color-border`: borders and separators.
+- `--om-color-accent`: highlighted controls and actions.
+- `--om-color-accent-fg`: text on an accent background.
+- `--om-color-danger`: errors and destructive states.
+- `--om-color-success`: success states.
+
+### Fonts
+
+- `--om-font-sans`: interface font family.
+- `--om-font-mono`: monospace font family.
+
+Load custom fonts yourself; these variables only select them.
+
+#### Loading custom fonts
+
+Load fonts with `@font-face`, then reference their family names in your theme variables:
+
+```css
+@font-face {
+  font-family: "My Font";
+  src: url("./fonts/my-font.woff2") format("woff2");
+  font-display: swap;
+}
+
+:root {
+  --om-font-sans: "My Font", sans-serif;
+}
+```
+
+For a monospace font, use the same approach with `--om-font-mono`.
+
+### Spacing and effects
+
+- `--om-spacing`: base spacing used by components.
+- `--om-radius`: base corner radius.
+- `--om-elevation`: elevated-surface box shadow.
+- `--om-focus-ring`: additional focus box shadow.
+- `--om-motion-duration`: transition duration.
+
+Components decide which variables they use.
+
+### Applying your theme
+
+Variables on `:root` reach both your application and Overmux-owned UI, including recovery, update, and settings screens. The separate login screen does not load userland CSS.
+
+Use the same variables in your own components:
+
+```css
+body {
+  margin: 0;
+  background: var(--om-color-canvas);
+}
+
+.panel {
+  color: var(--om-color-fg);
+  background: var(--om-color-surface);
+  border: 1px solid var(--om-color-border);
+  border-radius: var(--om-radius);
+  padding: var(--om-spacing);
+}
+```
+
+Overmux does not paint your application's page background for you.
+
+Public `--om-*` variables are override inputs: Overmux does not populate them with its built-in palette. Define them before using them in your own CSS, or supply CSS fallbacks.
+
+Custom values remain in effect when `scheme` changes. If you supply a custom palette, you also own its light/dark variants and any saved theme preference.
+
+## Theme one section
+
+Wrap a section in `OvermuxThemeScope`:
 
 ```tsx
-<OvermuxThemeScope scheme="light" style={{ "--om-color-accent": "purple" }}>
+import { OvermuxThemeScope } from "overmux/client";
+
+<OvermuxThemeScope
+  scheme="light"
+  contrast="normal"
+  className="preview"
+  style={{ "--om-color-accent": "rebeccapurple" }}
+>
   <Preview />
-</OvermuxThemeScope>
+</OvermuxThemeScope>;
 ```
 
-| Prop | Type | Default |
-| --- | --- | --- |
-| `children` | `ReactNode` | Required |
-| `scheme` | `OvermuxScheme` | `"system"` |
-| `contrast` | `OvermuxContrast` | `"auto"` |
-| `className` | `string` | Unset |
-| `style` | `OvermuxStyle` | Unset |
+The scope renders a wrapper `<div>` and applies appearance to its contents.
 
-Renders a `div` with `data-om-scope`, `data-om-scheme`, `data-om-contrast`, and an internal overlay container. Sets foreground, font family, and `color-scheme`, but does not paint a background.
+Custom CSS variables inherit normally. A light scope inside a custom dark palette will still inherit those custom colors unless you override them.
 
-Nested scopes resolve their own defaults, not their parent's appearance props. Public token overrides still inherit and take precedence over the nested palette. Tokens placed inside the app cannot affect ancestor host UI.
+`OvermuxHost` already creates an application-wide scope. A scope inside your app affects only that section, not surrounding Overmux-owned UI.
 
-## `OvermuxPortal`
+## Keep overlays themed
 
-Import from `overmux/client`. Use `<OvermuxPortal><Popup /></OvermuxPortal>` to render overlays within the nearest theme scope.
+Use `OvermuxPortal` for menus, dialogs, and other overlays:
 
-| Context | Destination |
-| --- | --- |
-| Inside a scope | Nearest scope's internal overlay container |
-| Outside a scope, in a browser | `document.body` |
-| Scope container not mounted, or no document | Nothing rendered |
-| `external={{ container, scopeAttributesAndVariables: "caller-owned" }}` | Supplied element; caller owns its scope attributes and variables |
+```tsx
+import { OvermuxPortal, OvermuxThemeScope } from "overmux/client";
+
+<OvermuxThemeScope scheme="dark">
+  <Editor />
+  <OvermuxPortal>
+    <EditorMenu />
+  </OvermuxPortal>
+</OvermuxThemeScope>;
+```
 
-The overlay container is a sibling of the scope's children. Put shared overlay tokens on the scope, not a descendant around the portal call site. External containers receive no automatic copying of scope attributes or variables. Portals supply placement, not positioning, focus trapping, or dismissal.
+The overlay renders inside the nearest theme scope, preserving its appearance and inherited variables.
 
-## CSS and integrations
+If you supply an external container, you own its theme attributes and CSS variables:
 
-Import app CSS from browser code with `import "./styles.css"`. Theme scopes, the UI package, and Git, Pi, xterm, and Zellij React components import their own styles. Layout, resets, and font loading remain app-owned.
+```tsx
+<OvermuxPortal
+  external={{
+    container: overlayElement,
+    scopeAttributesAndVariables: "caller-owned",
+  }}
+>
+  <EditorMenu />
+</OvermuxPortal>;
+```
 
-Built-in styles use `@scope` and the `om.components` cascade layer, with top-level ordering `theme, base, om`. Normal unlayered app CSS takes precedence over layered styles. Theme rules stop at nested scopes, but global app selectors and inherited properties can still affect components. Browser support for `@scope` and cascade layers is required.
+## Packages
 
-| Component family | Shared styling | Separate configuration |
-| --- | --- | --- |
-| Runtime host UI | Theme tokens where consumed | Client `appearance` |
-| UI split views | Border and accent tokens | App owns pane contents |
-| Git React UI | Colors, fonts, spacing, radius | Diff options and themes; `registerGitDiffTheme` registers custom themes |
-| Pi React UI | Colors, fonts, spacing, radius, elevation | Code highlighting uses Tokyo Night |
-| xterm | Wrapper background: `--om-xterm-terminal-background` | `options.theme` for terminal colors; options such as `fontFamily` for fonts |
-| tmux / Zellij terminal wrappers | xterm wrapper styles | Forwarded xterm props |
+Packages use shared `--om-*` variables where applicable. They may also expose additional CSS variables, `className`, `classNames`, or other styling props.
 
-Scope appearance does not automatically update terminal palettes or syntax-highlighting themes.
+Some rendered content has separate theme options rather than inheriting CSS colors. See each package's documentation for its styling controls.

package/docs/200-getting-started/500-set-up-overmux-with-packages.md

@@ -0,0 +1,42 @@
+---
+title: Set Up with Packages
+---
+
+To understand how Overmux works and how to configure your Overmux, start with the [reference docs](/docs/reference/project-structure). They cover your project structure, configuration, server, and browser UI.
+
+To get the most out of Overmux you'll want to use some packages.
+
+## What are packages?
+
+Packages are building blocks for your Overmux. They can provide server functionality, UI components, or both.
+
+Overmux packages are just standard npm packages you install and use in your Overmux project.
+
+## Packages to start with
+
+### Terminals with xterm and tmux
+
+Use these two packages together to add interactive terminals backed by persistent tmux sessions.
+
+- **[tmux](/docs/packages/tmux)** connects your Overmux to your machine's tmux sessions, windows, and panes. It provides live state, terminal streaming, and operations for controlling tmux, along with React components and hooks for your UI.
+- **[xterm](/docs/packages/xterm)** renders an [xterm.js](https://xtermjs.org/) terminal in your browser. It handles terminal display and input, but doesn't start a shell or manage sessions.
+
+Together, they let you interact with your terminals through Overmux UI while tmux keeps your sessions running when you disconnect.
+
+Follow the package docs for installation and wiring examples.
+
+### Source control with git
+
+The **[git package](/docs/packages/git)** adds repository changes and diffs to your Overmux, with ready-made UI components for browsing them.
+
+You choose which repository paths your server can access. You can also enable actions such as staging, unstaging, and discarding changes; write permissions are off by default.
+
+## Explore more packages
+
+Depending on your setup, you might also want:
+
+- **[Zellij](/docs/packages/zellij)** for a Zellij-backed terminal setup instead of tmux. Experimental; compatibility is not guaranteed.
+- **[Pi](/docs/packages/pi)** for viewing AI agent conversations and interacting with running agents. Experimental; compatibility is not guaranteed.
+- **[JSONL store](/docs/packages/jsonl-store)** for storing schema-validated records in a local file.
+
+Start with the pieces you need. Each package's documentation explains what it provides and how to connect it to your Overmux.

package/docs/400-reference/200-configuration.md

@@ -111,7 +111,7 @@ IDs must be 1-253 lowercase ASCII characters, start and end with a letter or dig
 
 An ID function runs once at startup using the actual listening port. Every address serving the same running instance reports the same ID. Distinct instances need distinct IDs; IDs are not credentials.
 
-See [Deep-link navigation](/docs/reference/client/api#deep-link-navigation) and [`overmux instance`](/docs/reference/cli/instance).
+See [Deep links](./600-client/007-deep-links.md) and [`overmux instance`](/docs/reference/cli/instance).
 
 ### `vite`
 

package/docs/400-reference/500-server/500-api.md

@@ -1,5 +1,5 @@
 ---
-title: Server API
+title: Server API Reference
 ---
 
 ## Server definitions

package/docs/400-reference/600-client/005-setting-up-your-ui.md

@@ -0,0 +1,137 @@
+---
+title: Setting up your UI
+---
+
+Your Overmux UI is a React application served and built with Vite. You own its layout, components, and styles; `OvermuxHost` provides the runtime for Overmux’s client APIs.
+
+Run `overmux init` to generate a starter project with the UI setup below.
+
+## File layout
+
+```text
+overmux.config.ts
+vite.config.ts
+src/ui/
+  index.html
+  main.tsx
+  app.tsx
+  styles.css
+```
+
+## Configure Vite
+
+Set your UI directory as Vite’s root and enable React:
+
+```ts title="vite.config.ts"
+import react from "@vitejs/plugin-react";
+import { defineConfig } from "vite";
+
+export default defineConfig({
+  root: "src/ui",
+  plugins: [react()],
+  build: {
+    emptyOutDir: true,
+    outDir: "../../dist",
+  },
+});
+```
+
+Point your Overmux configuration at this file, keeping your existing server and authentication settings:
+
+```ts title="overmux.config.ts"
+import { defineOvermuxConfig } from "overmux";
+import server from "./src/server/index";
+
+export default defineOvermuxConfig({
+  server,
+  auth: { mode: "cli-login" },
+  vite: "./vite.config.ts",
+  productionWebAssetsDir: "./dist",
+});
+```
+
+Vite’s output directory is relative to its UI root; `productionWebAssetsDir` points to the same directory from your Overmux configuration.
+
+## The HTML entry point
+
+Provide a root element and load your React entry point:
+
+```html title="src/ui/index.html"
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>My Overmux</title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/main.tsx"></script>
+  </body>
+</html>
+```
+
+## Mount OvermuxHost
+
+Mount your client definition inside `OvermuxHost`. It supplies the runtime required by hooks such as `useCommand` and `useCommands`.
+
+```tsx title="src/ui/main.tsx"
+import { OvermuxHost } from "overmux/client";
+import { createRoot } from "react-dom/client";
+
+import { client } from "./app";
+import "./styles.css";
+
+const root = document.querySelector("#root");
+if (!root) {
+  throw new Error("Missing root element");
+}
+
+createRoot(root).render(<OvermuxHost definition={client} />);
+```
+
+## Define your client
+
+Use `defineOvermuxClient` to connect your root React component and command registry:
+
+```tsx title="src/ui/app.tsx"
+import { defineOvermuxClient } from "overmux/client";
+
+const App = () => <main>My Overmux UI</main>;
+
+export const client = defineOvermuxClient({
+  component: App,
+  commands: {},
+});
+```
+
+`App` is an ordinary React component. Add your own components, state, and layout, or compose components from ecosystem packages.
+
+Start with an empty command registry. See [Commands](./commands) when you want named actions for menus, command palettes, or keyboard shortcuts.
+
+## Add styles
+
+Import your application CSS from `main.tsx`:
+
+```css title="src/ui/styles.css"
+body {
+  margin: 0;
+  font-family: system-ui, sans-serif;
+}
+
+main {
+  padding: 1rem;
+}
+```
+
+Individual ecosystem components may require additional stylesheet imports.
+
+## Run your Overmux server
+
+Run your instance through Overmux so the UI has access to its server:
+
+```sh
+overmux serve --config ./overmux.config.ts
+```
+
+Open the UI URL shown by the server. Vite updates the UI as you edit your React components and styles.

package/docs/400-reference/600-client/007-deep-links.md

@@ -0,0 +1,87 @@
+---
+title: Deep links
+---
+
+Your Overmux UI is a website, so each page has a URL. Deep links let you open those same routes in a specific Overmux instance using `overmux://` instead of an `http://` web address.
+
+```text
+overmux://work-laptop/my-page?tab=logs
+          instance   UI route
+```
+
+## Instances
+
+An **instance** is one Overmux server. Its ID defaults to `<hostname>-<port>`. Set [`instanceId`](../200-configuration.md#instanceid) in `overmux.config.ts` to give it a stable identity.
+
+The instance ID is not a network address. Desktop remembers how to reach an instance when you connect to it.
+
+Run [`overmux instance --json`](../700-cli/350-instance.md) to get the running server’s `instanceId` and `deepLinkPrefix`.
+
+## Creating links
+
+Append your Overmux UI’s route to the instance’s deep-link prefix.
+
+Server handlers receive `instance` through their context argument:
+
+```ts
+import { defineOperation } from "overmux/server";
+import { z } from "zod";
+
+export const getPageLink = defineOperation({
+  input: z.void(),
+  output: z.string(),
+  handle: (_input, { instance }) =>
+    `${instance.getDeepLinkPrefix()}/my-page?tab=logs`,
+});
+```
+
+In React, use `useInstance` from your `createOvermuxHooks` setup. It re-renders when the server’s identity becomes available or changes:
+
+```tsx
+import { useInstance } from "./overmux";
+
+const PageLink = () => {
+  const instance = useInstance();
+  if (!instance) return null;
+
+  return (
+    <a href={`${instance.deepLinkPrefix}/my-page?tab=logs`}>
+      View logs
+    </a>
+  );
+};
+```
+
+`useInstance()` returns `undefined` until the server identifies itself.
+
+## Routing in your Overmux UI
+
+Your Overmux UI owns routing. We recommend [TanStack Router](https://tanstack.com/router/latest) for routing with React. See [Tech stack recommendations](./300-tech-stack-recommendations.md).
+
+Overmux passes the path, query, and fragment to your client’s `navigate` callback. Connect this callback to your router to navigate without reloading the page. Without that callback, Overmux loads the route normally.
+
+With an existing TanStack Router instance exported from `./router`:
+
+```tsx
+import { RouterProvider } from "@tanstack/react-router";
+import { defineOvermuxClient } from "overmux/client";
+import { router } from "./router";
+
+const App = () => <RouterProvider router={router} />;
+
+export const client = defineOvermuxClient({
+  commands: {},
+  component: App,
+  navigate: (route) => router.navigate({ href: route }),
+});
+```
+
+For `overmux://work-laptop/my-page?tab=logs#latest`, `route` is `/my-page?tab=logs#latest`.
+
+## Opening links
+
+- **Inside your Overmux UI or PWA:** same-instance links navigate locally. No OS protocol handler is needed.
+- **Desktop:** opening a link launches or focuses Desktop. Links can also switch to another known instance after confirmation. Connect to that instance first so Desktop knows its address.
+- **Browser/PWA:** links to different or not-yet-discovered instances are blocked.
+
+Installing the PWA does not register it as an OS-wide `overmux://` handler. Links clicked outside your Overmux UI require Overmux Desktop.