Why skillpack?
AI coding assistants (Claude Code, Cursor, Codex, OpenCode, GitHub Copilot, Freebuff) interact with software differently than humans:
- Humans read high-level READMEs, tutorials, and manual pages to learn syntax.
- AI Agents look for machine-readable skill files, plugin manifests, rule definitions, and structured invocation syntax.
Without an agent guidance layer, AI coding agents frequently:
- Miss installed tools and attempt to write redundant custom scripts from scratch.
- Hallucinate invalid CLI flags, resulting in execution failures and broken scripts.
- Waste context tokens and time repeatedly grepping
--helpoutputs across multiple exploratory reasoning steps.
skillpack solves this with a single command. It introspects your project repository, discovers your CLI binaries or library interfaces, extracts verified argument signatures, and generates tailored distribution files for all major agent ecosystems.
⚡ Key Features
- Universal Multi-Ecosystem Generation: Generates native guidance files for 10 agent formats simultaneously (
AGENTS.md, Claude Code, Cursor.mdc, OpenCode, Copilot, Codex, Windsurf, Freebuff, Gemini, and Aider). - Zero-Drift Verification: Simulates agent invocations against your live CLI to verify that every documented flag and subcommand actually exists.
- Pre-Commit Safe:
skillpack initvalidates the complete surface before writing a single file to disk. - Non-Destructive Updates:
skillpack updaterefreshes flags and versions while preserving your hand-written descriptions and notes. - Turnkey CI Integration: Includes GitHub Actions workflows and
.pre-commithooks to prevent documentation drift in pull requests.
🚀 Quick Start
1. Installation
# Prebuilt binaries — fastest, no Rust toolchain needed
&&
# Or build from source
2. Scaffold Agent Guidance
Run interactive setup in your project root:
# Interactive setup (asks a few quick questions and persists answers to skillpack.toml)
# Or generate for all supported ecosystems at once:
3. Zero-Interaction Automated Setup (--auto)
For instant, unattended generation in CI or local scripts:
# Introspects README, git config, LICENSE, and compiled CLI binaries automatically
4. Verify Accuracy
Validate your repository's agent guidance against your real CLI:
📦 What skillpack Generates
Running skillpack init --target all generates a clean, non-intrusive distribution layer:
| Target / Ecosystem | Generated File(s) | Description |
|---|---|---|
| AGENTS.md | AGENTS.md |
Standard instructions file read natively by Freebuff, Zed, Cursor, Windsurf, and 60k+ repos. |
| Claude Code | .claude-plugin/ & skills/<tool>/SKILL.md |
Plugin manifest and skill specification for Claude Code and Codex. |
| Cursor | .cursor/rules/<tool>.mdc |
Context-aware rule file with automated file-glob matching. |
| OpenCode | .opencode/agents/<tool>.md |
Agent definition for OpenCode AI coding environments. |
| GitHub Copilot | .github/copilot-instructions.md |
Custom repository instructions for GitHub Copilot. |
| Gemini CLI | GEMINI.md |
Native repository instruction layer for Google Gemini CLI. |
| Windsurf | .windsurf/rules/<tool>.md |
Cascade IDE rule file. |
| Aider | CONVENTIONS.md |
Codebase convention guidelines for Aider. |
| Deterministic Config | skillpack.toml |
Committed configuration making future updates and CI checks deterministic. |
📊 Measured Benchmark: The skillpack Impact
We benchmarked autonomous coding agents performing complex search and execution tasks on a plain repository clone versus a skillpack-guided clone:
Baseline (Plain Clone): [Tool Error] ──> [Help Grep 1] ──> [Help Grep 2] ──> [Retry 1] ──> [Success in 6 Rounds] (179s)
Guided (With skillpack): [Direct Execution with Verified Flags] ─────────────> [Success in 1 Round] (82s)
Performance Metrics (OpenCode / sharkdp/fd Benchmark Suite)
| Metric | Plain Clone (Baseline) | Clone + skillpack | Improvement |
|---|---|---|---|
| Wall Clock Latency | 158 s | 88 s | 44% Faster |
| Reasoning Rounds | 12.5 steps | 8.5 steps | 32% Fewer Steps |
| Help Query Detours | 4 – 5 queries | 0 queries | 100% Elimination |
| Task Accuracy | 3.5 / 4 (87.5%) | 4.0 / 4 (100%) | +14% Accuracy |
Full benchmark methodology, repeatable test suites (
fd,ripgrep,bat), and replay harness documentation are available indocs/benchmark.md. Want to see it happen? Read the step-by-stepdocs/agent-demo.md— or reproduce the A/B run yourself from the committed transcripts.
🛠️ Command-Line Reference
skillpack init: Scaffold agent distribution files (interactive,--auto, or--non-interactive).skillpack verify: Check guidance files against agent schemas and live--helpflag surfaces (supports--min-score <N>,--fix, and--format {human,json,sarif}).skillpack doctor: Diagnose language and CLI candidate discovery decision traces.skillpack update: Incrementally regenerate files fromskillpack.tomlafter CLI changes.skillpack diff: Preview pending guidance updates without modifying disk.
🔄 CI/CD & Pre-Commit Integration
GitHub Actions Workflow
Add .github/workflows/skillpack.yml to prevent documentation drift in PRs:
name: Verify Agent Guidance
on:
push:
branches:
pull_request:
branches:
jobs:
verify:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: dtolnay/rust-toolchain@stable
- name: Install skillpack
run: cargo install skillpack --locked
- name: Verify Guidance Layer
run: skillpack verify --min-score 100
Pre-Commit Hook
Add to your .pre-commit-config.yaml:
repos:
- repo: https://github.com/nordicnode/skillpack
rev: v0.12.0
hooks:
- id: skillpack-verify
🌐 Supported Language Ecosystems
skillpack automatically detects CLI binaries and library entrypoints across:
- Rust: Built artifacts in
target/{release,debug}(including Cargo workspaces) and PATH binaries. - Node.js:
package.jsonbinfields and./bin/<name>.jsscripts. - Python:
pyproject.toml[project.scripts]and Poetry/Flit entries. - Go:
go run .forpackage mainmodules and built binaries. - Ruby: Gem binstubs in
exe/andbin/. - PHP: Composer package binaries in
vendor/bin. - JVM: Gradle
installDistand Maven shaded JAR entrypoints. - .NET / C#: SDK-style executable
.csprojtargets. - Zig:
build.zig/build.zig.zonand artifacts inzig-out/bin/. - Swift:
Package.swiftand.build/{debug,release}/artifacts orswift run. - C / C++:
CMakeLists.txt,meson.build,Makefileandbuild//bin/binaries. - Elixir:
mix.exsand_build/{dev,prod}/rel/releases ormix escript. - Deno:
deno.json/deno.jsoncanddeno runscript entrypoints.
📄 License & Community
skillpack is open-source software licensed under the MIT License.
- Documentation: See
docs/reference.mdfor full check catalogs and schemas. - Changelog: See
CHANGELOG.mdfor version release notes. - Contributing: Contributions are welcome! Review
CONTRIBUTING.mdto get started.