package-scan

Contents:

  • Introduction
    • Overview
    • Why package-scan?
    • Key Capabilities
    • The Incident Response Workflow
    • Supported Ecosystems
      • npm (JavaScript/Node.js)
      • Maven/Gradle (Java)
      • pip (Python)
    • Threat Database
    • How It Works
  • Installation
    • Requirements
      • Core Dependencies
      • Optional Dependencies
    • Installation Methods
      • From Source (Development)
      • Verify Installation
    • Using Docker
      • Pull from Docker Hub
      • Run with Docker
    • Development Installation
    • Upgrading
    • Uninstallation
    • Troubleshooting
      • Command not found
      • Import Errors
  • Usage
    • Basic Usage
      • Scan Current Directory
      • Scan Specific Directory
    • Threat Selection
      • Scan for Specific Threat
      • Scan for Multiple Threats
      • Use Custom CSV File
    • Ecosystem Selection
      • Scan Specific Ecosystem
      • Scan Multiple Ecosystems
      • List Available Ecosystems
    • Output Options
      • Custom Output File
      • Disable JSON Report
    • Listing Compromised Packages
      • Display Compromised Packages
      • CSV Output of Database
      • Filter by Threat
    • Docker Usage
      • Basic Docker Scan
      • Scan for Specific Threat
      • Custom Threat Database
      • Save Report to Host
      • Exit Codes
    • Legacy Commands
      • npm-scan Command
      • hulud-scan Alias
    • Common Use Cases
      • CI/CD Integration
      • Scan Monorepo
      • Audit Specific Dependency File
      • Generate Audit Report
    • Troubleshooting
      • No Findings When Expected
      • False Positives
      • Performance Issues
    • Output Format
      • Console Output
      • JSON Output
  • Architecture
    • Overview
    • Core Components
      • CLI (cli.py)
      • ThreatDatabase (core/threat_database.py)
      • ReportEngine (core/report_engine.py)
      • Finding Model (core/models.py)
    • Ecosystem Adapters
      • Base Adapter (adapters/base.py)
      • NpmAdapter (adapters/npm_adapter.py)
      • JavaAdapter (adapters/java_adapter.py)
      • PythonAdapter (adapters/python_adapter.py)
    • Data Flow
    • Adding New Ecosystems
    • Design Principles
    • Performance Considerations
    • Security Considerations
  • API Reference
    • Core API
      • Models
        • Finding
      • Threat Database
        • ThreatDatabase
      • Report Engine
        • ReportEngine
    • Adapters API
      • Base Adapter
        • EcosystemAdapter
        • ProgressSpinner
      • NPM Adapter
        • NpmAdapter
      • Java Adapter
        • JavaAdapter
      • Python Adapter
        • PythonAdapter
    • Core Modules
    • Ecosystem Adapters
  • Contributing
    • Development Setup
    • Running Tests
    • Code Style
    • Testing Guidelines
    • Adding New Adapters
    • Adding New Threats
    • Documentation
      • Building Documentation
      • Writing Documentation
    • Pull Request Process
    • Commit Message Guidelines
    • Bug Reports
    • Feature Requests
    • Code of Conduct
    • Getting Help
    • License
package-scan
  • Search

© Copyright 2025, Package Scan Security.

Built with Sphinx using a theme provided by Read the Docs.