跳转到内容
iGit 文档

快速开始

安装

  1. 首先，使用你喜欢的包管理器安装 @doremijs/igit-cli：

    Terminal window
    npm install @doremijs/igit-cli

  2. 在你的 Git 项目中初始化 iGit：

    Terminal window
    npx igit init

    查看生成的配置文件 .config/igit.yaml，根据项目情况进行配置 ✨（yaml 文件也有 schema 编写提示哦 🎉）。

  3. 安装 Git Hooks：

    Terminal window
    npx igit install

  4. 修改代码并提交

    Terminal window
    # update some code
    git add .
    git commit -m "feat: update some code"

    iGit 会根据上面的配置文件执行 lint-staged 代码检查、添加 emoji 等操作。

  5. 尝试使用 AI 提交

    你可以使用 iGit 的 AI 提交功能，它会根据你的代码自动生成提交信息，首先你需要在配置文件中追加 AI 相关配置，然后执行。

    Terminal window
    git add .
    npx igit commit -y

    iGit 会自动帮你总结提交信息，并生成符合约定式提交规范的提交信息。

下一步