Getting Started
Getting Started with SKF: Skill Forge
Section titled “Getting Started with SKF: Skill Forge”Welcome to Skill Forge! This guide will help you get up and running.
What This Module Does
Section titled “What This Module Does”Skill Forge is an automated skill compiler for the AI agent ecosystem. It transforms code repositories, documentation websites, and developer discourse into agentskills.io-compliant, version-pinned, provenance-backed agent skills. Every instruction traces to actual code — zero hallucination tolerance.
Installation
Section titled “Installation”There are three ways to install SKF, depending on your setup.
Standalone (recommended for trying SKF)
Section titled “Standalone (recommended for trying SKF)”npx bmad-module-skill-forge installInstalls SKF on its own. You’ll be prompted for project name, output folders, and which IDEs to configure. The installer generates IDE-specific command files (e.g. .claude/commands/, .cursor/commands/) so workflows appear in your IDE’s command palette.
As a custom module during BMad Method installation
Section titled “As a custom module during BMad Method installation”npx bmad-method installWhen prompted “Add custom modules from your computer?”, select Yes and provide the path to the SKF src/ folder (clone this repo first):
Path to custom module folder: /path/to/bmad-module-skill-forge/src/This installs BMad core + SKF together with full IDE integration, manifests, and help catalog. Best when you want the complete BMad development workflow.
Add SKF to an existing BMad project
Section titled “Add SKF to an existing BMad project”If you already have BMad installed, you can add SKF afterward by running the standalone installer in the same directory:
npx bmad-module-skill-forge installThe installer detects the existing _bmad/ directory and installs SKF alongside your current modules.
Prerequisites
Section titled “Prerequisites”| Tool | Required For | Install |
|---|---|---|
gh (GitHub CLI) | All modes | https://cli.github.com |
ast-grep (CLI tool for code structural search, lint, and rewriting) | Forge + Deep modes | https://ast-grep.github.io |
qmd (local hybrid search engine for project files) | Deep mode | https://github.com/tobi/qmd |
Don’t worry if you don’t have all tools — SKF detects what’s available and sets your tier automatically.
First Steps
Section titled “First Steps”1. Setup Your Forge
Section titled “1. Setup Your Forge”@Ferris SFThis detects your tools, sets your capability tier, and initializes the forge environment. You only need to do this once per project.
2. Generate Your First Skill
Section titled “2. Generate Your First Skill”Fastest path (Quick Skill):
@Ferris QS https://github.com/bmad-code-org/BMAD-METHODFerris reads the repository, extracts the public API, and generates a skill in under a minute.
Full quality path:
@Ferris BS # Brief — scope and design the skill@Ferris CS # Create — compile from the brief@Ferris TS # Test — verify completeness@Ferris EX # Export — package for distribution3. Stack Skill (for full projects)
Section titled “3. Stack Skill (for full projects)”@Ferris SSAnalyzes your project’s dependencies and generates a consolidated stack skill with integration patterns.
Common Use Cases
Section titled “Common Use Cases”My agent keeps hallucinating API calls
Section titled “My agent keeps hallucinating API calls”Your agent invents function signatures that don’t exist. Generate a verified skill so it works from structural truth instead of guessing.
@Ferris QS https://github.com/org/libraryThe skill pins every function to its actual source location. Hallucinations stop.
I’m adopting a new library and need my agent to use it correctly
Section titled “I’m adopting a new library and need my agent to use it correctly”You added a dependency but your agent doesn’t know its API yet. Quick Skill resolves package names across npm, PyPI, and crates.io.
@Ferris QS cogneeFerris resolves the package to its GitHub repo, extracts the public API, and generates a skill your agent can reference immediately.
I want my agent to understand my entire project stack
Section titled “I want my agent to understand my entire project stack”Individual skills cover single libraries. Stack Skill maps how your dependencies interact — shared types, co-import patterns, integration points.
@Ferris SSFerris detects your manifests, ranks dependencies by significance, and generates a consolidated skill with cross-library integration patterns.
I’m onboarding a large existing codebase
Section titled “I’m onboarding a large existing codebase”A brownfield repo with dozens of modules. You need to know what’s worth skilling before you start.
@Ferris ANAnalyze Source scans the project, identifies skillable units, maps exports, and generates recommended briefs you can batch-create with @Ferris CS --batch.
I want the highest accuracy possible
Section titled “I want the highest accuracy possible”Quick mode reads source files. Forge mode adds AST parsing for structural truth. Deep mode goes further — QMD smart-indexes your project’s source code, documentation, and configuration files into per-directory collections (excluding module internals and build artifacts), then uses BM25 keyword search, vector semantic search, and LLM-powered re-ranking to surface context no other tool can find.
@Ferris SF # Setup detects your tools and sets tier automaticallyIf ast-grep and qmd are available, Ferris activates Deep mode. Every skill gets AST-verified signatures (T1) enriched with deep knowledge search (T2) — deprecation warnings, breaking change history, common pitfalls surfaced by hybrid search across your indexed documentation.
I maintain an OSS library and want official skills
Section titled “I maintain an OSS library and want official skills”You want maximum quality with full provenance for distribution. Use the full pipeline with Deep mode for the richest output.
@Ferris BS # Scope and design the skill@Ferris CS # Compile — AST extraction + QMD enrichment (Deep)@Ferris TS # Verify completeness before publishing@Ferris EX # Package for distributionExport with source_authority: official. Consumers get verified skills that update with each release.
A dependency shipped breaking changes
Section titled “A dependency shipped breaking changes”Your existing skill is now out of date. Audit detects the drift, Update regenerates while preserving your manual additions.
@Ferris AS # Find what changed@Ferris US # Regenerate — [MANUAL] sections survive@Ferris TS # Verify the updateWhat’s Next?
Section titled “What’s Next?”- Check out the Agents Reference to learn about Ferris
- Browse the Workflows Reference to see all available commands
- See Examples for real-world usage scenarios
Need Help?
Section titled “Need Help?”If you run into issues:
- Run
/bmad-help— analyzes your current state and suggests what to do next (e.g./bmad-help my quick skill has low confidence scores, how do I improve them?) - Run
@Ferris SFto check your tool availability and tier - Check
forge-config.yamlfor your current configuration