Skip to main content

​
Overview

The list-checks command displays all available static analysis checks with their metadata, including check IDs, names, dimensions, severity levels, and whether they’re required by the Agent Skills specification.

​
Usage

sklab list-checks [OPTIONS]

​
Options

​
--dimension
string
Alias: -dFilter checks by dimension.Options:
  • structure - File structure and frontmatter checks
  • naming - Naming convention checks
  • description - Description quality checks
  • content - Content quality and completeness checks
sklab list-checks --dimension structure
​
--spec-only
boolean
default:false
Alias: -sOnly show checks required by the Agent Skills specification (excludes quality suggestions).
sklab list-checks --spec-only
​
--suggestions-only
boolean
default:false
Only show quality suggestion checks (excludes spec-required checks).
sklab list-checks --suggestions-only

​
Examples

​
List all checks

sklab list-checks
Output: 
                Available Checks                
┌──────────────┬────────────┬───────────┬──────────┬──────┬─────────────┐
│ Check ID     │ Name       │ Dimension │ Severity │ Spec │ Description │
├──────────────┼────────────┼───────────┼──────────┼──────┼─────────────┤
│ skill-exists │ SKILL.md   │ structure │ error    │ Yes  │ SKILL.md... │
│ valid-fm     │ Frontm...  │ structure │ error    │ Yes  │ Valid YA... │
│ ...          │ ...        │ ...       │ ...      │ ...  │ ...         │
└──────────────┴────────────┴───────────┴──────────┴──────┴─────────────┘

Total: 28 checks (10 spec-required, 18 quality suggestions)

​
Filter by dimension

sklab list-checks --dimension structure

​
Show only spec-required checks

sklab list-checks --spec-only

​
Show only quality suggestions

sklab list-checks --suggestions-only

​
Output Format

The table includes:
​
Check ID
string
Unique identifier for the check (e.g., skill-exists, valid-frontmatter)
​
Name
string
Human-readable name of the check
​
Dimension
string
Category of the check:
  • structure - File organization and frontmatter
  • naming - Naming conventions
  • description - Description quality
  • content - Content completeness and quality
​
Severity
string
Impact level:
  • error - Must be fixed (blocks validation)
  • warning - Should be addressed
  • info - Optional improvement
​
Spec
string
Whether the check is required by the Agent Skills specification:
  • Yes - Spec-required (10 checks)
  • No - Quality suggestion (18 checks)
​
Description
string
Brief explanation of what the check validates

​
Check Categories

​
Spec-Required Checks (10)

These checks enforce the Agent Skills specification:
  • skill-exists - SKILL.md file must exist
  • valid-frontmatter - Valid YAML frontmatter
  • standard-fields - Required frontmatter fields present
  • name-required - Name field in frontmatter
  • name-length - Name within length limits
  • description-required - Description field in frontmatter
  • description-length - Description within length limits
  • body-not-empty - Non-empty skill body
  • valid-scripts - scripts/ folder structure valid
  • valid-references - references/ folder structure valid

​
Quality Suggestions (18)

These checks recommend best practices:
  • Token budgets
  • Content completeness
  • Naming conventions
  • Reference depth
  • Asset validation
  • And more…

​
Summary Line

The summary shows:
  • Total number of checks displayed
  • Count of spec-required checks
  • Count of quality suggestion checks
Total: 28 checks (10 spec-required, 18 quality suggestions)
When filtered, the summary reflects only the displayed checks.

​
Exit Codes

  • 0: List generated successfully
  • 1: Error occurred (invalid dimension, etc.)

​
Use Cases

​
Understand available checks

See what validations are performed: 
sklab list-checks

​
Focus on spec requirements

View only mandatory checks: 
sklab list-checks --spec-only

​
Review content checks

See all content-related validations: 
sklab list-checks --dimension content

​
Documentation reference

Generate a reference list of checks: 
sklab list-checks > checks-reference.txt

​
Notes

The total check count is 28: 10 spec-required + 18 quality suggestions.
Checks are organized using an auto-discovery pattern. Each check is a class decorated with @register_check or defined as a FieldRule in the schema.

Build docs developers (and LLMs) love

Get started for freeTalk to us