Was macht ai-linter?
AI Linter ist ein Validierungstool für KI-Fähigkeiten und Agentenkonfigurationen. Es erzwingt Struktur, Frontmatter, Inhaltslänge, Token-Limits und Dateiverweisprüfungen für SKILL.md- und AGENTS.md-Dateien. Enthält YAML-Konfiguration, pre-commit und VS Code-Integration für robustes, automatisiertes Linting in KI-Projekten.
Funktionen
- Strukturprüfung: Stellt sicher, dass SKILL.md und AGENTS.md der erwarteten Struktur folgen.
- Frontmatter-Validierung: Überprüft, dass alle erforderlichen Felder vorhanden und korrekt formatiert sind.
- Inhaltslängen- und Token-Limit-Prüfung: Stellt sicher, dass die Inhalte die festgelegten Grenzwerte nicht überschreiten.
- Dateiverweisprüfung: Validiert, dass alle referenzierten Dateien tatsächlich existieren.
Installation
Mit pip
pip install ai-linter
Mit pre-commit
Fügen Sie folgende Zeilen zu Ihrer .pre-commit-config.yaml hinzu:
repos:
- repo: https://github.com/fchastanet/ai-linter
rev: v1.0.0
hooks:
- id: ai-linter
Konfiguration
AI Linter verwendet eine YAML-Konfigurationsdatei (standardmäßig .ai-linter.yml im Projektstammverzeichnis).
# Beispielkonfiguration .ai-linter.yml
skills:
- path: "skills/*/SKILL.md"
max_content_length: 5000
max_tokens: 1000
required_frontmatter:
- name
- description
check_file_references: true
agents:
- path: "agents/*/AGENTS.md"
max_content_length: 3000
max_tokens: 500
required_frontmatter:
- name
- version
Verwendung
Befehlszeile
ai-linter lint
VS Code
Installieren Sie die Erweiterung fchastanet.ai-linter aus dem VS Code Marketplace. Die Erweiterung lintet automatisch beim Speichern von SKILL.md- und AGENTS.md-Dateien.
Integration in CI/CD
Pre-commit-Hooks können in CI/CD-Pipelines integriert werden, um Linting vor jedem Commit durchzuführen.
# .github/workflows/lint.yml
name: Lint AI Skills
on: [push, pull_request]
jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
with:
python-version: '3.10'
- run: pip install ai-linter
- run: ai-linter lint
Lizenz
MIT