shine-stats

Consolidate SHINE project metrics into a five-line dashboard summary.

1|Updated Apr 15, 2026
One-click install
npx skills add https://github.com/diShine-digital-agency/SHINE-Code-System --skill shine-stats
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: shine-stats
Source: https://github.com/diShine-digital-agency/SHINE-Code-System/tree/main/skills/shine-stats
Command: npx skills add https://github.com/diShine-digital-agency/SHINE-Code-System --skill shine-stats

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

SHINE project stakeholders need quick access to a centralized snapshot of project health, reducing manual checking across multiple files.

Core Features & Use Cases

  • Compact dashboard: reports phase counts (ROADMAP.md), current in-progress phase (STATE.md), commit velocity (git log), active workstream, and installed runtime version (shine/VERSION).
  • Automation friendly: outputs a 5-line UI-brand style summary suitable for dashboards and reports.
  • Use Case: managers can monitor progress at a glance and identify bottlenecks without digging through multiple sources.

Quick Start

Run the shine-stats command to render the current SHINE project statistics.

Frequently Asked Questions about shine-stats

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I view SHINE project stats across roadmap, state, and git history in one dashboard?

You can view SHINE project stats by running the shine-stats command, which consolidates phase counts from ROADMAP.md, the in-progress phase from STATE.md, and commit velocity from git history into a single five-line summary.

What data do I need to generate a SHINE project health dashboard?

To generate the dashboard, your repository must contain a ROADMAP.md file, a STATE.md file, and a git history. The Skill extracts phase counts, current progress, and commit velocity directly from these inputs.

Can I use shine-stats to monitor commit velocity and active workstream status automatically?

Yes, shine-stats monitors commit velocity by analyzing your git log and identifies the active workstream status automatically. It outputs a UI-brand formatted summary suitable for automated dashboards and reports.

Does shine-stats display the installed runtime version for my project?

Yes, shine-stats displays the installed runtime version by reading the shine/VERSION file. This version number is included as the final line of the five-line project statistics summary output.

What limitations exist when generating a compact project metrics summary from markdown and git?

The summary generation is limited to repositories strictly following the SHINE structure. Without the required ROADMAP.md, STATE.md, and git history, the Skill cannot extract phase counts, progress, or commit velocity data.