@libtmux/workspace-cli 0.1.0-alpha.11 → 0.1.0-alpha.13

package/README.md

@@ -1,24 +1,71 @@
+<!-- libtmux-logo -->
+<div align="center">
+  <picture>
+    <source srcset="https://raw.githubusercontent.com/libtmux/libtmux-ts/HEAD/packages/workspace-cli/assets/logo.svg" type="image/svg+xml">
+    <img src="https://raw.githubusercontent.com/libtmux/libtmux-ts/HEAD/packages/workspace-cli/assets/logo.png" width="128" height="128" alt="libtmux for TypeScript workspace">
+  </picture>
+</div>
+<!-- /libtmux-logo -->
+
+<div align="center">
+
 # Workspace CLI
 
 Manage tmux workspaces from YAML and JSON with Node.js 22.12+ or Bun 1.3.14+.
-This local implementation is in development.
+`tmux-workspace` loads, captures, converts and imports tmuxp workspace files.
+This implementation is in development.
 
-## Build
+</div>
 
-Run from the repository root:
+## Install
+
+Run the command without installing it. With Node:
 
 ```console
-$ bun run --cwd packages/libtmux build
+$ npx -y @libtmux/workspace-cli@0.1.0-alpha.13 --help
 ```
 
+With Bun. The command names `node` in its shebang, so `bunx` runs it on Node
+when Node is installed; `--bun` runs it on Bun:
+
 ```console
-$ bun run --cwd packages/workspace-cli build
+$ bunx --bun @libtmux/workspace-cli@0.1.0-alpha.13 --help
 ```
 
+With pnpm:
+
 ```console
-$ node packages/workspace-cli/dist/main.js --help
+$ pnpm dlx @libtmux/workspace-cli@0.1.0-alpha.13 --help
+```
+
+With Yarn. Yarn refuses a release younger than its `npmMinimalAgeGate`, one
+day by default:
+
+```console
+$ yarn dlx @libtmux/workspace-cli@0.1.0-alpha.13 --help
+```
+
+Or install it globally, which puts `tmux-workspace` on `PATH`. With npm:
+
+```console
+$ npm install --global @libtmux/workspace-cli@0.1.0-alpha.13
 ```
 
+With pnpm:
+
+```console
+$ pnpm add --global @libtmux/workspace-cli@0.1.0-alpha.13
+```
+
+With Bun:
+
+```console
+$ bun add --global @libtmux/workspace-cli@0.1.0-alpha.13
+```
+
+The rest of this page runs the installed `tmux-workspace`. A runner passes
+the same arguments to the command when they follow the package name.
+
 ## Load and capture
 
 Save this document as `workspace.yaml`:
@@ -36,7 +83,7 @@ windows:
 Load on a separate tmux socket:
 
 ```console
-$ node packages/workspace-cli/dist/main.js load ./workspace.yaml \
+$ tmux-workspace load ./workspace.yaml \
     -L workspace-cli-demo \
     -d \
     --json
@@ -45,7 +92,7 @@ $ node packages/workspace-cli/dist/main.js load ./workspace.yaml \
 Capture its live topology:
 
 ```console
-$ node packages/workspace-cli/dist/main.js freeze dev \
+$ tmux-workspace freeze dev \
     -L workspace-cli-demo \
     --json
 ```
@@ -126,17 +173,22 @@ lists and blank builder names still use native validation.
 ## Inspect a workspace through MCP
 
 The separate [MCP server](../mcp/README.md) inspects loaded workspaces on the
-same tmux socket. Build it from the repository root:
-
-```console
-$ bun run --cwd packages/mcp build
+same tmux socket. After the detached load above, add it to your MCP client with
+that socket and the `inspect` toolset:
+
+```json
+{
+  "mcpServers": {
+    "tmux": {
+      "command": "npx",
+      "args": ["-y", "@libtmux/mcp@0.1.0-alpha.13"],
+      "env": { "LIBTMUX_SOCKET": "workspace-cli-demo", "LIBTMUX_TOOLSETS": "inspect" }
+    }
+  }
+}
 ```
 
