Skip to main content

A configurable linter for agent skills, plugins, and AI coding assistant context

Project description

PyPI version PyPI Downloads Tests codecov License Python Versions

skillsaw

A configurable, rule-based linter for agentskills.io skills, Claude Code plugins, and plugin marketplaces.

Note: This project was formerly named claudelint. If you're migrating, see Migrating from claudelint.

Features

  • Context-Aware - Automatically detects agentskills repos, single plugins, and marketplaces
  • Rule-Based - Enable/disable individual rules with configurable severity levels
  • Extensible - Load custom rules from Python files
  • Comprehensive - Validates skill format, plugin structure, metadata, command format, and more
  • Containerized - Run via Docker for consistent, isolated linting
  • Fast - Efficient validation with clear, actionable output

Installation

Via uvx (easiest - no install required)

uvx skillsaw
uvx skillsaw /path/to/skills

Via pip

pip install skillsaw

From source

git clone https://github.com/stbenjam/skillsaw.git
cd skillsaw
pip install -e .

Using Docker

docker pull ghcr.io/stbenjam/skillsaw:latest
docker run -v $(pwd):/workspace ghcr.io/stbenjam/skillsaw

Quick Start

# Lint current directory
skillsaw

# Lint specific directory
skillsaw /path/to/skills

# Verbose output
skillsaw -v

# Strict mode (warnings as errors)
skillsaw --strict

# Generate default config
skillsaw --init

# List all available rules
skillsaw --list-rules

Repository Types

skillsaw automatically detects your repository structure:

agentskills.io Skills

Standalone skill repositories following the agentskills.io specification:

my-skill/
├── SKILL.md              # Required: metadata + instructions
├── scripts/              # Optional: executable code
├── references/           # Optional: documentation
├── assets/               # Optional: templates, resources
├── evals/                # Optional: evaluation tests
│   └── evals.json
└── <any-dir>/            # Arbitrary directories allowed per spec

Skill collections (multiple skills in subdirectories) are also supported:

skills-repo/
├── skill-one/
│   └── SKILL.md
└── skill-two/
    └── SKILL.md

Standard discovery paths (.claude/skills/, .github/skills/, .agents/skills/) are checked automatically.

Single Plugin

my-plugin/
├── .claude-plugin/
│   └── plugin.json
├── commands/
│   └── my-command.md
├── skills/
│   └── my-skill/
│       └── SKILL.md
└── README.md

Marketplace (Multiple Plugins)

skillsaw supports multiple marketplace structures per the Claude Code specification:

Traditional Structure (plugins/ directory)

marketplace/
├── .claude-plugin/
│   └── marketplace.json
└── plugins/
    ├── plugin-one/
    │   ├── .claude-plugin/
    │   └── commands/
    └── plugin-two/
        ├── .claude-plugin/
        └── commands/

Flat Structure (root-level plugin)

marketplace/
├── .claude-plugin/
│   └── marketplace.json    # source: "./"
├── commands/
│   └── my-command.md
└── skills/
    └── my-skill/

Custom Paths and Mixed Structures

Plugins from plugins/, custom paths, and remote sources can coexist in one marketplace. Only local sources are validated.

Configuration

Generate a default .skillsaw.yaml in your repository root:

skillsaw --init

This creates a config file with all builtin rules, their defaults, and descriptions. Edit it to enable, disable, or customize rules for your project. See .skillsaw.yaml.example for a complete example.

Builtin Rules

agentskills.io

These rules validate skills against the agentskills.io specification. They auto-enable for agentskills repos, single plugins, and marketplaces whenever skills are detected.

Rule ID Description Default Severity
agentskill-valid SKILL.md must have valid frontmatter with name and description error (auto)
agentskill-name Skill name must be lowercase with hyphens and match directory name error (auto)
agentskill-description Skill description should be meaningful and within length limits warning (auto)
agentskill-structure Skill directories should only contain recognized subdirectories (stricter than spec) warning (disabled)
agentskill-evals Validate evals/evals.json format when present error (auto)
agentskill-evals-required Require evals/evals.json for each skill (opt-in) error (disabled)

