🐍 Deep Research Assistant PY: 오픈소스 딥 리서치 CLI 도구 사용 가이드

오픈소스 딥 리서치 CLI 도구 사용 가이드

An AI-powered research tool in Python that helps you explore topics in depth using AI and web search.

안녕하세요! 오늘은 정말 멋진 AI 도구인 "오픈소스 딥 리서치 CLI"에 대해 알아보겠습니다. 이 도구는 마치 여러분의 개인 연구 조교처럼 작동하여 깊이 있는 정보 검색과 분석을 도와줍니다. 함께 이 도구의 구조, 특징, 설치 방법, 그리고 사용법에 대해 자세히 알아볼까요?

1. 프로젝트 구조 이해하기

오픈소스 딥 리서치 CLI의 구조는 다음과 같습니다:

deep_research_py/
├── run.py              # 메인 CLI 인터페이스
├── deep_research.py    # 핵심 연구 로직
├── feedback.py         # 후속 질문 생성
├── prompt.py           # AI용 시스템 프롬프트
└── ai/
    ├── providers.py    # AI 서비스 설정
    └── text_splitter.py # 텍스트 처리 유틸리티

이 구조를 보면, 각 파일이 특정 기능을 담당하고 있어 도구의 작동 방식을 이해하는 데 도움이 됩니다.

2. 주요 특징 살펴보기

오픈소스 딥 리서치 CLI는 다음과 같은 멋진 특징들을 가지고 있습니다:

1. 대화형 연구: 여러분의 요구사항을 더 잘 이해하기 위해 후속 질문을 합니다.
2. 깊이 조절: 연구의 폭과 깊이를 원하는 대로 조절할 수 있습니다.
3. 웹 통합: Firecrawl을 사용하여 신뢰할 수 있는 웹 콘텐츠를 추출합니다.
4. 스마트 종합: 여러 출처의 정보를 일관성 있게 종합합니다.
5. 아름다운 CLI: 진행 상황을 추적할 수 있는 풍부한 텍스트 인터페이스를 제공합니다.
6. 마크다운 보고서: 잘 정리된 연구 보고서를 생성합니다.

이러한 특징들 덕분에 효율적이고 깊이 있는 연구가 가능해집니다.

3. 설치 방법

오픈소스 딥 리서치 CLI를 설치하는 방법은 매우 간단합니다. 다음 명령어를 터미널에 입력하세요:

uv tool install deep-research-py

이 명령어는 uv 도구를 사용하여 deep-research-py를 설치합니다.

4. 설정하기

도구를 사용하기 전에 필요한 API 키를 환경 변수로 설정해야 합니다:

# 필수: OpenAI API 키
export OPENAI_API_KEY=your-openai-key-here

# 필수: Firecrawl API 키
export FIRECRAWL_KEY=your-firecrawl-key-here

만약 다른 OpenAI 호환 API나 자체 호스팅된 Firecrawl을 사용하고 싶다면, 추가 설정이 필요합니다:

# OpenAI 호환 API 엔드포인트 설정 (선택사항)
export OPENAI_API_ENDPOINT="<http://localhost:1234/v1>"

# 다른 모델 사용 시 (선택사항)
export OPENAI_MODEL="<your_model_name>"

# 자체 호스팅 Firecrawl 사용 시 (선택사항)
export FIRECRAWL_BASE_URL="<http://localhost:3002>"

5. 사용 방법

오픈소스 딥 리서치 CLI를 실행하는 방법은 다음과 같습니다:

deep-research

실행하면 다음과 같은 과정을 거치게 됩니다:

1. 연구 주제 입력
2. 연구 폭 설정 (2-10, 기본값 4)
3. 연구 깊이 설정 (1-5, 기본값 2)
4. 후속 질문에 답변
5. 연구 및 보고서 생성 대기

API 속도 제한이 높은 경우, 동시성 수준을 변경할 수 있습니다:

deep-research --concurrency 10

사용 가능한 명령어 목록을 확인하려면:

deep-research --help

6. 개발 환경 설정

개발에 참여하고 싶다면 다음 단계를 따르세요:

# 저장소 복제
git clone <https://github.com/epuerta9/deep-research-py.git>
cd deep-research-py

# 가상 환경 생성 및 활성화
uv venv
source .venv/bin/activate

# 개발 모드로 설치
uv pip install -e .

# API 키 설정
export OPENAI_API_KEY=your-openai-key-here
export FIRECRAWL_KEY=your-firecrawl-key-here

# 도구 실행
deep-research

7. 요구사항

오픈소스 딥 리서치 CLI를 사용하기 위해서는 다음이 필요합니다:

• Python 3.9 이상
• OpenAI API 키 (GPT-4 접근 권한 권장)
• Firecrawl API 키 (웹 검색용)
• 의존성 패키지:
  • openai
  • firecrawl-py
  • typer
  • rich
  • prompt-toolkit
  • aiohttp
  • aiofiles
  • tiktoken

8. 출력 결과

이 도구는 다음과 같은 결과물을 생성합니다:

