Reading the repo
Opening the box…
Reading the repo
Opening the box…
How to install on Windows
Saved setup from 2 min ago
Will it work on Windows?
winget install Git.Git) or WSL2 (wsl --install).Heads-upIt also needs 13 settings in .env (1 secret).
The maintainers included scripts/install.sh. Run it from the cloned folder after reading it.
bash scripts/install.sh
Then run powershell -ExecutionPolicy Bypass -File .\setup.ps1. It stops at the first error and is safe to run again. Servers and tests aren't started; it lists them at the end. Read it first.
Needs Git: winget install Git.Git
git clone https://github.com/alaeddine-zen/Open-vision-shield.git cd Open-vision-shield
Python >=3.12
winget install Python.Python.3.12
Fill in secrets: API_KEY
Copy-Item .env.example .env
python -m venv .venv .venv\Scripts\Activate.ps1 pip install -e .
pytest
The steps run shell scripts (.sh). Use Git Bash (winget install Git.Git) or WSL2 (wsl --install).
git clone https://github.com/alaeddine-zen/Open-vision-shield.git
cd Open-vision-shield
bash scripts/install.sh
source .venv/bin/activate
cp .env.example .env
# Generate a secure API key:
openssl rand -hex 32
# Paste the result as API_KEY in .env
bash scripts/download_model.sh
This fetches model.onnx from Hugging Face and verifies its SHA256 checksum.
uvicorn app.main:app --host 127.0.0.1 --port 8080 --reload
curl http://127.0.0.1:8080/health
curl -X POST http://127.0.0.1:8080/v1/images:moderate \
-H "Authorization: Bearer YOUR_API_KEY" \
-F "image=@photo.jpg"
Example response:
{
"adult": true,
"score": 0.9341,
"processing_ms": 87
}
No reports for Windows yet.
GitManual AI Agent reads the 3 key files and writes a step-by-step guide for Windows. Once written, it's saved for everyone.