repo2page

Windows (winget)

Windows 환경에서는 다음 명령어를 사용하여 설치할 수 있습니다.

winget install repo2page

macOS 및 Linux

Homebrew를 사용하여 설치할 수 있습니다.

brew tap imsncht/homebrew-tap
brew install repo2page

또는 다음 명령어로 설치 스크립트를 실행할 수도 있습니다.

curl -sfL https://raw.githubusercontent.com/imsncht/repo2page/main/scripts/install.sh | sh

소스 코드에서 빌드

Go가 설치된 환경에서 다음 명령어를 사용하여 최신 버전을 설치할 수 있습니다.

go install github.com/imsncht/repo2page/cmd/repo2page@latest

GitHub 저장소 변환

GitHub 저장소를 변환하려면 저장소 경로를 지정합니다. 기본적으로 현재 디렉터리에 Markdown 파일이 생성됩니다.

repo2page user/repo

로컬 디렉터리 변환

로컬 디렉터리를 변환할 때는 해당 경로를 지정합니다.

repo2page ./my-project

주요 CLI 옵션

• --format, -f: 출력 형식 지정 (md, html, txt, json)
• --output, -o: 출력 파일 경로 지정
• --branch, -b: GitHub 저장소의 특정 분枝를 대상으로 설정
• --summary, -s: 디렉터리 트리 구조만 요약 출력
• --exclude, -e: 추가 무시 패턴 지정

활용 예시

로컬 Git 저장소를 HTML 문서로 변환하여 팀원과 공유하거나, 장기 보관을 위한 아카이브 파일로 사용할 수 있습니다. 특정 분枝를 대상으로 문서를 생성하거나, 불필요한 디렉터리를 제외하여 문서화할 수도 있습니다.

지원 환경 및 요구사항

이 도구는 Go 1.23 이상의 환경에서 빌드 및 실행할 수 있습니다. Windows, macOS, Linux 시스템을 지원하며, 공식 바이너리는 GitHub 릴리스 페이지에서 제공됩니다.

제한 사항 및 확인 사항

변환 대상 저장소의 파일 크기는 기본적으로 500KB로 제한되어 있으며, --max-file-size 옵션을 통해 변경할 수 있습니다. 라이선스는 MIT 라이선스를 따릅니다.