overmux 0.0.5 → 0.0.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (32) hide show
  1. package/CHANGELOG.md +7 -62
  2. package/LICENSE +21 -0
  3. package/README.md +16 -2
  4. package/dist/THIRD_PARTY_NOTICES.md +591 -0
  5. package/dist/auth/.vite/manifest.json +1 -1
  6. package/dist/auth/THIRD_PARTY_NOTICES.md +2506 -0
  7. package/dist/auth/assets/{index-DabAfcs1.js → index-Bc0hP5IW.js} +2509 -1
  8. package/dist/auth/index.html +1 -1
  9. package/dist/bin.js +14 -0
  10. package/dist/bin.js.map +1 -1
  11. package/dist/docs/200-getting-started/300-install-overmux-pwa.mdx +215 -1
  12. package/dist/docs/200-getting-started/500-set-up-overmux-with-packages.md +42 -0
  13. package/dist/docs/400-reference/200-configuration.md +1 -1
  14. package/dist/docs/400-reference/500-server/500-api.md +1 -1
  15. package/dist/docs/400-reference/600-client/005-setting-up-your-ui.md +137 -0
  16. package/dist/docs/400-reference/600-client/007-deep-links.md +87 -0
  17. package/dist/docs/400-reference/600-client/010-commands.md +189 -0
  18. package/dist/docs/400-reference/600-client/020-shortcuts.md +171 -0
  19. package/dist/docs/400-reference/600-client/100-api.md +1 -1
  20. package/dist/docs/400-reference/600-client/200-theming.md +179 -64
  21. package/docs/200-getting-started/300-install-overmux-pwa.mdx +215 -1
  22. package/docs/200-getting-started/500-set-up-overmux-with-packages.md +42 -0
  23. package/docs/400-reference/200-configuration.md +1 -1
  24. package/docs/400-reference/500-server/500-api.md +1 -1
  25. package/docs/400-reference/600-client/005-setting-up-your-ui.md +137 -0
  26. package/docs/400-reference/600-client/007-deep-links.md +87 -0
  27. package/docs/400-reference/600-client/010-commands.md +189 -0
  28. package/docs/400-reference/600-client/020-shortcuts.md +171 -0
  29. package/docs/400-reference/600-client/100-api.md +1 -1
  30. package/docs/400-reference/600-client/200-theming.md +179 -64
  31. package/package.json +4 -2
  32. package/src/internal/cli/managed-vite.ts +21 -0
package/CHANGELOG.md CHANGED
@@ -1,71 +1,16 @@
1
1
  # overmux
2
2
 
3
- ## 0.0.5
3
+ ## 0.0.7
4
4
 
5
5
  ### Patch Changes
6
6
 