agentskill-structure parameters:

Parameter Description Default
allowed_dirs Directory names allowed in the skill root ["assets", "evals", "references", "scripts"]

Plugin Structure

Rule ID Description Default Severity
plugin-json-required Plugin must have .claude-plugin/plugin.json error (auto)
plugin-json-valid Plugin.json must be valid JSON with required fields error (auto)
plugin-naming Plugin names should use kebab-case warning (auto)
plugin-readme Plugin should have a README.md file warning (auto)

plugin-json-valid parameters:

Parameter Description Default
recommended-fields Fields that trigger a warning if missing from plugin.json ["description", "version", "author"]

Command Format

Rule ID Description Default Severity
command-naming Command files should use kebab-case naming warning
command-frontmatter Command files must have valid frontmatter with description error
command-sections Command files should have Name, Synopsis, Description, and Implementation sections warning
command-name-format Command Name section should be 'plugin-name:command-name' warning

Marketplace

Rule ID Description Default Severity
marketplace-json-valid Marketplace.json must be valid JSON with required fields error (auto)
marketplace-registration Plugins must be registered in marketplace.json error (auto)

Skills, Agents, Hooks

Rule ID Description Default Severity
skill-frontmatter SKILL.md files should have frontmatter with name and description warning
agent-frontmatter Agent files must have valid frontmatter with name and description error
hooks-json-valid hooks.json must be valid JSON with proper hook configuration structure error

MCP (Model Context Protocol)

Rule ID Description Default Severity
mcp-valid-json MCP configuration must be valid JSON with proper mcpServers structure error
mcp-prohibited Plugins should not enable non-allowlisted MCP servers error (disabled)

mcp-prohibited parameters:

Parameter Description Default
allowlist MCP server names that are permitted []

Rules Directory

Rule ID Description Default Severity
rules-valid .claude/rules/ files must be markdown with valid optional paths frontmatter error (auto)

Custom Rules

Create custom validation rules by extending the Rule base class:

from pathlib import Path
from typing import List
from skillsaw import Rule, RuleViolation, Severity, RepositoryContext

class NoTodoCommentsRule(Rule):
    @property
    def rule_id(self) -> str:
        return "no-todo-comments"

    @property
    def description(self) -> str:
        return "Command files should not contain TODO comments"

    def default_severity(self) -> Severity:
        return Severity.WARNING

    def check(self, context: RepositoryContext) -> List[RuleViolation]:
        violations = []
        for plugin_path in context.plugins:
            commands_dir = plugin_path / "commands"
            if not commands_dir.exists():
                continue
            for cmd_file in commands_dir.glob("*.md"):
                content = cmd_file.read_text()
                if "TODO" in content:
                    violations.append(
                        self.violation("Found TODO comment", file_path=cmd_file)
                    )
        return violations

Then reference it in .skillsaw.yaml:

custom-rules:
  - ./my_custom_rules.py

rules:
  no-todo-comments:
    enabled: true
    severity: warning

CI/CD Integration

GitHub Action (recommended)

The built-in GitHub Action installs skillsaw, runs it, and posts violations as inline PR comments with automatic deduplication. Fixed violations have their comment threads resolved.

name: Lint

on: [pull_request]

permissions:
  contents: write
  pull-requests: write

jobs:
  skillsaw:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v5
      - uses: stbenjam/skillsaw@v0
        with:
          strict: true

Inputs

Input Description Default
path Path to lint .
version Specific skillsaw version to install latest
strict Treat warnings as errors false
verbose Include info-level violations false
token GitHub token for posting PR comments ${{ github.token }}

Outputs

Output Description
exit-code skillsaw exit code (0=pass, 1=errors, 2=strict+warnings)
errors Number of errors found
warnings Number of warnings found
report Full JSON report

PR comment behavior

  • Each violation gets its own inline comment on the relevant line or file
  • Comments are deduplicated across re-runs using content fingerprinting
  • When a violation is fixed, its comment thread is automatically resolved
  • Comments with human replies are preserved

