Skip to content
On this page

快速入门: 安装与首次使用 ​

本指南带你把 genkan 从一个下载文件, 变成在 MCP 客户端里能正常运行的「列出我的浏览器标签页」。入口是 CLI (macOS、Linux、Windows)。

开始之前, 请先阅读 README 中的安全摘要: 本工具操作的是你已登录的浏览器, 它向你展示的确认就是安全模型本身, 而不是阻碍。

扩展需要 Chrome 134 或更新版本; 更旧的浏览器会拒绝加载它。

CLI (macOS、Linux、Windows) ​

CLI 只需要二进制本身, 在桌面机、无头机器和 CI 上都一样。

  1. 安装。 从最新发布中任选一种; 若想先校验下载文件, 命令见 SECURITY.md。

    渠道命令或点击作用
    macOS .pkg右键, 打开 (目前未签名)安装 /usr/local/bin/genkan, 并替你完成第 3 步
    Windows .msi双击 (目前未签名; SmartScreen 会警告)为你的账户安装到 %LOCALAPPDATA%\Programs\genkan, 把它加入你的 PATH, 并替你完成第 3 步
    Linux .debsudo dpkg -i genkan-<tag>-linux-x64.deb安装 /usr/bin/genkan, 并替你完成第 3 步, 机器级
    Homebrewbrew install vivswan/tap/genkan, 待 tap 就绪后 (release.md)安装二进制, 并替你完成第 3 步
    压缩包解压 genkan-<tag>-<platform>-<arch>.tar.gz (Windows 上为 .zip)得到二进制与 extension/dist; 第 2、3 步需自行完成

    或者用 cargo build --release 从源码构建。Windows 上的注册尚未在用户机器上试过 (cli.md 的 Windows 说明)。

  2. 仅压缩包: 放到稳定的位置。 注册指向二进制所在的位置, 所以要选一个不会消失的路径: Linux 上是 ~/.local/lib/genkan/, macOS 上是你主目录下的任意位置。AppImage 挂载点或临时目录都不稳定, 你若这样做, doctor --fix 会发出警告。

  3. 向你的浏览器注册。 .pkg、.msi 和 Homebrew 已经做过了, .deb 也为安装时已有的浏览器做过了; 压缩包需要这一步 (请在解压目录中以 ./ 前缀运行二进制):

    sh
    genkan doctor --fix                       # every detected browser
    genkan doctor --fix --browser chrome,brave
    genkan doctor --fix --manifest-dir DIR    # an unlisted Chromium
                                                       # variant (macOS/Linux)

    重复运行无害, genkan doctor --list 以只读方式显示状态, genkan uninstall 精确撤销所写入的内容; 细节由 cli.md 负责。

  4. 加载扩展。 扩展的 Web Store 条目尚未发布 (release.md 的 Web Store 一节): 通过 chrome://extensions, 开发者模式, 「加载已解压的扩展程序」, 加载发布压缩包中的 extension/dist (在源码检出中, 先构建再加载 build/extension/chrome-mv3)。重启浏览器。

    条目上线后, cli.md 的指针表 会说明哪些浏览器会根据第 3 步留下的指针提供该扩展, 以及哪些浏览器不会写入指针。

  5. 配对。 运行 genkan pair: 它要求你在终端上键入一段确认, 铸造主机密钥, 并打印出密钥指纹。在扩展的选项页上批准该指纹; 在固定就位之前, 扩展在每个平台上都拒绝执行任何操作 (cli.md 负责说明这一仪式及其参数)。

  6. 登记 (推荐)。 在选项页的身份区域登记你浏览器的认证器。机器上的第一次登记是首次使用即信任; 之后的每一次都需要一个已登记认证器的触碰。

  7. 连接你的 MCP 客户端到二进制的绝对路径。对 Claude Code:

    sh
    claude mcp add genkan -- /absolute/path/to/genkan

    对 Claude Desktop 及其他以 JSON 配置的客户端, 添加一个 mcpServers 条目, 指向同一个绝对路径, 不带参数。

完整的命令参考见 cli.md, 涵盖配对、受信任客户端、吊销、紧急开关 (kill switch) 与审计日志。

你应该看到什么 ​

在注册了 Chrome 且 MCP 服务器正在运行 (由你的 MCP 客户端启动) 时的 genkan doctor, 在一个全新的 macOS 用户目录上捕获:

text
$ genkan doctor
genkan doctor - v0.1.0
platform:        macos/aarch64
lock file:       /tmp/quickstart-home/Library/Application Support/genkan/run.lock
  present: yes
  endpoint: /tmp/quickstart-home/Library/Application Support/genkan/run.sock
  pid:     77652
  secret:  <redacted, 32 chars>