-After the detached load above, configure your MCP client to launch `node` with
-the built `packages/mcp/dist/server.js` as its argument. Use an absolute program
-path if the client starts outside this repository. Set `LIBTMUX_SOCKET` to
-`workspace-cli-demo` and `LIBTMUX_TOOLSETS` to `inspect` in that subprocess's
-environment. The socket is selected when the MCP server starts.
+The socket is selected when the MCP server starts.
 
 For a workspace loaded with `-S`, set `LIBTMUX_SOCKET_PATH` to the same absolute
 socket path instead of `LIBTMUX_SOCKET`. If the CLI uses `TMUX_BIN`, select that
@@ -287,7 +339,7 @@ their completion scope.
 Completion is tested on Linux with Bash 5.2, Zsh 5.9, and fish 4.8. Bash 3.2 is
 a syntax target; older shells and filenames containing newlines remain unverified.
 
-After installing the local package, load the script for your shell. Bash:
+With `tmux-workspace` on `PATH`, load the script for your shell. Bash:
 
 ```console
 $ source <(tmux-workspace completion bash)
@@ -307,6 +359,22 @@ $ tmux-workspace completion fish | source
 
 For automation, `--json` and `--ndjson` wrap the script in a structured result.
 
+## Build from source
+
+Run from the repository root:
+
+```console
+$ bun run --cwd packages/libtmux build
+```
+
+```console
+$ bun run --cwd packages/workspace-cli build
+```
+
+```console
+$ node packages/workspace-cli/dist/main.js --help
+```
+
 ## Development status
 
 Native discovery, conversion, imports, common searches, detached load, append,

package/THIRD-PARTY-NOTICES.md

@@ -4,14 +4,14 @@
 into `dist/` and their license terms are reproduced here in full, as those
 terms require. `libtmux` is not bundled and carries its own notice.
 
-## ansi-regex 5.0.1
+## ansi-regex 6.4.0
 
 License: MIT
 
 ```text
 MIT License
 
-Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (sindresorhus.com)
+Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
@@ -81,7 +81,7 @@ TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 ```
 
-## get-east-asian-width 1.6.0
+## get-east-asian-width 1.7.0
 
 License: MIT
 
@@ -113,7 +113,7 @@ The above copyright notice and this permission notice shall be included in all c
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 ```
 
-## slice-ansi 9.0.0
+## slice-ansi 9.0.1
 
 License: MIT
 
@@ -130,7 +130,7 @@ The above copyright notice and this permission notice shall be included in all c
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 ```
 
-## string-width 8.2.2
+## string-width 8.3.0
 
 License: MIT
 
@@ -162,7 +162,7 @@ The above copyright notice and this permission notice shall be included in all c
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 ```
 
-## yaml 2.9.0
+## yaml 2.9.1
 
 License: ISC
 

