다운로드

cardstream 실행하기

macOS와 Linux에서는 명령어 하나면 됩니다. 더 세밀하게 제어하고 싶다면 릴리스 wheel, Dockerfile, 소스 빌드를 쓸 수 있습니다. macOS arm64, Linux amd64, Windows amd64 모두 같은 순수 Python 릴리스로 지원됩니다.

설치 스크립트

명령어 하나로 설치

~/.cardstream에 가상 환경(venv)을 만들고, 릴리스 wheel을 체크섬과 대조해 검증한 뒤, 모델 가중치를 받아 cardstream-web과 cardstream-client를 PATH에 올려 줍니다. uv가 설치되어 있으면 그것을 사용합니다.

$ curl -fsSL https://raw.githubusercontent.com/Ximilar-com/cardstream/main/scripts/install.sh | sh
$ export XIMILAR_API_KEY=your-key
$ cardstream-web
# → http://127.0.0.1:8001 — 카드를 들어 보세요

필요하다면 쓸 수 있는 설정

CARDSTREAM_VERSION — latest 대신 특정 릴리스 태그를 고정합니다(예: v0.5.0)
CARDSTREAM_HOME — venv와 모델을 담는 설치 루트(기본값 ~/.cardstream)
INSTALL_DIR — cardstream-web / cardstream-client 심 스크립트가 놓이는 위치(기본값 ~/.local/bin)
CARDSTREAM_MODELS_BASE_URL — 모델별 가중치 tarball을 받을 대체 호스트
CARDSTREAM_MODEL_ARCHIVES — 그곳에서 받아올 tarball 목록(공백으로 구분)
CARDSTREAM_EXTRAS — 설치할 pip extras(기본값 client,onnx)
CARDSTREAM_TRACKER_URL — 옵트인 vitTracker .onnx(기본값: OpenCV zoo)

검증

설치 검증하기

스크립트는 무엇이든 설치하기 전에 wheel을 릴리스의 SHA256SUMS와 대조합니다. 설치 후에는 플래그 하나로 컴퓨터에 무엇이 들어 있는지 확인할 수 있습니다:

$ cardstream-web --version
cardstream 0.5.0

산출물을 직접 다운로드했나요? 스크립트와 같은 방법으로 확인하세요: shasum -a 256 -c SHA256SUMS.

수동 다운로드

릴리스에서 바로

패키지는 PyPI에 있고, 모든 GitHub 릴리스에도 같은 wheel과 sdist가 SHA256SUMS와 나란히 올라갑니다. 순수 Python wheel 하나가 모든 플랫폼을 지원합니다:

$ pip install 'cardstream[client,onnx]'

Windows

설치 스크립트는 POSIX 전용입니다. Windows에서는 PyPI에서 설치하고, 모델 릴리스에서 모델별 가중치 tarball을 풀어 플래그로 그 위치를 지정하세요:

> py -3.11 -m venv cardstream-env
> cardstream-env\Scripts\activate
> pip install 'cardstream[client,onnx]'
> set XIMILAR_API_KEY=your-key
> cardstream-web --segmentor-model models\segmentation_model\onnx\model.onnx ^
    --embed-model models\similarity_model\onnx\model.onnx

비교

방법 고르기

방법	이럴 때 적합	첫 검증
설치 스크립트	localhost에서 가장 빠르게 설정하고 싶을 때. venv, 모델 가중치, PATH 심 스크립트를 모두 알아서 처리합니다.	`cardstream-web --version`
Docker	깨끗한 호스트가 필요할 때, 또는 인코더 근처의 머신에서 OBS push를 받을 때.	`curl -s http://127.0.0.1:8001/mode`
소스에서 빌드	코드를 수정할 때.	`pytest -q tests/core/test_engine.py`

Docker

컨테이너에서 실행

이미지는 첫 실행 때 모델 가중치를 볼륨에 받아 두고 웹 클라이언트를 시작합니다. 저장소의 Dockerfile로 빌드하세요:

$ git clone https://github.com/Ximilar-com/cardstream && cd cardstream
$ docker build -t cardstream .
$ docker run --rm -e XIMILAR_API_KEY -p 127.0.0.1:8001:8001 \
    -v cardstream-models:/models cardstream

컨테이너는 내부적으로 0.0.0.0에 바인딩됩니다. 위와 같이 포트를 127.0.0.1에만 공개하세요. 이 앱은 인증이 없고 Ximilar API 키를 갖고 있으므로 LAN이나 인터넷에 절대 노출하지 마세요.

소스

소스에서 빌드

체크아웃 하나, 스크립트 하나, 그리고 첫 검증으로 오프라인 테스트 스위트를 돌립니다. --models를 붙이면 가중치도 함께 받습니다.

$ git clone https://github.com/Ximilar-com/cardstream && cd cardstream
$ ./scripts/build-from-source.sh --models
$ source .venv/bin/activate
$ cardstream-web --version

cardstream 실행하기

명령어 하나로 설치

필요하다면 쓸 수 있는 설정

설치 검증하기

릴리스에서 바로

Windows

방법 고르기

컨테이너에서 실행

소스에서 빌드

다음 단계

설치하고 실행하기 →

방송 영상 넣기 →

안심하고 운영하기 →

업데이트 또는 제거 →