mcp server:      reachable (socket connect OK)
kill switch:     off (bridge activity permitted)
policy baseline: none yet (pre-cutover; the extension keeps enforcing its deny baseline until `genkan policy set` or the options page's Security policy section signs a baseline)
native manifests: (host id com.vivswan.genkan.host)
  chrome    detected      user    manifest ok         /tmp/quickstart-home/Library/Application Support/Google/Chrome/NativeMessagingHosts/com.vivswan.genkan.host.json
                          system  manifest missing    /Library/Google/Chrome/NativeMessagingHosts/com.vivswan.genkan.host.json
                          user    pointer  ok         /tmp/quickstart-home/Library/Application Support/Google/Chrome/External Extensions/mkjjlmjbcljpcfkfadfmhblmmddkdihf.json
                          system  pointer  missing    /Library/Application Support/Google/Chrome/External Extensions/mkjjlmjbcljpcfkfadfmhblmmddkdihf.json
  chromium  not detected  user    manifest missing    /tmp/quickstart-home/Library/Application Support/Chromium/NativeMessagingHosts/com.vivswan.genkan.host.json
                          system  manifest missing    /Library/Application Support/Chromium/NativeMessagingHosts/com.vivswan.genkan.host.json
                          user    pointer  missing    /tmp/quickstart-home/Library/Application Support/Chromium/External Extensions/mkjjlmjbcljpcfkfadfmhblmmddkdihf.json
                          system  pointer  missing    /Library/Application Support/Google/Chrome/External Extensions/mkjjlmjbcljpcfkfadfmhblmmddkdihf.json
  brave     not detected  user    manifest ok         /tmp/quickstart-home/Library/Application Support/Google/Chrome/NativeMessagingHosts/com.vivswan.genkan.host.json (reads chrome's)
                          system  manifest missing    /Library/Google/Chrome/NativeMessagingHosts/com.vivswan.genkan.host.json (reads chrome's)
                          user    pointer  missing    /tmp/quickstart-home/Library/Application Support/BraveSoftware/Brave-Browser/External Extensions/mkjjlmjbcljpcfkfadfmhblmmddkdihf.json
                          system  pointer  missing    /Library/Application Support/Google/Chrome/External Extensions/mkjjlmjbcljpcfkfadfmhblmmddkdihf.json
  edge      not detected  user    manifest missing    /tmp/quickstart-home/Library/Application Support/Microsoft Edge/NativeMessagingHosts/com.vivswan.genkan.host.json
                          system  manifest missing    /Library/Microsoft/Edge/NativeMessagingHosts/com.vivswan.genkan.host.json
                          user    pointer  missing    /tmp/quickstart-home/Library/Application Support/Microsoft Edge/External Extensions/mkjjlmjbcljpcfkfadfmhblmmddkdihf.json
                          system  pointer  missing    /Library/Application Support/Google/Chrome/External Extensions/mkjjlmjbcljpcfkfadfmhblmmddkdihf.json
  vivaldi   not detected  user    manifest missing    /tmp/quickstart-home/Library/Application Support/Vivaldi/NativeMessagingHosts/com.vivswan.genkan.host.json
                          system  manifest missing    /Library/Application Support/Vivaldi/NativeMessagingHosts/com.vivswan.genkan.host.json
                          user    pointer  missing    /tmp/quickstart-home/Library/Application Support/Vivaldi/External Extensions/mkjjlmjbcljpcfkfadfmhblmmddkdihf.json
                          system  pointer  missing    /Library/Application Support/Google/Chrome/External Extensions/mkjjlmjbcljpcfkfadfmhblmmddkdihf.json
  opera     not detected  user    manifest missing    /tmp/quickstart-home/Library/Application Support/com.operasoftware.Opera/NativeMessagingHosts/com.vivswan.genkan.host.json
                          system  manifest missing    /Library/Google/Chrome/NativeMessagingHosts/com.vivswan.genkan.host.json (reads chrome's)
                          user    pointer  missing    /tmp/quickstart-home/Library/Application Support/com.operasoftware.Opera/External Extensions/mkjjlmjbcljpcfkfadfmhblmmddkdihf.json
                          system  pointer  missing    /Library/Application Support/Google/Chrome/External Extensions/mkjjlmjbcljpcfkfadfmhblmmddkdihf.json

note: the checks above cover the MCP server + native-host bridge only.
They do NOT confirm the Chrome extension is loaded and connected. Verify
that via the Genkan toolbar icon (approve the target site) and
the extension's Service Worker console at chrome://extensions.

OK
  • 捕获在 /tmp/quickstart-home 这个临时用户目录中运行。在你的机器上, 以它开头的路径默认会位于你自己的用户目录下, 而 Linux 和 Windows 会打印各自的位置。
  • 扩展的工具栏图标显示连接状态。
  • 对新站点的第一次工具调用会在浏览器中弹出批准提示; 高风险操作会弹出确认窗口。

推荐的加固 ​

配对 (第 5 步) 在每个平台上都是必需的。登记 (第 6 步) 是推荐项: 没有已登记认证器的浏览器会在确认窗口中回答在场请求 (例如解除紧急开关), 而不是用触碰回答。还有一个可选的仪式用来绑定 MCP 客户端一侧:

  • genkan pair-client 创建受信任客户端白名单。它一旦存在, 只有代码身份经证明且获你批准的 MCP 客户端才会得到服务, 并且任何一个界面都能随时吊销其中一个。

三者均在 cli.md 与安全页面中有说明。

卸载 ​

genkan uninstall 精确移除 --fix 写入的内容 (cli.md 说明了移除什么、拒绝移除什么)。然后按二进制的安装方式移除它:

渠道移除二进制
macOS .pkgsudo rm /usr/local/bin/genkan && sudo pkgutil --forget io.github.vivswan.genkan
Windows .msi设置, 应用, Genkan, 卸载 (它会替你运行 genkan uninstall)
Linux .debsudo dpkg -r genkan
Homebrewbrew uninstall genkan
压缩包删除解压出的目录

配对状态是独立的: genkan revoke --all 删除主机密钥并忘记每一个浏览器和受信任客户端, 扩展的选项页清除其固定的指纹。

第 6 步登记的认证器保存在 trust.json 中。revoke <browser> 忘记在该浏览器标识下登记的认证器; 在共享一份未设置标识的清单时, 这个标识对每个浏览器都是 default, 如 cli.md 所说明。revoke --all 从头来过, 而 doctor 读不了的 trust.json 是故障排除页面的情形。

Built from main at 25ae5f4Source: docs/zh-cn/quickstart.md