7
- - [#149](https://github.com/richardgill/overmux/pull/149) [`99221b3`](https://github.com/richardgill/overmux/commit/99221b393196a714bd48b54c34eb5d848e8dbb85) Thanks [@richardgill](https://github.com/richardgill)! - Group documentation commands under `overmux docs`: use `overmux docs path` to locate installed documentation and `overmux docs ai-context` to print coding-agent guidance. Bare `overmux docs` now shows subcommand help; the top-level `ai` command is removed. Update generated agent instructions and clarify that documentation paths are not package source paths.
7
+ - [`76e3195`](https://github.com/richardgill/overmux/commit/76e319576de46181b76a2c812f7f12f7eb6f36c0) Thanks [@richardgill](https://github.com/richardgill)! - Keep development HMR connections active with server-to-browser heartbeats, preventing idle Android connections from closing and triggering Vite reconnect reloads while preserving live updates.
8
8
 
9
- - [#148](https://github.com/richardgill/overmux/pull/148) [`3d50362`](https://github.com/richardgill/overmux/commit/3d503621030efeb39440a4180d58f67edf2dac94) Thanks [@richardgill](https://github.com/richardgill)! - Format inline code in documentation frontmatter titles.
9
+ - [`76e3195`](https://github.com/richardgill/overmux/commit/76e319576de46181b76a2c812f7f12f7eb6f36c0) Thanks [@richardgill](https://github.com/richardgill)! - Declare MIT licensing for original Overmux code, include distribution licenses and third-party notices, and establish current-version changelog baselines for public source releases.
10
10
 
11
- - [#142](https://github.com/richardgill/overmux/pull/142) [`358649f`](https://github.com/richardgill/overmux/commit/358649fc9a681bd5aa89e240da12ddce694bde10) Thanks [@richardgill](https://github.com/richardgill)! - Navigate same-instance Overmux terminal links and HTML anchors internally in browsers and PWAs, with optional application-router integration and shared Desktop URL validation.
11
+ - Updated dependencies [[`76e3195`](https://github.com/richardgill/overmux/commit/76e319576de46181b76a2c812f7f12f7eb6f36c0)]:
12
+ - @overmux/keybindings@0.0.5
12
13
 
13
- - [#144](https://github.com/richardgill/overmux/pull/144) [`c60a41b`](https://github.com/richardgill/overmux/commit/c60a41b26fcc7cf76fdf35fe21fe8cd02f552419) Thanks [@richardgill](https://github.com/richardgill)! - Use deterministic, owner-only `/tmp/overmux-<uid>` runtime directories when XDG runtime storage is unset, and a hashed `/tmp` path when it is too long for Unix sockets. Reject unsafe runtime directories and registration files. Restart existing servers after upgrading to make them discoverable at the new fallback location.
14
+ ## 0.0.6
14
15
 
15
- - [#153](https://github.com/richardgill/overmux/pull/153) [`7635e69`](https://github.com/richardgill/overmux/commit/7635e69458458b2ef752e6ac7aed6ee96897dbe4) Thanks [@richardgill](https://github.com/richardgill)! - Remove `checkOvermux`, `getOvermuxPaths`, `startOvermuxServer`, and their associated types from the public `overmux/server` entry point. The entry point remains importable as an empty module. Server lifecycle and inspection remain internal; use the CLI to start the server or check configuration.
16
-
17
- - [#143](https://github.com/richardgill/overmux/pull/143) [`88cc80e`](https://github.com/richardgill/overmux/commit/88cc80e15ccfaa64c0e1cdfbe1e5729409451362) Thanks [@richardgill](https://github.com/richardgill)! - Make login output easier to scan with grouped URLs, shorter instructions and privacy warnings, and the remaining lifetime before the expiry timestamp. Only show the hint to create another login grant during serve.
18
-
19
- - [`c5a5b8d`](https://github.com/richardgill/overmux/commit/c5a5b8dfc612c8ba784852d301b5c7ea5cb856f7) Thanks [@richardgill](https://github.com/richardgill)! - Simplify the CLI login privacy warning for multiple links.
20
-
21
- - [#152](https://github.com/richardgill/overmux/pull/152) [`e01a8d9`](https://github.com/richardgill/overmux/commit/e01a8d9d5c11db4d65e2eb440d50b269fa807a56) Thanks [@richardgill](https://github.com/richardgill)! - Breaking API change: invalidate resources with `context.invalidate("resourceId", input?)` instead of passing a resource contract. IDs select exactly one registered resource and its derived dependants; unknown IDs throw. Optional input targeting is unchanged.
22
-
23
- Inline `defineOvermuxServer` operations are now plain definitions rather than `defineOperation(...)` calls. Their handlers infer registered resource IDs and raw input types for invalidation. Independently defined reusable operations retain `defineOperation`, and operations that invalidate resources must declare their required resource inputs with `OperationContext`.
24
-
25
- Git operation handlers now require `gitOperationHandlers({ repositories, resourceId: "sourceControl" })`, where `resourceId` matches the application's source-control resource key.
26
-
27
- - [#156](https://github.com/richardgill/overmux/pull/156) [`ab2942a`](https://github.com/richardgill/overmux/commit/ab2942a035e9bff95b6fc150430ba2d7757b82bb) Thanks [@richardgill](https://github.com/richardgill)! - Restore `getOvermuxPaths` from the `overmux/server` public API.
28
-
29
- - [#146](https://github.com/richardgill/overmux/pull/146) [`0acc04b`](https://github.com/richardgill/overmux/commit/0acc04b19ad5c123bc76aebb3933d9a767b0863c) Thanks [@richardgill](https://github.com/richardgill)! - Write server logs to the standard state-directory destination, removing the configurable log-file setting. Resolve debug logging and instance identity defaults explicitly; identity still evaluates its hostname-port value only after the listener binds.
30
-
31
- - [#145](https://github.com/richardgill/overmux/pull/145) [`b1cdc75`](https://github.com/richardgill/overmux/commit/b1cdc75ab28c0637431d86a351bfcd6655b762d8) Thanks [@richardgill](https://github.com/richardgill)! - Rename the unlimited `auth.sessionLifetime` value from `"never"` to `"forever"`. The default is now `"forever"`; `"never"` is no longer accepted.
32
-
33
- - [#139](https://github.com/richardgill/overmux/pull/139) [`719b27c`](https://github.com/richardgill/overmux/commit/719b27c31a81c648f264a683be3a064fb8718bec) Thanks [@richardgill](https://github.com/richardgill)! - Expose a server-confirmed `connectionId` on stream hooks and require it on custom tmux transports. Keep readiness scoped to the actual stream lifetime across reconnects and hot reloads; method rebinding no longer closes reused streams. Make `useTmuxTerminal` automatically reattach to its last confirmed session, following tmux's current window and pane. Explicit `goTo` requests may wait for opening, but reject on interruption and are not replayed. Automatic attachment failures are exposed through `error` and `onError` without endless retries. Custom stream owners retire replaced handles; the hook closes only its current stream on final unmount.
34
-
35
- - [#154](https://github.com/richardgill/overmux/pull/154) [`376690d`](https://github.com/richardgill/overmux/commit/376690dbc752706c086dab5385a0a311c7a63780) Thanks [@richardgill](https://github.com/richardgill)! - Remove redundant keybinding exports from `overmux/client`.
36
-
37
- ## 0.0.4
38
-
39
- ### Patch Changes
40
-
41
- - [#121](https://github.com/richardgill/overmux/pull/121) [`c46e1ad`](https://github.com/richardgill/overmux/commit/c46e1ad74998fa132640138ea8c9c1c70ccda42d) Thanks [@richardgill](https://github.com/richardgill)! - Add startup-resolved instance identity, authenticated discovery, scoped server/browser helpers, reactive useInstance, and the overmux instance CLI command.
42
-
43
- - [#119](https://github.com/richardgill/overmux/pull/119) [`e50c79f`](https://github.com/richardgill/overmux/commit/e50c79fd906d41c3ba8445da655a1075db5b6a93) Thanks [@richardgill](https://github.com/richardgill)! - Add public CSS host and platform selectors to the hosted application document, with native desktop metadata and live installed-app display-mode detection.
44
-
45
- - [#125](https://github.com/richardgill/overmux/pull/125) [`d95b408`](https://github.com/richardgill/overmux/commit/d95b40895565a602e49f56fe755747c68f09b18a) Thanks [@richardgill](https://github.com/richardgill)! - Make login codes easier to enter with automatic uppercase grouping, optional-dash paste support, surrounding-whitespace trimming, and local validation.
46
-
47
- ## 0.0.3
48
-
49
- ### Patch Changes
50
-
51
- - [#118](https://github.com/richardgill/overmux/pull/118) [`78a3b8f`](https://github.com/richardgill/overmux/commit/78a3b8f9b143b8408989309bfaa399208daaa133) Thanks [@richardgill](https://github.com/richardgill)! - Catch up the initial patch release with init scaffolding, resilient terminal connections and tmux navigation, plus improved xterm links, clipboard support, and Unicode rendering. The Zellij integration remains an independent minor release and now requires the current Overmux peer version.
52
-
53
- - [#117](https://github.com/richardgill/overmux/pull/117) [`d000b17`](https://github.com/richardgill/overmux/commit/d000b170d085f087e364672b3139b01e8fea1902) Thanks [@richardgill](https://github.com/richardgill)! - Scaffold AI agent guidance files when initializing an Overmux project.
54
-
55
- - Updated dependencies [[`78a3b8f`](https://github.com/richardgill/overmux/commit/78a3b8f9b143b8408989309bfaa399208daaa133)]:
56
- - @overmux/keybindings@0.0.3
57
-
58
- ## 0.0.2
59
-
60
- ### Patch Changes
61
-
62
- - [`8dd6e84`](https://github.com/richardgill/overmux/commit/8dd6e842b9cca49a187cc2539c2c35dd82c90a8d) Thanks [@richardgill](https://github.com/richardgill)! - Initial release.
63
-
64
- - Updated dependencies [[`8dd6e84`](https://github.com/richardgill/overmux/commit/8dd6e842b9cca49a187cc2539c2c35dd82c90a8d)]:
65
- - @overmux/keybindings@0.0.2
66
-
67
- ## 0.0.1
68
-
69
- ### Patch Changes
70
-
71
- - [#1](https://github.com/richardgill/overmux/pull/1) [`e29fcc3`](https://github.com/richardgill/overmux/commit/e29fcc35f2d0cff1618f671d8fa1b56da8d60f28) Thanks [@richardgill](https://github.com/richardgill)! - Scaffold the Overmux workspace, configuration runtime, browser shell, server, CLI, and first-party terminal tab boundary.
16
+ Current-version baseline: Overmux CLI, trusted server runtime, and browser APIs for application-owned workspaces.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Richard Gill
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -2,6 +2,20 @@
2
2
 
3
3
  Overmux is a local or self-hosted web UI for terminal sessions, agents, and Git workspaces.
4
4
 
5
- Documentation for this exact package version is included in [`docs`](./docs). Run `overmux docs path` to print the absolute path to the installed documentation directory.
5
+ ## Installation
6
6
 
7
- Start with [How Overmux Works](./docs/100-introduction/200-how-overmux-works.md) and [Install and Run Overmux](./docs/200-getting-started/100-install-and-run-overmux.md).
7
+ Install the CLI with Mise:
8
+
9
+ ```sh
10
+ mise use --global npm:overmux
11
+ ```
12
+
13
+ Or with pnpm:
14
+
15
+ ```sh
16
+ pnpm add --global overmux
17
+ ```
18
+
19
+ ## Documentation
20
+
21
+ See the [Overmux documentation](./docs/000-index.md).