CrabRAG

(★ 114)

Production-ready local RAG system with incremental indexing, atomic index generations, ACL-aware retrieval, GraphRAG, and local/API model support.

  • .gitattributes
  • .gitignore
  • bun.lock
  • CHANGELOG.md
  • crab-rag.bat
  • crabrag.skill
  • GOVERNANCE_ARCHITECTURE.md
  • install.ps1
  • install.sh
  • LICENSE
  • package.json
  • README.md
  • README_PORTABLE.md
  • README_ZH.md
  • requirements-dev.txt
  • requirements.txt
  • run.ps1
  • run.sh
  • start.bat
  • stop.bat
  • VERSION

# 설치 가이드

1. 코드 내려받기
git clone https://github.com/guoyijia22/CrabRAG

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd CrabRAG

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Node.js

쉬움 추천
사전 준비물
  • Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
  • Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.
npm install

package.json에 명시된 라이브러리들을 내려받아 설치합니다.

npm start

개발/실행 서버를 켭니다.

명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

3. Python

쉬움
사전 준비물
  • Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
  • Python 3 설치 시 'Add Python to PATH' 옵션을 꼭 체크하세요 (Windows).
sudo apt update && sudo apt install -y python3 python3-venv python3-pip

파이썬 스크립트(또는 모듈)를 실행합니다.

sudo dnf install -y python3 python3-pip

파이썬 스크립트(또는 모듈)를 실행합니다.

.\.venv\Scripts\python.exe -m pip install -r requirements.txt

requirements.txt 등에 명시된 파이썬 라이브러리를 설치합니다.

./.venv/bin/python -m pip install -r requirements.txt

requirements.txt 등에 명시된 파이썬 라이브러리를 설치합니다.

.\.venv\Scripts\python.exe -m pip install -r requirements-dev.txt

requirements.txt 등에 명시된 파이썬 라이브러리를 설치합니다.

에러 메시지 없이 실행되고 터미널에 안내 문구가 출력되면 정상입니다.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation