Skip to content
iGit Docs

Getting Started

Installation

  1. First, install @doremijs/igit-cli using your preferred package manager:

    Terminal window
    npm install @doremijs/igit-cli

  2. Initialize iGit in your Git project:

    Terminal window
    npx igit init

    Check the generated configuration file .config/igit.yaml and configure it according to your project needs ✨ (The yaml file comes with schema hints for editing 🎉).

  3. Install Git Hooks:

    Terminal window
    npx igit install

  4. Modify code and commit

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

    iGit will execute lint-staged code checks, add emojis, and perform other operations according to the configuration file above.

  5. Try AI-powered commits

    You can use iGit’s AI commit feature, which automatically generates commit messages based on your code. First, you need to add AI-related configuration to the config file, then execute:

    Terminal window
    git add .
    npx igit commit -y

    iGit will automatically summarize your changes and generate a commit message that follows the Conventional Commits specification.

Next Steps