iTerm-MCP 项目使用教程

1. 项目目录结构及介绍

iTerm-MCP 是一个开源项目，它提供了一个 Model Context Protocol (MCP) 服务器，允许模型访问当前的 iTerm 会话。以下是项目的目录结构及其说明：

iterm-mcp/
├── .github/             # GitHub 工作流和配置文件
├── images/              # 项目相关图片资源
├── src/                 # 源代码目录
│   ├── ...              # 源代码文件
├── test/                # 测试代码目录
├── .gitignore           # Git 忽略文件
├── LICENSE.md           # 项目许可证文件
├── README.md            # 项目说明文件
├── package.json         # 项目依赖和配置文件
├── tsconfig.json        # TypeScript 配置文件
└── yarn.lock            # 项目依赖锁定文件

• .github/：包含项目在 GitHub 上的自动化工作流文件。
• images/：存储项目相关的图像文件。
• src/：存放项目的主要源代码。
• test/：存放测试代码，用于验证功能的正确性。
• .gitignore：定义了 Git 忽略的文件和目录列表，以避免将不必要的文件提交到版本控制。
• LICENSE.md：包含了项目的许可证信息，通常是 MIT 许可。
• README.md：提供了项目的基本信息，包括用途、特性、安装和配置说明。
• package.json：包含了项目的依赖项、脚本和元数据。
• tsconfig.json：TypeScript 配置文件，用于指定编译选项。
• yarn.lock：锁定项目的依赖版本，确保环境一致性。

2. 项目的启动文件介绍

项目的启动主要通过 package.json 文件中的脚本实现。以下是一些主要的启动脚本：

• yarn install：安装项目依赖。
• yarn run build：构建项目，通常是将 TypeScript 代码编译为 JavaScript。
• yarn run watch：监视源代码变化，并在变化时重新构建项目。

具体启动项目的命令可能依赖于 src/ 目录中的主入口文件，通常是一个 index.ts 或 main.ts 文件。

3. 项目的配置文件介绍

项目的主要配置文件是 package.json 和 tsconfig.json。

• package.json：此文件包含了项目的名称、版本、描述、依赖项、脚本和其他元数据。其中的 scripts 字段定义了一系列可执行的命令，例如启动开发服务器、构建项目等。

• tsconfig.json：此文件用于配置 TypeScript 编译器。它定义了项目的编译选项，如模块系统、目标代码版本、类型检查等。这对于确保 TypeScript 代码能够正确编译为兼容的 JavaScript 代码至关重要。

通过正确理解和使用这些配置文件，可以确保项目能够顺利运行并保持其功能的一致性。