Quick start (local)

Install the Python package, index a folder, and search — no LLM required.

pip install -e ".[dev]"
python -m codesight index ./your-documents
python -m codesight search "payment terms" ./your-documents
python -m codesight status ./your-documents

Optional Streamlit demo: pip install -e ".[demo]" && python -m codesight demo

Production browser UI: pip install -e ".[server]" then see Docker below.

Supported files

Docker deployment

Single-team pilot: FastAPI on port 8000, read-only /data, persistent /index volume, API key required.

export CODESIGHT_API_KEY=$(openssl rand -hex 24)
export CODESIGHT_DOCUMENTS_HOST_DIR=/path/to/customer/docs
docker compose up --build -d
# Open http://localhost:8000 — enter API key, Re-index, then search

The compose file mounts CODESIGHT_DOCUMENTS_HOST_DIR at /data:ro; replace the example path with the customer document folder.

Operations

Health

curl -s http://localhost:8000/api/health | jq

Backup index volume

docker run --rm -v holusight-index:/index -v $(pwd):/backup alpine \
  tar czf /backup/holusight-index.tar.gz -C /index .

Upgrade

git pull && docker compose build && docker compose up -d

Stopping the container stops the API; the index remains on the volume until you docker compose down -v.

Security model (v1)

• Shared API key per deployment (X-API-Key or Bearer token)
• Source documents mounted read-only — engine never writes to /data
• Path validation on folder roots; FTS query sanitization
• Planned: SSO, per-document ACLs — not in v1 pilot

Citations

Every search result includes file_path, start_line, end_line, scope, and snippet. Document pages use page numbers in line fields; code uses line numbers.

Limitations & roadmap

FAQ