docs: sync documentation with latest changes (168 tests, metrics, Makefile, pre-commit)
This commit is contained in:
28
README.en.md
28
README.en.md
@@ -157,7 +157,7 @@ curl -X POST http://localhost:8080/webhooks/nexus \
|
||||
|--------|------|-------------|
|
||||
| GET | `/health` | Health check |
|
||||
| GET | `/health/dependencies` | DB and Nexus API connectivity check |
|
||||
| GET | `/metrics` | Prometheus-compatible metrics |
|
||||
| GET | `/metrics` | Prometheus metrics: `guarddog_scans_total`, `guarddog_scans_flagged_total`, `guarddog_findings_total`, `guarddog_llm_analyzed_total`, `guarddog_llm_pending_total`, `guarddog_scans_by_status`, `guarddog_scans_by_ecosystem`, `guarddog_last_scan_timestamp_seconds` |
|
||||
|
||||
## Security
|
||||
|
||||
@@ -168,6 +168,30 @@ curl -X POST http://localhost:8080/webhooks/nexus \
|
||||
- Scan results stored in local SQLite database
|
||||
- Temporary package files deleted after scanning
|
||||
|
||||
## Makefile Targets
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `make install` | Install project dependencies |
|
||||
| `make dev` | Install dev dependencies |
|
||||
| `make test` | Run pytest -v |
|
||||
| `make lint` | Ruff check |
|
||||
| `make format` | Ruff format + fix |
|
||||
| `make typecheck` | mypy strict mode |
|
||||
| `make check` | lint + format + typecheck + test |
|
||||
| `make run` | Start app locally |
|
||||
| `make setup-env` | Copy `.env.example` → `.env` if missing |
|
||||
| `make docker-build` | Build Docker image |
|
||||
| `make docker-up` | Build + start stack |
|
||||
| `make docker-down` | Stop stack |
|
||||
| `make docker-destroy` | Stop + destroy volumes |
|
||||
| `make docker-rebuild` | Down + up --build |
|
||||
| `make docker-logs` | Tail logs |
|
||||
| `make docker-ps` | `docker compose ps` |
|
||||
| `make docker-shell` | Exec bash in guarddog-nexus container |
|
||||
| `make docker-restart` | Restart guarddog-nexus service |
|
||||
| `make clean` | Remove build artifacts |
|
||||
|
||||
## LLM Analysis
|
||||
|
||||
GuardDog Nexus can analyze findings through an LLM. When enabled (`LLM_ENABLED=1`), flagged findings receive an AI breakdown: threat assessment, code analysis, and recommendations.
|
||||
@@ -237,7 +261,7 @@ guarddog-nexus/
|
||||
│ ├── i18n.py # RU/EN translations
|
||||
│ ├── logging_setup.py # JSON structured logging
|
||||
│ └── main.py # FastAPI app entry point
|
||||
├── tests/ # pytest tests (137 tests: 101 unit + 36 e2e)
|
||||
├── tests/ # pytest tests (168 tests)
|
||||
├── scripts/ # Setup scripts
|
||||
├── docker-compose.yml
|
||||
├── Dockerfile
|
||||
|
||||
Reference in New Issue
Block a user