SuperAPI AI 工具集

environment-setup-guide

部署与运维

查看项目

更新于 10-16 06:03

技能介绍

用途

Environment Setup Guide 用于帮助开发者从零开始搭建完整的开发环境。它提供分步指导,涵盖工具安装、依赖配置、环境变量设置以及安装结果验证。

适用场景包括:

  • 启动新项目、需要搭建开发环境时
  • 新团队成员加入项目、需要环境引导时
  • 更换新机器或操作系统时
  • 排查与环境相关的问题时
  • 为项目编写环境搭建说明文档时

主要能力

该技能按五个步骤组织环境搭建流程:

  1. 识别需求:帮助确定需要安装的内容,包括编程语言及版本(Node.js、Python、Go 等)、包管理器(npm、pip、cargo 等)、数据库系统(PostgreSQL、MongoDB、Redis 等)、开发工具(Git、Docker、IDE 扩展等)、环境变量与配置文件。
  2. 检查当前环境:在安装前检查已安装的工具,例如通过 node --version、python --version、git --version、docker --version 查看版本。
  3. 提供安装指令:给出针对不同平台的安装命令,macOS 使用 Homebrew,Linux 使用 apt、yum 或对应包管理器,Windows 使用 Chocolatey、Scoop 或直接安装程序。
  4. 配置环境:协助设置环境变量(.env 文件)、配置文件(.gitconfig、.npmrc 等)、IDE 设置(VS Code、IntelliJ 等)、Shell 配置(.bashrc、.zshrc 等)。
  5. 验证安装:提供验证步骤,包括运行版本检查、测试基本命令、验证数据库连接、检查环境变量是否加载。

使用方式与示例

技能内置三类完整示例:

  • Node.js 项目搭建:涵盖 macOS(Homebrew)、Linux(Ubuntu/Debian 的 NodeSource 脚本)、Windows(Chocolatey)的安装命令,随后验证版本、克隆仓库、npm install、创建 .env 文件、运行 npm run dev,并附常见问题排查(如 command not found、权限错误)。
  • Python 项目搭建:涵盖三平台 Python 3.11 安装、创建并激活虚拟环境、通过 requirements.txt 安装依赖、设置 .env、运行 Flask 应用。
  • Docker 开发环境:涵盖三平台 Docker 安装、验证版本、编写 docker-compose.yml(含 app 与 db 服务)、启动与停止服务、验证容器与数据库连接。

此外还提供 setup.sh 自动化脚本模板,用于检查前置条件、安装依赖、复制环境文件、运行数据库迁移并验证设置。

最佳实践与限制

技能给出的最佳实践包括:记录所有步骤、使用版本管理器(nvm、pyenv)、创建 .env.example、在干净系统上测试、包含故障排查、使用 Docker 保证环境一致、锁定版本、尽可能自动化、列出前置条件、提供验证步骤。应避免:假设工具已安装、跳过环境变量、用 sudo 运行 npm、忽略平台差异、省略验证、使用全局安装、忽视错误、跳过数据库初始化。

常见陷阱包括安装后 command not found(需重启终端或 source 配置、检查 PATH)、npm/pip 权限错误(不要用 sudo,修复权限或使用 nvm/虚拟环境)、端口被占用(查找并终止进程或换端口)、数据库连接失败(检查服务状态、连接字符串与凭据)。

关于该技能的收费、价格、平台支持范围等具体信息,资料中暂未提供。