JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 26
  • Score
    100M100P100Q58173F
  • License ISC

AI git commit message generator (OpenAI / Claude)

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (smart-msg) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    smart-msg

    AI 기반 Git 커밋 메시지 자동 생성 도구

    staged 된 git diff 를 분석하여 Conventional Commit 형식의 메시지를 자동으로 생성합니다.
    OpenAI 와 Anthropic Claude 를 지원하며, 한국어와 영어 출력을 모두 제공합니다.


    version license node OpenAI Claude


    git add .
sm c

    위 두 명령으로 staged 변경분에 대한 커밋 메시지가 추천되며, 확인 후 커밋이 진행됩니다.

    $ sm c

생성된 커밋 메시지:
feat(auth): add OAuth login flow

? 이 메시지로 커밋을 진행하시겠습니까? › (Y/n)

    목차


    설치

    npm 글로벌 설치 (권장)

    npm install -g smart-msg

    특정 버전을 고정하려면 @ 뒤에 버전을 명시합니다.

    npm install -g smart-msg@1.0.0

    설치 시 prepare 스크립트가 자동으로 빌드를 수행하므로 별도의 후속 절차는 필요하지 않습니다.

    GitHub repository 직접 설치

    GitHub Releases 의 tag 를 통해 동일한 시점을 설치할 수 있습니다. npm registry 에 접근하지 않는 환경에서 사용합니다.

    # 최신 main 브랜치 시점
npm install -g git+https://github.com/black-astro/smart-msg.git

# 특정 tag (npm 버전과 동일하게 동기화됨)
npm install -g git+https://github.com/black-astro/smart-msg.git#v1.0.0

    [!NOTE] npm 의 @1.0.0 과 GitHub 의 #v1.0.0 은 동일한 코드 시점을 가리킵니다. 어느 방식을 선택하더라도 결과는 같습니다.

    프로젝트 로컬 설치 (선택)

    특정 프로젝트에서만 사용하고자 하는 경우 devDependency 로 추가하는 방식도 가능합니다.

    npm install --save-dev smart-msg

    이 경우 명령은 npx sm 형식으로 실행합니다.

    npx sm c

    [!TIP] 글로벌 설치가 표준 사용 방식입니다. 로컬 설치는 팀 단위로 동일한 버전을 강제하고자 할 때 또는 글로벌 설치 권한이 없는 환경에서만 권장됩니다.

    설치 확인

    sm --version

    지원 환경

    smart-msg 는 git 명령이 동작하는 모든 환경에서 동일하게 사용할 수 있습니다. Node.js 18 이상이 설치되어 있어야 합니다.

    터미널

    환경 사용 방법 비고
    Git Bash (Windows) sm 명령을 그대로 사용 별도 설정 없음
    PowerShell sm 명령을 그대로 사용 실행 정책 관련 주의사항은 아래 참조
    Windows CMD sm 명령을 그대로 사용 별도 설정 없음
    macOS Terminal / iTerm2 sm 명령을 그대로 사용 별도 설정 없음
    Linux Bash / Zsh sm 명령을 그대로 사용 별도 설정 없음

    PowerShell 실행 정책

    npm 글로벌 설치 시 npm 이 자동으로 생성하는 sm.ps1 래퍼 스크립트가 PowerShell 실행 정책에 의해 차단되는 경우가 있습니다. 차단 메시지가 발생하면 다음 명령으로 정책을 완화합니다.

    # 현재 사용자 한정으로 RemoteSigned 정책 적용 (권장)
