localsetup-framework-audit

Audit repository docs, links, skill matrix, and version consistency for release.

3|2|Updated Dec 25, 2025
One-click install
npx skills add https://github.com/cptnfren/localsetup --skill localsetup-framework-audit
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: localsetup-framework-audit
Source: https://github.com/cptnfren/localsetup/tree/main/_localsetup/skills/localsetup-framework-audit
Command: npx skills add https://github.com/cptnfren/localsetup --skill localsetup-framework-audit

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires pyyaml, and includes scripts (resource) components.

What problem does it solve?

Pre-release software projects often fail to meet quality gates; this skill performs a comprehensive audit of docs, links, skill matrix (sandbox), and version consistency to surface issues before release.

Core Features & Use Cases

  • Doc checks validate required files exist (VERSION, README, etc.) and policy-guided docs.
  • Link checks identify plain references to docs or localsetup paths that require updates.
  • Skill matrix runs sandbox smoke tests for skills to verify basic operability.
  • Version consistency checks compare VERSION, README version, and facts.json to ensure synchronization.
  • Maintainer references are scanned to surface hardcoded paths requiring review.
  • Use Case: Before releasing a framework upgrade, run the audit to generate a report for sign-off.

Quick Start

Run the audit script from the repository root to emit a structured report to a user-specified path.

Frequently Asked Questions about localsetup-framework-audit

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

FAQPage Schema
How do I run a pre-release audit for framework docs, links, and version consistency?

A pre-release audit validates required docs, identifies plain-link issues, executes sandbox-based skill smoke tests, and compares version data across VERSION, README, and facts.json. You run the audit script from the repository root to generate a structured report at a user-specified path for release sign-off.

What does a repository version consistency check compare?

A version consistency check compares the VERSION file, README version, and facts.json to ensure synchronization across the repository. This verification surfaces mismatches before a framework upgrade release, preventing deployment failures caused by desynchronized metadata.

Do I need PyYAML installed to run a docs and skill matrix audit?

Yes, you need PyYAML installed because the audit requires it for YAML parsing during the skill matrix and docs validation process. The framework also relies on included sandbox tooling like create_sandbox.py and run_smoke.py to execute the skill smoke tests.

Can I use this audit to detect hardcoded maintainer paths in my repository?

Yes, the audit scans maintainer references to surface hardcoded paths requiring review before release. It also identifies plain references to docs or localsetup paths that require updates, ensuring all links and paths are correctly configured.

What's the best way to validate a skill matrix before a framework release?

The best way to validate a skill matrix is running sandbox smoke tests for skills to verify basic operability. This process executes within the framework's sandbox environment and outputs the results into a structured audit report for final review.