1. output.md로 저장되는 마크다운 보고서
2. 사용된 출처 목록
3. 주요 발견 사항 요약
4. 주제에 대한 상세 분석

9. 라이선스

이 프로젝트는 MIT 라이선스를 따릅니다.

10. 기여하기

여러분의 기여를 환영합니다! 다음 단계를 따라 기여해 주세요:

1. 저장소를 포크합니다.
2. 기능 브랜치를 만듭니다 (git checkout -b feature/amazing-feature).
3. 개발 의존성을 설치합니다:
4. pip install pre-commit pre-commit install
5. 변경사항을 만듭니다.
6. 변경사항을 커밋합니다 (git commit -m 'Add amazing feature').
7. 브랜치에 푸시합니다 (git push origin feature/amazing-feature).
8. Pull Request를 엽니다.

11. 오픈소스 딥 리서치 CLI 사용 방법 (30단계)

이제 오픈소스 딥 리서치 CLI를 사용하는 방법을 30단계로 자세히 알아보겠습니다.

1. 환경 준비하기: Python 3.9 이상이 설치되어 있는지 확인합니다.
2. 터미널 열기: 컴퓨터의 명령 프롬프트 또는 터미널을 엽니다.
3. uv 설치하기: 아직 uv가 설치되어 있지 않다면, 공식 문서를 참고하여 설치합니다.
4. deep-research-py 설치하기: 터미널에 uv tool install deep-research-py 명령어를 입력하여 도구를 설치합니다.
5. OpenAI API 키 발급받기: OpenAI 웹사이트에서 API 키를 발급받습니다.
6. Firecrawl API 키 발급받기: Firecrawl 웹사이트에서 API 키를 발급받습니다.
7. 환경 변수 설정하기: 터미널에서 다음 명령어를 실행하여 API 키를 환경 변수로 설정합니다:
8. export OPENAI_API_KEY=your-openai-key-here export FIRECRAWL_KEY=your-firecrawl-key-here
9. 도구 실행하기: 터미널에 deep-research 명령어를 입력하여 도구를 실행합니다.
10. 연구 주제 입력하기: 프롬프트가 나타나면 연구하고 싶은 주제를 입력합니다.
11. 연구 폭 설정하기: 2부터 10 사이의 숫자를 입력하여 연구의 폭을 설정합니다. 기본값은 4입니다.
12. 연구 깊이 설정하기: 1부터 5 사이의 숫자를 입력하여 연구의 깊이를 설정합니다. 기본값은 2입니다.
13. 후속 질문에 답변하기: AI가 연구 주제를 더 잘 이해하기 위해 후속 질문을 할 수 있습니다. 이에 답변합니다.
14. 연구 진행 상황 모니터링하기: CLI 인터페이스에 표시되는 진행 상황을 확인합니다.
15. 웹 검색 결과 확인하기: Firecrawl을 통해 수집된 웹 검색 결과를 확인합니다.
16. 정보 종합 과정 관찰하기: AI가 여러 출처의 정보를 어떻게 종합하는지 관찰합니다.
17. 중간 결과 검토하기: 연구 중간에 생성되는 결과물을 검토합니다.
18. 추가 정보 요청하기: 필요한 경우, 추가 정보나 설명을 요청합니다.
19. 연구 방향 조정하기: 중간 결과를 바탕으로 연구 방향을 조정할 수 있습니다.
20. 최종 보고서 생성 대기하기: AI가 최종 보고서를 생성하는 동안 기다립니다.
21. 출력 파일 확인하기: 생성된 output.md 파일을 확인합니다.
22. 마크다운 보고서 열기: 텍스트 편집기나 마크다운 뷰어로 보고서를 엽니다.
23. 보고서 구조 파악하기: 보고서의 목차, 주요 섹션을 파악합니다.
24. 주요 발견 사항 검토하기: 보고서에서 강조된 주요 발견 사항을 주의 깊게 읽습니다.
25. 상세 분석 내용 확인하기: 주제에 대한 상세 분석 내용을 꼼꼼히 확인합니다.
26. 사용된 출처 확인하기: 보고서 끝에 있는 출처 목록을 확인합니다.
27. 추가 연구 필요성 판단하기: 보고서를 바탕으로 추가 연구가 필요한지 판단합니다.
28. 보고서 편집하기: 필요한 경우, 보고서 내용을 편집하거나 보완합니다.
29. 결과 공유하기: 생성된 보고서를 동료나 팀원과 공유합니다.
30. 피드백 수집하기: 보고서에 대한 다른 사람들의 의견을 수집합니다.
31. 도구 개선에 기여하기: 사용 경험을 바탕으로 오픈소스 프로젝트에 기여할 방법을 고민합니다.

이렇게 30단계를 통해 오픈소스 딥 리서치 CLI를 효과적으로 사용할 수 있습니다. 각 단계를 차근차근 따라가면서 도구의 기능을 최대한 활용해 보세요. 연구 주제에 따라 설정을 조정하고, 결과를 꼼꼼히 검토하는 것이 중요합니다. 이 도구를 통해 여러분의 연구나 학습이 한층 더 깊이 있고 효율적으로 이루어질 수 있기를 바랍니다.

---