OSSIntel logo OSSIntel
Version 0.1.0

Overview

Updated 3 hr ago

CIcodecovnpm versionnpm downloadsnpm bundle sizelicense

@ossintel/insights: Rule-based insight engine that converts OSS metrics into actionable findings, recommendations, and AI-ready summaries with minimal hallucination.

Transforms metrics into actionable insights.

Purpose

Numbers alone rarely tell the complete story.

This package converts metrics into meaningful findings and recommendations.

Responsibilities

Generate:

  • Findings
  • Recommendations
  • Warnings
  • Highlights
  • AI-ready summaries

Design

Three layers:

  1. Deterministic rules
  2. Template generation
  3. Optional AI summarization

Philosophy

AI should explain the data.

AI should never invent the data.

Inputs

  • Scores
  • Metrics
  • Statistics

Outputs

Finding[]

Recommendation[]

PromptContext

Non-goals

  • Fetching APIs
  • Calculating scores
  • Rendering UI

✨ Why @ossintel/insights?

  • Actionable Context: Translates raw numbers into human-readable warnings and highlight descriptions.
  • AI-Ready Summaries: Formats deterministic findings into prompt contexts ready for AI analysis, avoiding hallucinations.
  • Pure & Fast: Contains zero network or state dependencies, rendering insights instantly on the client side.

📦 Installation

$ pnpm add @ossintel/insights

or

$ npm install @ossintel/insights

or

$ yarn add @ossintel/insights

License

This library is licensed under the MIT open-source license.


with 💖 by Mayank Kumar Chaudhari

On this page