rule-writer

Extract migration patterns from guides into validated Konveyor analyzer rules.

1|2|Updated Mar 19, 2026
One-click install
npx skills add https://github.com/konveyor/ai-rule-gen --skill rule-writer
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: rule-writer
Source: https://github.com/konveyor/ai-rule-gen/tree/main/agents/rule-writer
Command: npx skills add https://github.com/konveyor/ai-rule-gen --skill rule-writer

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill turns migration guides into actionable Konveyor analyzer rules, eliminating the slow manual work of spotting breaking changes and writing detection logic by hand.

Core Features & Use Cases

  • Migration Pattern Extraction: Identifies removed APIs, relocated classes, renamed dependencies, changed defaults, and config updates from guide prose, tables, and code examples.
  • Rule Generation Workflow: Produces rule-ready metadata for validated Konveyor rules, including documentation links, severity, and migration guidance.
  • Use Case: Use it when you have a long upgrade guide and need precise, testable rules for Java, Go, Node.js, C#, or Python migrations.

Quick Start

Ask the Skill to analyze a migration guide and generate Konveyor rule metadata for the source and target technologies you are migrating between.

Frequently Asked Questions about rule-writer

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I convert migration guide documentation into automated analyzer rules?

You can convert migration guide documentation into automated analyzer rules by extracting breaking changes from prose, tables, and code diffs to generate validated Konveyor rule metadata with detection conditions and documentation links.

What migration patterns can I extract from upgrade guides for rule generation?

Rule generation extracts removed APIs, relocated classes, renamed dependencies, changed defaults, and configuration updates from upgrade guide prose, tables, and code-example diffs to produce validation-ready detection logic.

Does Konveyor rule generation work for Go, Node.js, and Python migrations, or just Java?

Konveyor rule generation applies to Java, Go, Node.js, C#, and Python migrations, extracting source-side artifact detection patterns and rule metadata across multiple technology stacks.

What's the best way to automate detection of API removals and package relocations from long upgrade guides?

Automating detection of API removals and package relocations requires auditable section-by-section analysis of long upgrade guides to produce precise, testable rules with validation-ready conditions and migration guidance.

Can I generate testable rules that include severity levels and documentation links for breaking changes?

Yes, generating testable rules includes producing rule-ready metadata with severity levels, documentation links, and migration guidance to ensure detection logic is auditable and validated against the source guide.

Why do I need section-by-section analysis when extracting migration patterns from configuration renames?

Section-by-section analysis ensures auditable extraction of configuration renames and dependency changes, preventing missed breaking changes and producing validation-ready conditions tied directly to the source guide artifacts.