eli64s/readme-ai

어떤 프로젝트인가요?

핵심 기능

• 01GitHub, GitLab, Bitbucket URL 또는 로컬 디렉터리에서 README 파일을 생성합니다.
• 02LLM 제공자로 OpenAI, Anthropic, Google Gemini, Ollama를 지원합니다.
• 03LLM API 서비스가 필요 없는 오프라인 모드를 제공합니다.
• 04CLI 옵션으로 헤더, 탐색 메뉴, 배지, 로고, 이모지를 사용자 지정합니다.
• 05.readmeaiignore 파일을 사용해 분석에서 제외할 파일을 지정합니다.

활용 사례

• 문서가 없는 새 프로젝트의 README를 처음 작성할 때.
• 여러 저장소의 오래된 README 파일을 갱신할 때.
• Ollama를 통해 로컬 모델을 사용해 비공개 코드베이스의 문서를 생성할 때.

빠른 시작

1. 1

   README의 Getting Started 섹션에 따라 ReadmeAI를 설치합니다

2. 2

   저장소 URL을 전달해 README를 생성합니다

   readmeai --repository https://github.com/eli64s/readme-ai

사용 전 알아둘 점

• !LLM 생성 결과를 사용하려면 OpenAI, Anthropic, Gemini와 같은 제공자의 API 키 또는 로컬 Ollama 환경이 필요합니다.

포함된 컬렉션

토픽

자주 묻는 질문

readme-ai은(는) 무엇인가요?

LLM을 사용하거나 API 키 없이 오프라인으로 저장소의 README 파일을 생성하는 CLI 도구입니다. ReadmeAI는 코드베이스를 분석해 README 파일을 작성하는 명령줄 도구입니다. GitHub, GitLab, Bitbucket URL이나 로컬 디렉터리를 지정하면 프로젝트 구조, 의존성, 사용 정보를 추출해 체계적인 README를 생성합니다.

readme-ai은(는) 무료로 사용할 수 있나요? 라이선스는 무엇인가요?

readme-ai은(는) MIT 라이선스의 오픈소스입니다. 상업용 제품에 사용하기 전에 라이선스 조건을 확인하세요.

readme-ai은(는) 아직 유지보수되고 있나요?

활발히 유지보수 중. readme-ai의 마지막 커밋은 2026년 11월 4일입니다.

readme-ai은(는) 어디에 사용할 수 있나요?

문서가 없는 새 프로젝트의 README를 처음 작성할 때. 여러 저장소의 오래된 README 파일을 갱신할 때. Ollama를 통해 로컬 모델을 사용해 비공개 코드베이스의 문서를 생성할 때.

readme-ai는 어떻게 설치하나요?

README의 Getting Started 섹션에 따라 ReadmeAI를 설치합니다 저장소 URL을 전달해 README를 생성합니다: readmeai --repository https://github.com/eli64s/readme-ai

readme-ai은(는) 어디서 받을 수 있나요?

소스 코드와 설치 방법은 GitHub에 있습니다: https://github.com/eli64s/readme-ai