项目简介

Shellwright是一个为AI代理设计的终端自动化MCP服务器,类似于"Playwright for the shell"。它允许AI通过标准化的工具调用,在真实的终端环境中执行命令、截图和录制操作视频。

主要功能

  • 终端会话管理:启动和管理多个终端会话
  • 命令执行:向终端发送输入命令和按键序列
  • 屏幕截图:捕获终端当前状态并保存为PNG图片
  • 视频录制:录制终端操作过程并生成GIF动画
  • 多种输出格式:同时生成PNG、SVG、ANSI和纯文本格式
  • 主题支持:提供多种终端颜色主题(one-dark、one-light、dracula等)
  • 文件服务:通过HTTP提供截图和录屏文件的下载

安装步骤

  1. 确保系统已安装Node.js环境
  2. 通过npm安装Shellwright:'npx @dwmkerr/shellwright'
  • 或者本地安装:'npm install @dwmkerr/shellwright

服务器配置

在MCP客户端配置文件中添加以下设置:

{
  "mcpServers": {
    "shellwright": {
      "command": "npx",
      "args": ["-y", "@dwmkerr/shellwright"]
}

配置参数说明

  • 使用npx命令直接运行最新版本的Shellwright
  • "-y"参数表示自动确认安装提示

基本使用方法

  1. 配置好MCP客户端后,AI代理就可以使用Shellwright的工具了
  2. 通过自然语言指令控制终端,如:"打开Vim,输入如何关闭Vim的说明,然后关闭Vim,截图并录制整个过程"
  3. 所有截图和录屏文件默认保存在'./output'目录

常用操作流程

  • 先启动终端会话(shell_start)
  • 发送命令和按键(shell_send)
  • 可随时截图(shell_screenshot)
  • 可开始和停止录制(shell_record_start/stop)
  • 最后停止会话(shell_stop)

信息

分类

开发者工具