overmux 0.0.5 → 0.0.7

package/dist/docs/200-getting-started/300-install-overmux-pwa.mdx

@@ -5,7 +5,8 @@ title: Install Overmux PWA
 Overmux is a [progressive web app (PWA)](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps), so you can install it on a mobile device. The installed app gets its own home screen icon and opens in a standalone window.
 
 <Callout type="warning">
-  PWAs must be hosted on HTTPS. See [Choose an HTTPS setup](./400-secure-with-https/100-choose-an-https-setup.md).
+  PWAs must be hosted on HTTPS. See [Choose an HTTPS
+  setup](./400-secure-with-https/100-choose-an-https-setup.md).
 </Callout>
 
 ## Chrome on Android
@@ -90,3 +91,216 @@ Open your Overmux URL in Safari, select **Share**, and then select **Add to Home
 </p>
 
 Screenshots adapted from the [ntfy PWA installation guide](https://docs.ntfy.sh/subscribe/pwa/).
+The eight image files are displayed unmodified, at reduced sizes. They match
+[ntfy's documentation sources](https://github.com/binwiederhier/ntfy/tree/10cb6506f836dbb00bb77e3b52669f6ace37f555/docs/static/img)
+and are used under the project's [Apache 2.0 license](https://github.com/binwiederhier/ntfy/blob/10cb6506f836dbb00bb77e3b52669f6ace37f555/LICENSE).
+Copyright 2021 Philipp C. Heckel. This does not imply endorsement by ntfy or the browser vendors.
+
+<details>
+<summary>Screenshot license (Apache 2.0)</summary>
+
+```text
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2021 Philipp C. Heckel
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+```
+
+</details>

package/dist/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/dist/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/dist/docs/400-reference/500-server/500-api.md

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

package/dist/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/dist/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.