hippa-audit

CLI tool for running HIPAA compliance audits on codebases.

Installation

npm install -g hippa-audit

Or use locally:

npm install hippa-audit
npx hippa-audit

Usage

hippa-audit

Or:

hipaa-audit

Features

• API Key Verification: Secure connection to audit service (API key is generated after creating an app in the web interface)
• Codebase Collection: Automatically collects code files from your project
• HIPAA Compliance Analysis: Comprehensive audit of your codebase
• Detailed Reporting: Color-coded results with findings and remediation plans

Configuration

Environment Variables

• HIPAA_AUDIT_API_URL: Backend API URL (default: http://localhost:5000)

Config File

Create a .hippa-auditrc file in your home directory or project root:

{
  "apiUrl": "http://localhost:5000",
  "apiKey": "sk_..." // Optional, not recommended for production
}

Security Note: Storing API keys in config files is not recommended for production environments. Use environment variables instead.

Supported File Types

The tool automatically collects files with the following extensions:

• JavaScript/TypeScript: .js, .jsx, .ts, .tsx
• Python: .py
• Java: .java
• C/C++: .c, .cpp
• C#: .cs
• Go: .go
• Rust: .rs
• PHP: .php
• Ruby: .rb
• Swift: .swift
• Kotlin: .kt
• Scala: .scala
• Dart: .dart
• Vue: .vue
• Svelte: .svelte
• Files without extensions (e.g., Makefile, Dockerfile)

Excluded Directories

The following directories are automatically excluded:

• node_modules
• .git
• dist, build
• .next, .cache
• vendor
• And other common build/dependency directories

Workflow

1. Create App: First, create an app in the web interface to generate your API key
2. API Key Verification: Enter your API key to connect to the audit service (the app information is automatically retrieved)
3. Codebase Collection: The tool collects all relevant code files from your project
4. Audit Execution: Your codebase is analyzed for HIPAA compliance
5. Results Display: View compliance score, findings, and remediation plan

Output

The tool provides:

• Compliance Score: Overall score out of 100
• Status: Color-coded compliance status
  • 🟢 Green: Compliant (≥80)
  • 🟡 Yellow: Needs Attention (60-79)
  • 🔴 Red: Non-Compliant (<60)
• Summary Statistics: Breakdown by severity (Critical, High, Medium, Low)
• Top Findings: Most important issues to address
• Remediation Plan: Prioritized fixes with actionable steps

Requirements

• Node.js >= 18.0.0
• ES Modules (ESM) support

License

MIT