Skip to content

Installation Documentation

System Requirements

Component Minimum Recommended
RAM 4GB 8GB+
CPU 2 cores 4+ cores
Disk Space 500MB 1GB+
Internet Required Required
Browser Modern (Chrome recommended) Latest Chrome

Installation Methods

uv package manager

Prerequisites
  • uv package manager (installation instructions here)
  • git
Clone repository
git clone https://github.com/stellarcyber/detection_coverage_app.git
cd detection_coverage_app
Run with uv

uv run coverage-analyzer
or
uv run run.py
or
uv run streamlit run app.py

Install as a CLI tool

uv tool install --editable ./
When completed, you can run the app from anywhere in your terminal (not just within the project directory):
coverage-analyzer
or (for headless environments)
coverage-analyzer --headless

manual pip/python

Prerequisites
  • python >= 3.10
  • pip
  • git
Clone repository
git clone https://github.com/stellarcyber/detection_coverage_app.git
cd detection_coverage_app
Create and activate virtual environment

python3 -m venv .venv
source .venv/bin/activate  # Unix/macOS
or
.venv\Scripts\activate     # Windows

Install dependencies
pip install -r requirements.txt
Run using streamlit

streamlit run app.py
or
python run.py

Docker

Prerequisites
  • Docker
  • git
Clone repository
git clone https://github.com/stellarcyber/detection_coverage_app.git
cd detection_coverage_app
Build the image
docker build -t coverage_analyzer .
Run the image
docker run -p 8501:8501 coverage-analyzer

Troubleshooting

Common Issues

  1. Browser Launch Fails
  2. Use headless mode: coverage-analyzer --headless
  3. Access via URL: http://localhost:8501
  4. Port Conflicts
    # Check port usage
    lsof -i :8501      # Unix/macOS
    netstat -ano | findstr :8501  # Windows
    
    # Use different port
    export STREAMLIT_SERVER_PORT=8502