Documentation

JAM 개요

JAM은 빌드 없이 코드베이스의 구조적 위험을 찾고, 파일:라인 단위 finding과 점수 산출 근거를 남기는 CLI입니다.

설치

Linux/macOS dist 릴리스 바이너리를 내려받고 SHA256SUMS로 검증합니다.
curl -fsSL https://jhl-labs.github.io/jam/install.sh | sudo bash

주요 명령

명령역할대표 산출물
jam lite PATHjam-lite 정적 품질 스캔jam-report.md, jam-detail.csv
jam full PATHjam-lite + test/security 합성 점수jam-full.json, 외부 CLI 리포트
jam diff OLD NEWCSV finding ID 기준 회귀 비교added/fixed/unchanged 요약
jam metrics내장 metric registry 출력지표 ID, 버전, 임계값
jam explain ID특정 지표의 설명과 근거 출력threshold, rule reference

출력 파일

jam-lite

jam-report.md는 사람용 요약이고, jam-detail.csv는 모든 finding의 감사 원본입니다. 옵션으로 jam-result.jsonjam.sarif를 생성합니다.

jam-full

jam-full-report.mdjam-full.json에 합성 점수를 기록하고, test/, security/ 아래에 외부 CLI 원본 리포트를 둡니다.

종료 코드

코드의미
0측정 성공, 품질 게이트 통과
1--fail-under, diff, test/security 품질 게이트 실패
2입력, 설정, 스캔, 리포트 작성 실패
3--strict에서 파스 실패 발견
4jam-full 외부 컴포넌트 측정 불가

상세 설계 문서

전체 설계와 샘플 평가는 markdown 문서로 유지합니다.