ores-cli-recipes

Compare CLI entity parsers with recipe docs and update recipe blocks.

25|5|Updated Jun 15, 2024
One-click install
npx skills add https://github.com/OreStudio/OreStudio --skill ores-cli-recipes
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: ores-cli-recipes
Source: https://github.com/OreStudio/OreStudio/tree/main/.claude/skills/ores-cli-recipes
Command: npx skills add https://github.com/OreStudio/OreStudio --skill ores-cli-recipes

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill keeps the ORE Studio CLI documentation aligned with the actual commands implemented, reducing drift between code and recipes and ensuring accurate user guidance.

Core Features & Use Cases

  • Automated recipe validation: Compare the parser-defined commands and options against the documented CLI recipes and identify discrepancies.
  • Documentation hygiene: Update or create missing recipes for new commands and adjust option names to match parser definitions.
  • Use Case: When a new CLI command is added or an option is renamed, run this skill to synchronize doc changes with the source of truth.

Quick Start

Run a diff between the CLI parsers and doc/recipes/cli_recipes.org to generate or update recipes.

Frequently Asked Questions about ores-cli-recipes

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

FAQPage Schema
Why does my CLI recipe documentation show outdated option names?

To keep CLI documentation synced with command changes, compare source entity parsers against documented recipes to identify discrepancies and generate updated recipe blocks with accurate option names.

What is the best way to update CLI recipes when options are renamed?

The best way to update CLI recipes when options are renamed is to diff the parser definitions with the recipe documentation, ensuring the documented option names match the current source of truth.

How do I validate CLI recipes against parser definitions?

To validate CLI recipes against parser definitions, run a diff comparing the command parsers with the recipe documentation to detect missing commands or mismatched option names and produce corrections.

When do I need to regenerate CLI recipe documentation?

You need to regenerate CLI recipe documentation when new commands are added or existing commands change across the CLI, ensuring the documentation reflects the current implemented command set.

Does this CLI recipe synchronization work without external dependencies?

Yes, CLI recipe synchronization works without external dependencies, directly comparing internal project entity parsers with the recipe documentation to output updated blocks.

Why does my CLI recipe documentation show outdated option names?

CLI recipe documentation shows outdated option names when the source code parsers have been updated but the documentation has not been synchronized to reflect the current command definitions.