AI-Surface

(★ 99)

Find and govern AI attack surfaces in application code at PR time. Free, OSS, runs offline.

  • .gitignore
  • .pre-commit-hooks.yaml
  • action.yml
  • CHANGELOG.md
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • Dockerfile
  • LICENSE
  • pyproject.toml
  • README.md
  • SECURITY.md

# 설치 가이드

1. 코드 내려받기
git clone https://github.com/apisec-inc/AI-Surface

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

cd AI-Surface

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

2. 공식 설치 스크립트

쉬움 추천
사전 준비물
  • pipx Python으로 만든 CLI 도구를 격리된 환경에 설치해주는 도구입니다.
  • Python 3 pip 명령어를 쓰려면 Python이 필요합니다.
pipx install apisec-ai-surface

pipx로 격리된 환경에 CLI 도구를 설치합니다.

pip install apisec-ai-surface && ai-surface scan .

PyPI에 배포된 패키지를 바로 설치합니다. 소스 클론이 필요 없습니다.

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

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

3. Docker

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

Dockerfile을 기반으로 실행 가능한 이미지를 빌드합니다.

docker run -p 8080:80 ai-surface

빌드된 이미지를 실제 컨테이너로 실행합니다.

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

4. Python

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

PyPI에 배포된 패키지를 바로 설치합니다. 소스 클론이 필요 없습니다.

python -m venv .venv

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

pip install -e ".[dev]"

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

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

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

// repository documentation