Permissions: contents: write is required for resolving comment threads via GraphQL. pull-requests: write is required for posting comments.

GitHub Actions (manual)

- uses: actions/checkout@v5

- name: Set up Python
  uses: actions/setup-python@v6
  with:
    python-version: '3.x'

- name: Install skillsaw
  run: pip install skillsaw

- name: Run linter
  run: skillsaw --strict

Docker

docker run -v $(pwd):/workspace ghcr.io/stbenjam/skillsaw --strict

Exit Codes

  • 0 - Success (no errors, or warnings only in non-strict mode)
  • 1 - Failure (errors found, or warnings in strict mode)

Example Output

Linting: /path/to/skills-repo

Errors:
  ✗ ERROR [skills/my-skill/SKILL.md]: Name 'My Skill' must contain only lowercase letters, numbers, and hyphens
  ✗ ERROR [plugins/git/.claude-plugin/plugin.json]: Missing plugin.json

Warnings:
  ⚠ WARNING [skills/helper/SKILL.md]: Description exceeds 1024 characters (1087)
  ⚠ WARNING [plugins/utils]: Missing README.md (recommended)

Summary:
  Errors:   2
  Warnings: 2

Migrating from claudelint

This project was renamed from claudelint to skillsaw. To migrate:

  1. Update your package: pip install skillsaw (instead of pip install claudelint)
  2. Rename .claudelint.yaml to .skillsaw.yaml (the old name is still discovered as a fallback)
  3. Update CLI usage: skillsaw (instead of claudelint)
  4. Update imports in custom rules: from skillsaw import ... (the old from claudelint import ... still works)

The claudelint command still works as a shim but prints a deprecation warning.

Removed rules

The following rules from claudelint have been removed in skillsaw:

Rule ID Reason
commands-dir-required Claude Code now treats skills/ and commands/ as the same mechanism; requiring a commands/ directory is no longer meaningful
commands-exist Same as above — plugins don't need to have commands

If your .skillsaw.yaml references these rule IDs, skillsaw will emit a warning about the unknown rule.

Development

# Run tests
pytest tests/ -v

# Format code
black src/ tests/

# Build Docker image
docker build -t skillsaw .

Contributing

Contributions welcome! Please:

  1. Fork the repository
  2. Create a feature branch
  3. Add tests for new functionality
  4. Ensure all tests pass
  5. Submit a pull request

License

Apache 2.0 - See LICENSE for details.

See Also

Support

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

skillsaw-0.5.0.tar.gz (60.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

skillsaw-0.5.0-py3-none-any.whl (45.9 kB view details)

Uploaded Python 3

File details

Details for the file skillsaw-0.5.0.tar.gz.

File metadata

  • Download URL: skillsaw-0.5.0.tar.gz
  • Upload date:
  • Size: 60.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for skillsaw-0.5.0.tar.gz
Algorithm Hash digest
SHA256 9e44148358b2764627a9723fa4e8b21f8cba9a7155ba09b707c99dbcfc1f1f90
MD5 bc987c237b7d3c5a4505be7308bd29c4
BLAKE2b-256 9f76af5ede3c58a57c2b9dd106ecf28131e34911a8fa31f49ccf9bd8c29ede70

See more details on using hashes here.

Provenance

The following attestation bundles were made for skillsaw-0.5.0.tar.gz:

Publisher: release.yml on stbenjam/skillsaw

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file skillsaw-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: skillsaw-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 45.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for skillsaw-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 54f80bc71f9974f68dce7fd6c5d9c77a2e2c33599889aab578b2aa0c44d3e0bf
MD5 6e8157229a856635d94a267c070740a2
BLAKE2b-256 709da674388380d42c114feb70aecb5f106b96f3509f462afb994fc1ee71ad45

See more details on using hashes here.

Provenance

The following attestation bundles were made for skillsaw-0.5.0-py3-none-any.whl:

Publisher: release.yml on stbenjam/skillsaw

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page