Set-ExecutionPolicy -Scope CurrentUser -ExecutionPolicy RemoteSigned

    이 정책은 로컬에서 작성된 스크립트는 그대로 허용하고, 인터넷에서 받은 스크립트는 서명을 요구하므로 보안과 사용성의 균형이 잡혀 있습니다.


    IDE 통합

    IDE 사용 방법
    IntelliJ IDEA / WebStorm / PyCharm 내장 터미널 (Alt + F12) 에서 sm 명령 사용. 커밋 창 통합은 sm install-hook 설치 후 Ctrl + K 로 동작
    VS Code 내장 터미널 (Ctrl + `) 에서 sm 명령 사용. Source Control 패널의 commit 통합은 sm install-hook 설치 후 동작
    Cursor / Trae 등 VS Code 기반 IDE VS Code 와 동일하게 동작
    기타 IDE / 에디터 내장 터미널이 있는 모든 IDE 에서 동일하게 사용 가능

    IntelliJ 커밋 창 통합

    sm install-hook 을 프로젝트에 설치한 뒤 Ctrl + K 로 IntelliJ 커밋 창을 열면, 메시지 입력란에 AI 가 생성한 커밋 메시지가 자동으로 채워집니다. 메시지 검토 후 그대로 commit 하거나 수정하여 commit 합니다.

    VS Code Source Control 통합

    sm install-hook 설치 후 좌측 Source Control 패널 (Ctrl + Shift + G) 에서 변경사항을 stage 하고 commit 명령을 실행하면, 메시지 입력란에 AI 가 생성한 메시지가 자동으로 채워집니다.

    [!TIP] IDE 통합은 git hook 을 통해 동작합니다. sm login 의 마지막 단계에서 자동으로 hook 설치 여부를 묻거나, 추후 sm install-hook 명령으로 직접 설치할 수 있습니다.


    Java / Python / Go 등 비 Node.js 프로젝트

    smart-msg 는 글로벌 CLI 이므로 프로젝트 언어와 무관하게 동작합니다. Java / Spring, Python / Django, Go 등 어떤 프로젝트에서도 동일하게 sm c 명령으로 사용할 수 있습니다. node_modules 폴더가 프로젝트 안에 생성되지 않습니다.

    동작 환경

    • Node.js 18 이상
    • git 2.x 이상
    • Windows / macOS / Linux 모두 지원

    설치가 완료되면 다음 명령으로 동작을 확인할 수 있습니다.

    sm --version

    [!NOTE] 설치 직후 최초 설정 단계로 진행하시기 바랍니다. sm login 의 마지막 단계에서 현재 프로젝트가 git 저장소인 경우 자동으로 hook 설치 여부를 묻습니다. 이 흐름을 따르면 IDE 커밋 창 통합까지 한 번에 완료됩니다.


    최초 설정

    sm login

    다음 네 가지 항목을 차례로 선택합니다.

    단계 항목 선택지
    1 AI provider OpenAI / Anthropic Claude
    2 모델 provider 별 권장 모델 목록
    3 출력 언어 한국어 / 영어
    4 메시지 강도 simple / middle / hard

    선택이 완료되면 브라우저에서 API 키 발급 페이지가 자동으로 열립니다. 키 발급 후 입력란에 입력하여 등록을 마칩니다.

    [!NOTE] 설정은 ~/.smart-msg/config.json 에 저장되며, 모든 프로젝트에서 동일하게 사용됩니다. 최초 1회만 수행하면 됩니다.


    기본 사용법

    1. 변경사항 스테이징

    git add .

    2. 커밋 실행

    sm c

    생성된 메시지가 출력되며, 확인 입력 후 자동으로 커밋이 진행됩니다.


    명령어

    명령 설명
    sm login provider, 모델, 언어, 강도, API 키를 처음 설정합니다
    sm c (= sm commit) staged diff 를 기반으로 메시지를 생성하고 커밋합니다
    sm config 언어, 강도, 모델 설정을 변경합니다
    sm status 현재 저장된 설정을 출력합니다
    sm install-hook 현재 프로젝트에 git prepare-commit-msg hook 을 설치합니다
    sm logout 저장된 API 키를 제거합니다
    sm uninstall 모든 설정 및 hook 을 제거합니다

    옵션

    Language

    값 출력 언어
    ko 한국어 (feat, fix 등 type 키워드는 영어 유지)
    en 영어

    Strength

    메시지의 길이와 상세도를 결정합니다.

    simple  —  한 줄 (Conventional Commit 형식) 
    feat(auth): add OAuth login flow
    middle  —  첫 줄 + 본문 2~5줄 
    feat(auth): add OAuth login flow

- PKCE 기반 OAuth 콜백 처리 추가
- 로컬 콜백 서버를 임시로 생성
- 발급된 토큰을 ~/.smart-msg/config.json 에 저장
    hard  —  첫 줄 + README 수준 본문 
    feat(auth): add OAuth login flow

기존 API 키 입력 방식은 매번 발급 페이지로 이동하여 복사 및 붙여넣기를
수행하는 부담이 있었습니다. 표준 OAuth 흐름을 도입하여 이를 해소합니다.

- PKCE flow 로 토큰을 안전하게 획득
- 로컬 8765 포트에 임시 콜백 서버 운영
- 토큰은 OS keychain 에 보관
- 토큰 만료 시 자동 갱신

영향: 기존 API 키 사용자의 동작은 변경되지 않습니다.

    설정 변경

    sm config

    메뉴에서 언어, 강도, 모델 중 하나를 선택하여 변경합니다.


    Git Hook

    기본 사용 방식은 sm c 명령이지만, IntelliJ 의 커밋 창이나 VS Code 의 commit 창과 같이 IDE 내부에서 git commit 을 호출하는 환경에서는 hook 을 설치해야 자동 메시지 생성이 동작합니다.

    cd /path/to/project
sm install-hook
    상황 동작
    git commit  (메시지 미지정) AI 가 메시지를 자동 생성합니다
    IntelliJ 커밋 창 AI 가 메시지를 자동 생성합니다
    git commit -m "..." hook 이 비켜서며 사용자 메시지를 우선합니다
    git commit --amend 기존 메시지를 보호합니다
    merge / squash 커밋 보호합니다
    AI 호출 실패 커밋 자체는 정상 진행됩니다
    staged 변경 없음 AI 를 호출하지 않습니다

    [!TIP] hook 은 프로젝트당 1회만 설치하면 됩니다. 설치된 hook 은 sm uninstall 실행 시 한꺼번에 제거됩니다.


    제거

    sm uninstall

    설정 디렉토리(~/.smart-msg/)와 설치된 hook 을 모두 제거합니다.


    License

    ISC


    Built with TypeScript  ·  Powered by OpenAI & Anthropic Claude