package/assets/logo.svg

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg xmlns="http://www.w3.org/2000/svg" width="512" height="512" viewBox="0 0 135.46667 135.46666" role="img" aria-label="libtmux for TypeScript — workspace CLI" class="libtmux-logo" data-language="typescript" data-variant="workspace" focusable="false"><title>libtmux for TypeScript — workspace CLI</title><g transform="translate(-210.28959,-409.98108)" data-part="artwork"><path d="m 334.66493,533.88598 v 11.56176 h 3.76501 c 4.04619,2.1e-4 7.32623,-3.28012 7.32632,-7.32631 v -4.23545 z" fill="#333333" data-part="base-edge"></path><g transform="matrix(1.024,0,0,1.024,-5.0469422,-9.8395302)" data-part="primary-tile"><path d="M 227.78906,0 213.98242,3.6992188 V 460.62109 H 241.4082 V 15.564453 Z" transform="matrix(0.26458333,0,0,0.26458333,210.28959,409.98108)" fill="#004687" data-part="primary-edge"></path><path d="m 210.28981,417.13553 v 113.86425 l 60.26885,2.60089 V 409.98109 h -53.11441 c -3.95129,0 -7.15444,3.20315 -7.15444,7.15444 z" fill="#3178C6" data-part="primary"></path></g><g transform="matrix(1.024,0,0,1.024,-5.0469422,-9.8395302)" data-part="lower-tile"><path d="m 486.38086,246.03906 -5.24805,4.99805 v 207.2207 l 5.24805,-0.93164 L 500,465.18945 V 261.60352 Z" transform="matrix(0.26458333,0,0,0.26458333,210.28959,409.98108)" fill="#001E40" data-part="lower-edge"></path><path d="m 278.70874,475.07917 v 64.8875 l 60.26883,-8.98455 v -55.90295 z" fill="#01417D" data-part="lower"></path></g><path d="m 210.28959,533.88598 v 4.23545 c 9e-5,4.04619 3.28012,7.32651 7.32631,7.32631 h 117.12417 c 4.04619,2e-4 7.32621,-3.28012 7.32631,-7.32631 v -4.23545 z" fill="#231F20" data-part="base"></path><g transform="matrix(1.024,0,0,1.024,-5.0469422,-9.8395302)" data-part="upper-tile"><path d="m 459.33984,0 -25.33593,2.1074219 h 21.38281 c 14.93397,0 27.04101,12.1070061 27.04101,27.0410161 l 1.51727,183.649512 2.43542,2.38046 -1.84468,1.91057 15.46424,13.65284 L 500,42.603516 C 499.99913,8.8176763 474.27408,-6.8031496e-4 459.33984,0 Z" transform="matrix(0.26458333,0,0,0.26458333,210.28959,409.98108)" fill="#5A85B8" data-part="upper-side"></path><path d="m 331.82331,409.98109 h -53.11442 v 56.93261 h 60.26885 v -49.77817 c 0,-3.95129 -3.20315,-7.15444 -7.15443,-7.15444 z" fill="#7FB1EC" data-part="upper"></path><path d="m 278.7089,466.9137 h 60.26885 l 3.6035,4.11782 h -60.26932 z" fill="#4973A5" data-part="upper-bottom"></path></g></g></svg>

package/dist/{app-w7cbtf0n.js → app-hhtza52q.js}

@@ -1,9 +1,12 @@
+import {
+  requireSupportedTmux
+} from "./main-wxsb2mch.js";
 import {
   expand,
   normalize,
   processRun,
   tokenize
-} from "./main-c8atq2pj.js";
+} from "./main-04s13z6x.js";
 import {
   CliError,
   OperationOutput,
@@ -21,18 +24,19 @@ import {
   sequence,
   styled,
   write
-} from "./main-gh3pafqb.js";
+} from "./main-gky86mgf.js";
 import {
   CommanderError,
   createParser,
   package_default
-} from "./main-bfnr2nkj.js";
+} from "./main-fv0q4s30.js";
 import {
   __require
-} from "./main-1de529jm.js";
+} from "./main-p4mbtvt8.js";
 
 // src/app.ts
 import { basename, dirname, extname, join as join2, resolve as resolve3 } from "node:path";
+import { VersionTooLowError } from "libtmux";
 
 // src/imports.ts
 import { join, resolve } from "node:path";
@@ -319,6 +323,7 @@ async function search(values, context) {
 
 // src/commands.ts
 import { platform, release } from "node:os";
+import { Server } from "libtmux";
 function tty(context) {
   return Boolean(context.stdin.isTTY);
 }
@@ -402,6 +407,10 @@ async function shell(request, context) {
       throw error;
     throw new CliError("script_failed", "The Python bridge requires tmuxp 1.74.0; set TMUX_WORKSPACE_PYTHON to its interpreter");
   }
+  await requireSupportedTmux(new Server({
+    environment: context.env,
+    ...typeof request.values.socket_path === "string" && request.values.socket_path ? { socketPath: request.values.socket_path } : typeof request.values.socket_name === "string" && request.values.socket_name ? { socketName: request.values.socket_name } : {}
+  }), context);
   const args = [
     python,
     "-u",
@@ -593,7 +602,7 @@ async function run(argv, context) {
       return 0;
     }
     if (request.command === "load" || request.command === "freeze") {
-      const operation = (await import("./tmux-wa2zn8z1.js"))[request.command];
+      const operation = (await import("./tmux-2bj9awev.js"))[request.command];
       context.signal?.throwIfAborted();
       return await operation(request, context);
     }
@@ -605,8 +614,8 @@ async function run(argv, context) {
       return await shell(request, context);
     if (request.command === "completion") {
       const [{ commandCatalog }, { completionScript }] = await Promise.all([
-        import("./reference-ebfxh6yp.js"),
-        import("./completions-2a9fqwq3.js")
+        import("./reference-3kbd1xpz.js"),
+        import("./completions-n0m971c2.js")
       ]);
       const shell2 = request.values.shell;
       const script = completionScript(commandCatalog(parser), shell2);
@@ -723,7 +732,7 @@ async function run(argv, context) {
     if (context.signal?.aborted)
       return 130;
     const usage = error instanceof CommanderError;
-    const code = usage ? "usage" : error instanceof CliError ? error.code : "tmux_failed";
+    const code = usage ? "usage" : error instanceof CliError ? error.code : error instanceof VersionTooLowError ? "tmux_unsupported" : "tmux_failed";
     const message = usage ? parserError.trim() || error.message : error instanceof Error ? error.message : String(error);
     try {
       await report(code, message);

package/dist/{completions-2a9fqwq3.js → completions-n0m971c2.js}

@@ -1,4 +1,4 @@
-import"./main-1de529jm.js";
+import"./main-p4mbtvt8.js";
 
 // src/completions.ts
 var quote = (value) => `'${value.replaceAll("'", "'\\''")}'`;

package/dist/{extensions-8v6mfszj.js → extensions-zx6s05v3.js}

@@ -1,19 +1,23 @@
+import {
+  requireSupportedTmux
+} from "./main-wxsb2mch.js";
 import {
   expand,
   normalize,
   processRun,
   workspaceName
-} from "./main-c8atq2pj.js";
+} from "./main-04s13z6x.js";
 import {
   CliError,
   privatePath,
   write
-} from "./main-gh3pafqb.js";
-import"./main-1de529jm.js";
+} from "./main-gky86mgf.js";
+import"./main-p4mbtvt8.js";
 
 // src/extensions.ts
 import {
-  TmuxCommandError
+  TmuxCommandError,
+  VersionTooLowError
 } from "libtmux";
 import { constants } from "node:fs";
 import { mkdtemp, open, rm, stat } from "node:fs/promises";
@@ -170,18 +174,21 @@ async function sessionHint(path) {
 function sameDaemon(left, right) {
   return left.pid === right.pid && left.startTime === right.startTime;
 }
-async function baseline(server, signal) {
+async function baseline(server, context) {
+  const signal = context.signal;
   try {
     await server.cmd("list-sessions", [], signal ? { signal } : {});
   } catch (error) {
-    if (error instanceof TmuxCommandError && error.exitCode === 1 && !error.stdout.length && error.stderr.length === 1 && /^(?:no server running on .+|error connecting to .+ \((?:No such file or directory|Connection refused)\))$/.test(error.stderr[0]))
+    if (error instanceof TmuxCommandError && error.exitCode === 1 && !error.stdout.length && error.stderr.length === 1 && /^(?:no server running on .+|error connecting to .+ \((?:No such file or directory|Connection refused)\))$/.test(error.stderr[0])) {
+      await requireSupportedTmux(server, context);
       return;
+    }
     throw error;
   }
   return server.snapshot(signal ? { signal } : {});
 }
 async function buildExtension(python, spec, source, server, context, output, result, borrowed) {
-  const before = await baseline(server, context.signal);
+  const before = await baseline(server, context);
   if (borrowed && (!before || !sameDaemon(borrowed.daemon, before.daemonIdentity) || !before.sessions.toArray().some((session2) => session2.id === borrowed.session.id)))
     throw new CliError("tmux_failed", "The authenticated append session or daemon changed");
   const existing = !borrowed && before?.sessions.toArray().find((session2) => session2.name === spec.name);
@@ -250,7 +257,7 @@ async function buildExtension(python, spec, source, server, context, output, res
       result.session_name = session.name ?? spec.name;
     } catch (error) {
       result.observation_error = error instanceof Error ? error.message : String(error);
-      failed ??= new CliError("tmux_failed", result.observation_error);
+      failed ??= new CliError(error instanceof VersionTooLowError ? "tmux_unsupported" : "tmux_failed", result.observation_error);
     }
     if (failed !== undefined)
       throw failed;