Skip to content

安装指南

本指南将帮助您安装和配置 gm-mcp 脚手架工具。

系统要求

  • Node.js >= 16.0.0
  • npm >= 7.0.0 或 yarn >= 1.22.0

安装方法

方法一:全局安装(推荐)

bash
npm install -g @studiogm/gm-mcp

这是最简单的方法,安装后可以在任何地方使用 gm-mcp 命令。

方法二:使用npx(无需安装)

bash
npx gm-mcp init my-project

每次使用时会自动下载最新版本,适合偶尔使用的场景。

方法三:从源码安装

bash
# 克隆仓库
git clone https://github.com/studiogmls/gm-mcp.git
cd gm-mcp

# 安装依赖
npm install

# 构建项目
npm run build

# 全局链接
npm link

验证安装

安装完成后,运行以下命令验证安装是否成功:

bash
gm-mcp --version

如果显示版本号,说明安装成功。

查看帮助

bash
gm-mcp --help

这将显示所有可用的命令和选项。

更新

检查更新

bash
gm-mcp update

手动更新

bash
npm update -g @studiogm/gm-mcp

卸载

如果需要卸载 gm-mcp:

bash
npm uninstall -g @studiogm/gm-mcp

故障排除

权限问题

如果遇到权限错误,可以尝试:

bash
# 使用sudo(macOS/Linux)
sudo npm install -g @studiogm/gm-mcp

# 或者配置npm使用不同的目录
npm config set prefix ~/.npm-global
export PATH=~/.npm-global/bin:$PATH

网络问题

如果下载速度慢,可以配置npm镜像:

bash
npm config set registry https://registry.npmmirror.com

版本冲突

如果遇到版本冲突,可以:

bash
# 查看已安装的版本
npm list -g @studiogm/gm-mcp

# 强制重新安装
npm uninstall -g @studiogm/gm-mcp
npm install -g @studiogm/gm-mcp

下一步

安装完成后,您可以:

基于 MIT 许可证发布