Skip to main content

Test, lint, score, and package Claude/Hermes/AI-agent skills like real software.

Project description

agentskills-ci

CI skill score

Test, lint, score, and package Claude/Hermes/AI-agent skills like real software.

Claude Skills and agent workflows are becoming reusable software artifacts, but most teams still ship them as loose prompt files. No CI. No tests. No linked-file checks. No safety scan. No quality score.

agentskills-ci gives AI-agent skills the same quality discipline teams expect from code.

What it does

  • Validates SKILL.md frontmatter and body structure
  • Checks for missing linked files in references/, templates/, scripts/, and assets/
  • Flags risky shell patterns such as rm -rf, curl | bash, and broad permission changes
  • Flags external side-effect instructions without approval gates
  • Scores each skill from 0–100
  • Emits text, Markdown, or JSON reports
  • Provides a composite GitHub Action via action.yml
  • Includes a workflow generator: agentskills-ci init-github-action

Quick start

pipx install agentskills-ci
agentskills-ci check ./skills
agentskills-ci score ./skills --format markdown
agentskills-ci init-github-action --path skills

Local development from this repo:

python -m venv .venv
source .venv/bin/activate
pip install -e '.[dev]'
pytest -q
agentskills-ci check examples/skills/good-skill

Example output

✅ 1 skills checked
✅ 1 passed
⚠️  0 need fixes

Overall score: 100/100

Bad-skill example:

⚠️  1 skills checked
✅ 0 passed
⚠️  1 need fixes

Overall score: 8/100

Top issues:
- bad-skill: Missing required frontmatter field: description
- bad-skill: Missing recommended section: ## Overview
- bad-skill: Referenced path does not exist: scripts/missing.sh
- bad-skill: Risky command pattern found: rm -rf
- bad-skill: Side-effect instruction lacks an approval gate

GitHub Action usage

Use the published action from a workflow in another repository:

name: Agent Skills CI

on:
  pull_request:
  push:
    branches: [main]

jobs:
  validate-skills:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: damanisme/agentskills-ci@main
        with:
          path: skills
          min-score: "80"
          format: text

Or generate a workflow locally:

agentskills-ci init-github-action --repo . --path skills

A sample workflow is included at examples/github-workflows/ci.yml.

CLI

agentskills-ci check PATH [--format text|markdown|json] [--min-score 80]
agentskills-ci score PATH [--format text|markdown|json]
agentskills-ci init-github-action [--repo .] [--path skills]
agentskills-ci badge PATH [--format markdown|url|endpoint] [--label "skill score"] [--repo URL]

Quality badge

Show your skill score in any README. Generate a static badge:

agentskills-ci badge ./skills --repo https://github.com/you/your-repo
# [![skill score](https://img.shields.io/badge/skill%20score-100-brightgreen)](https://github.com/you/your-repo)

Or wire a live, self-updating badge via a shields.io endpoint. Publish the JSON from agentskills-ci badge ./skills --format endpoint to a URL, then point shields.io at it:

![skill score](https://img.shields.io/endpoint?url=https://your-host/skill-score.json)

Badge color tracks the score: >=90 brightgreen, >=80 green, >=60 yellow, >=40 orange, else red.

PATH can be either a single SKILL.md file or a directory containing nested skill folders. Symlinked skill directories are followed (with cycle protection), so an aggregated skills/ folder that links skills in from elsewhere is fully scanned.

What gets checked

Required structure

  • YAML frontmatter starts at the top of SKILL.md
  • Required fields: name, description
  • Description length <= 1024 characters
  • Skill name is lowercase and URL-safe

Recommended sections

  • ## Overview
  • ## When to Use
  • ## Common Pitfalls
  • ## Verification Checklist

Linked files

References to these folders are validated:

  • references/
  • templates/
  • scripts/
  • assets/

Example:

See `references/api.md` and `scripts/check.sh`.

If either file is missing, CI fails.

Safety scan

Current MVP rules flag:

  • rm -rf
  • curl | bash
  • chmod 777
  • suspicious secret literals
  • destructive sudo commands
  • side-effect actions such as posting, deploying, sending email, or merging without an approval gate

Why this matters

Agent skills are operational runbooks. A bad skill can:

  • trigger at the wrong time
  • reference missing support files
  • tell an agent to run dangerous commands
  • perform external side effects without approval
  • silently drift out of date

agentskills-ci makes these problems visible in pull requests.

Roadmap

See ROADMAP.md for the full list. Highlights:

  • SARIF output for GitHub code scanning
  • ✅ Badge endpoint / static badge generation (agentskills-ci badge)
  • Skill registry quality cards
  • LLM-assisted skill critique mode
  • Overlap detection between related skills
  • Policy packs for enterprise teams
  • Test fixtures for tool-call simulations
  • Package publishing to PyPI

Repository structure

agentskills-ci/
├── action.yml
├── examples/
│   ├── github-workflows/
│   └── skills/
├── src/agentskills_ci/
├── templates/
├── tests/
└── pyproject.toml

License

MIT

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

agentskills_ci-0.1.0.tar.gz (15.7 kB view details)

Uploaded Source

Built Distribution

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

agentskills_ci-0.1.0-py3-none-any.whl (11.9 kB view details)

Uploaded Python 3

File details

Details for the file agentskills_ci-0.1.0.tar.gz.

File metadata

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

File hashes

Hashes for agentskills_ci-0.1.0.tar.gz
Algorithm Hash digest
SHA256 41da44bbd8a1a5361bb196ca32591a80fc30260f32c274c124d3b63c0814a998
MD5 e1e2bbdf70f922241cf81e956dc68fc3
BLAKE2b-256 92dcddc690d89da702eefac4dfb453c1a8163ab058dad33ee71c765f2dad407b

See more details on using hashes here.

Provenance

The following attestation bundles were made for agentskills_ci-0.1.0.tar.gz:

Publisher: release.yml on damanisme/agentskills-ci

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

File details

Details for the file agentskills_ci-0.1.0-py3-none-any.whl.

File metadata

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

File hashes

Hashes for agentskills_ci-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2cef79c7a2c1aa19ca8dcab2c2c61d2e60ba180a5c90efe9c737f1a4a26215c8
MD5 e5bc47d4ccc7504283a570751b6a9347
BLAKE2b-256 7bf5e0b0f458d598a3d0cce43579139201a13eabbc2473ccbfc53c33d8da2994

See more details on using hashes here.

Provenance

The following attestation bundles were made for agentskills_ci-0.1.0-py3-none-any.whl:

Publisher: release.yml on damanisme/agentskills-ci

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