canon-audit

Extract rules from markdown files and scan a codebase for compliance findings.

Updated Feb 5, 2026
One-click install
npx skills add https://github.com/Objective-Arts/lens --skill canon-audit
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: canon-audit
Source: https://github.com/Objective-Arts/lens/tree/main/workflow-skills/utils/canon-audit
Command: npx skills add https://github.com/Objective-Arts/lens --skill canon-audit

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the process of auditing a codebase against a defined set of best practices and rules from a specific "canon," providing a detailed report without making any changes.

Core Features & Use Cases

  • Comprehensive Rule Extraction: Parses SKILL.md and topic files within a canon to identify explicit checklists, detection rules, anti-patterns, and standards.
  • Grepable & Semantic Rule Scanning: Utilizes both pattern matching and code analysis to evaluate rules.
  • Severity Classification & Reporting: Assigns severity levels (Critical, High, Medium, Low) to findings and generates a detailed report in Markdown format, both in the conversation and as a file.
  • Use Case: After applying a new javascript+security profile to a project, run /canon-audit javascript src/ to get a detailed report on compliance with security best practices, identifying specific files and lines that need attention.

Quick Start

Run /canon-audit typescript in the current directory to audit the project against the typescript canon.

Frequently Asked Questions about canon-audit

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

FAQPage Schema
How do I audit TypeScript code for security and best practice compliance?

You can audit a codebase by running a canon audit command targeting a specific canon, such as TypeScript. The Skill extracts rules from markdown files, performs targeted scans, classifies findings by severity, and outputs a comprehensive Markdown report detailing compliance and remediation priorities.

What is a canon ruleset and how does it work for code quality reporting?

A canon ruleset consists of best practices and detection rules stored in markdown files. The Skill parses these files to identify anti-patterns and standards, then uses pattern matching and code analysis to scan the project, generating a report that classifies compliance findings by severity.

Can I run a code security audit without modifying my project files?

Yes, this audit process operates entirely in read-only mode to ensure no code modification occurs. It focuses strictly on evaluating compliance and best practice adherence, identifying files and lines that need attention without altering your source code.

How are code quality findings classified and reported during an audit?

Findings are classified by severity levels: Critical, High, Medium, and Low. The audit generates a comprehensive Markdown report both in the conversation and as a file, providing actionable remediation priorities based on the severity of the identified compliance issues.

What is the best way to check my project against a specific canon's ruleset?

The best way is to run the audit command with the desired canon name and target directory. The tool extracts rules from the canon's markdown files, executes targeted scans using grep and semantic analysis, and outputs a detailed compliance report with actionable remediation priorities.

Does the audit process support custom rulesets for compliance reporting?

Yes, the audit supports custom rulesets by parsing SKILL.md and topic files within a canon to identify explicit checklists, detection rules, and anti-patterns. It evaluates your codebase against these extracted standards to generate a comprehensive compliance report.