ossguard
v0.1.4
Published
One CLI to guard any OSS project with OpenSSF security best practices — bootstrap, scan, and monitor.
Downloads
1,101
Maintainers
Readme
OSSGuard — Node.js Implementation
The TypeScript/Node.js implementation of OSSGuard.
Native TypeScript implementation — runs on Node.js 18+, zero-install via npx.
For full documentation, all install methods, and command examples, see the main ossguard repo.
Install
npm install -g ossguardQuick Start
# Initialize security configs (SECURITY.md, Scorecard, Dependabot, CodeQL, SBOM, Sigstore)
ossguard init
# Run a full security audit
ossguard audit
# Scan for leaked secrets
ossguard secrets
# Check OSPS Baseline compliance
ossguard baseline
# Pin GitHub Actions to commit SHAs
ossguard pin --applyCommands
| Command | Description |
|---------|-------------|
| init | Bootstrap security configs for a project |
| scan | Quick scan for security configuration |
| version | Show version |
| Dependencies | |
| deps | Analyze dependency health and vulnerabilities |
| drift | Detect dependency drift from lock files |
| watch | Monitor dependencies for new vulnerabilities |
| tpn | Generate third-party notices |
| reach | Reachability-filtered vulnerability analysis |
| Audit & Fix | |
| audit | Comprehensive security audit (config + deps + reach) |
| fix | Auto-remediate common security issues |
| badge | OpenSSF Best Practices Badge readiness |
| ci | Generate unified security CI pipeline |
| report | Export HTML/JSON compliance reports |
| policy | Organization-wide security policy enforcement |
| license | License compliance checking |
| Advanced | |
| baseline | OSPS Baseline compliance (Levels 1–3) |
| insights | Generate/validate SECURITY-INSIGHTS.yml |
| pin | Pin GitHub Actions to commit SHAs |
| secrets | Scan for leaked credentials and secrets |
| slsa | SLSA provenance level assessment |
| sbom-gen | Generate SPDX or CycloneDX SBOMs |
| supply-chain | Malicious package and typosquatting detection |
| container | Dockerfile security linting |
| compare | Compare security posture of two projects |
| update | Security-prioritized dependency updates |
| maturity | S2C2F maturity assessment |
| fuzz | Fuzzing readiness check and starter harness generation |
Project Structure
src/
├── analyzers/ # 24 security analyzers
├── apis/ # OSV and deps.dev API clients
├── detector.ts # Project detection and metadata
├── generators/ # Config file generators (security-md, scorecard, etc.)
├── parsers/ # Dependency and SBOM parsers
├── ui.ts # Terminal output helpers
└── index.ts # Public API exportsOther Implementations
| Implementation | Install | Best for |
|---------------|---------|----------|
| ossguard-python | pip install ossguard | Rich UI, developer workstation |
| ossguard-go | brew install kirankotari/tap/ossguard | CI pipelines, single binary |
Development
git clone https://github.com/kirankotari/ossguard-npm.git
cd ossguard-npm
npm install
npm run build
npm test
npm run typecheckLicense
Apache-2.0 — see LICENSE for details.
