SecurityClaw

(★ 266)

A modular, skill-based autonomous Security Operations Center (SOC) agent that monitors OpenSearch/Elasticsearch data, builds RAG-based behavioral memory, and validates real-time anomalies using LLMs.

  • .all-contributorsrc
  • .env.example
  • .gitattributes
  • .gitignore
  • config.yaml.example
  • docker-compose.yml
  • LICENSE
  • main.py
  • onboard-docker.sh
  • ONBOARDING.md
  • Pipfile
  • pyproject.toml
  • README.md
  • requirements.txt
  • SECURITY.md
  • securityclaw.ps1
  • securityclaw.sh

# 설치 가이드

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

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

cd SecurityClaw

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

2. 공식 설치 스크립트

쉬움 추천
curl -fsSL https://ollama.com/install.sh | sh

공식 설치 스크립트를 다운로드해서 바로 실행합니다. 이 한 줄로 필요한 게 자동으로 설치됩니다.

설치 후 새 터미널을 열고, 프로그램의 버전 확인 명령(예: --version)으로 정상 설치됐는지 확인하세요.

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

3. Docker

쉬움
사전 준비물
  • Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
  • Docker Desktop 컨테이너를 빌드하고 실행하려면 필요합니다. 설치 후 실행해서 백그라운드에 켜두세요.
./securityclaw.sh docker # Docker Compose application

compose 설정 파일에 정의된 서비스들을 대상으로 명령을 실행합니다.

.\securityclaw.ps1 docker # Docker Compose application

compose 설정 파일에 정의된 서비스들을 대상으로 명령을 실행합니다.

터미널에 docker compose ps 를 입력해 컨테이너들이 Up 상태인지 확인하세요. README에 포트 번호가 적혀있다면 브라우저에서 http://localhost:포트번호 로 접속해보세요.

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

4. Node.js

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

이 프로젝트의 관련 파일이 하위 폴더 안에 있어서, 먼저 그 폴더로 이동합니다.

npm install

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

npm start

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

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

5. Python

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

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

.venv/bin/python -m pytest

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

.venv/bin/python -m pytest tests/test_rag.py -v

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

.venv/bin/python -m pytest --cov-report=html

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

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

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

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

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

// repository documentation