调用主机二进制文件

在某些情况下，您的扩展可能需要调用主机的某些命令。例如，您可能希望调用云提供商的 CLI 以创建新资源，或者您的扩展提供的工具的 CLI，甚至是在主机上运行的 shell 脚本。

您可以通过使用扩展 SDK 从容器执行 CLI 来实现。但是这个 CLI 需要访问主机的 filesystem，如果在容器中运行，这既不容易也不快。

然而，主机二进制文件通过作为扩展的一部分提供并部署到主机的扩展可执行文件（作为二进制文件、shell 脚本）进行调用。由于扩展可以在多个平台上运行，这意味着您需要为您要支持的所有平台提供可执行文件。

了解有关扩展架构的更多信息。

注意

只有作为扩展一部分提供的可执行文件才能通过 SDK 调用。

在这个例子中，CLI 是一个简单的 `Hello world` 脚本，它必须带参数调用并返回一个字符串。

将可执行文件添加到扩展

#!/bin/sh
echo "Hello, $1!"

@echo off
echo "Hello, %1!"

然后更新 `Dockerfile` 以将 `binaries` 文件夹复制到扩展的容器文件系统中，并使文件可执行。

# Copy the binaries into the right folder
COPY --chmod=0755 binaries/windows/hello.cmd /windows/hello.cmd
COPY --chmod=0755 binaries/unix/hello.sh /linux/hello.sh
COPY --chmod=0755 binaries/unix/hello.sh /darwin/hello.sh

从 UI 调用可执行文件

在您的扩展中，使用 Docker Desktop Client 对象通过 `ddClient.extension.host.cli.exec()` 函数调用扩展提供的 shell 脚本。在这个例子中，一旦扩展视图渲染完成，二进制文件会返回一个字符串作为结果，通过 `result?.stdout` 获取。

export function App() {
  const ddClient = createDockerDesktopClient();
  const [hello, setHello] = useState("");

  useEffect(() => {
    const run = async () => {
      let binary = "hello.sh";
      if (ddClient.host.platform === 'win32') {
        binary = "hello.cmd";
      }

      const result = await ddClient.extension.host?.cli.exec(binary, ["world"]);
      setHello(result?.stdout);

    };
    run();
  }, [ddClient]);
    
  return (
    <div>
      {hello}
    </div>
  );
}

配置元数据文件

主机二进制文件必须在 `metadata.json` 文件中指定，以便 Docker Desktop 在安装扩展时将其复制到主机。一旦卸载扩展，复制的二进制文件也将被删除。

{
  "vm": {
    ...
  },
  "ui": {
    ...
  },
  "host": {
    "binaries": [
      {
        "darwin": [
          {
            "path": "/darwin/hello.sh"
          }
        ],
        "linux": [
          {
            "path": "/linux/hello.sh"
          }
        ],
        "windows": [
          {
            "path": "/windows/hello.cmd"
          }
        ]
      }
    ]
  }
}

`path` 必须引用容器内二进制文件的路径。