• Hipcheck ✓  v3.14.0
  • Docs
  • Contribute
  • Blog
  • Help ↗
  • Install
Home › Documentation › Complete Guide › Key Concepts
  1. Documentation
  2. Getting Started
    1. Install Hipcheck
    2. Why Hipcheck?
    3. Quickstart: Your First Analysis
  3. Complete Guide
    1. Key Concepts
      1. Targets
      2. Data
      3. Analyses
      4. Scoring
      5. Concerns
    2. Configuration
      1. Execution Configuration
      2. Policy Files
      3. Policy Expressions
    3. CLI Reference
      1. General Flags
      2. hc cache
      3. hc check
      4. hc explain
      5. hc ready
      6. hc schema
      7. hc scoring
      8. hc setup
      9. hc update
    4. Debugging
      1. Starting Debugging
      2. Logging
      3. Using a Debugger
    5. Plugins
      1. mitre/activity
      2. mitre/affiliation
      3. mitre/binary
      4. mitre/churn
      5. mitre/entropy
      6. mitre/fuzz
      7. mitre/git
      8. mitre/github
      9. mitre/identity
      10. mitre/linguist
      11. mitre/npm
      12. mitre/review
      13. mitre/typo
    6. Making Plugins
      1. Creating a Plugin
      2. The Rust Plugin SDK
      3. The Python Plugin SDK
      4. The Query Protocol
      5. Packaging and Releasing a Plugin
  4. Contribute
    1. Coordinating Changes
    2. Testing Changes
    3. Intellectual Property
    4. Describing Changes
    5. PR Submission and Review Checklist
    6. Developer Docs
      1. Repo Structure
      2. Architecture
      3. Plugin Query System
  5. Requests for Discussion
    1. The RFD Process
    2. All RFDs

Key Concepts

To understand Hipcheck, it's useful to understand some of the key concepts underlying its design, which we'll explore here.

Targets

How Hipcheck identifies what package or project to analyze.

Data

How Hipcheck collects data from external sources.

Analyses

What kinds of analyses Hipcheck is focused on.

Scoring

How Hipcheck converts individual analysis results into a risk score.

Concerns

How plugins report extra information to support manual analysis.

On This Page To Top

    No table of contents.

Hipcheck ✓

Helping maintainers assess software packages for long term risk.

  • Documentation
  • Getting Started
  • Complete Guide
  • Requests for Discussion
  • Blog
  • Project
  • Hipcheck Values
  • Open Source License ↗
  • Code of Conduct ↗
  • Install
  • Installer
  • Container Image ↗
  • Release Notes ↗
  • Changelog ↗
  • Packages
  • Hipcheck ↗
  • Rust Plugin SDK ↗
  • Python Plugin SDK ↗
  • Contribute
  • Discussions ↗
  • Issue Tracker ↗
  • Product Roadmap ↗
  • Contributor Guide ↗
  • Security
  • Security Policy ↗
  • Report a Vulnerability ↗

Website served by GitHub Pages (Privacy Policy).