Getting Started

Getting Started

Use this page to install an individual skill, inspect the repository, or run its validation suite.

Choose your starting point

• Use ChefSkills with GitHub Copilot: follow GitHub Copilot Setup.
• Inspect or contribute to the framework: clone the repository and run validation below.
• Understand how a request is handled: read Architecture, then Routing and State Model.

Prerequisites

• Git
• Python 3.10 or newer
• PowerShell for the repository wrapper script
• GitHub CLI with gh skill support for Copilot installation

The current validators use the Python standard library only.

Clone and validate

git clone https://github.com/jeremylongworth-source/ChefSkills.git
cd ChefSkills
.\scripts\validate-all.ps1

Expected result:

All ChefSkills validation checks passed.

The full suite checks skill files, skillsets, routing, state, evaluation fixtures, live-run manifests, reports, scorecards, and the generated scorecard summary.

If PowerShell is unavailable, run the individual Python commands listed in the repository evaluation documentation.

First useful read

Read these source files in order:

1. README.md
2. docs/architecture.md
3. docs/routing.md
4. docs/state-model.md
5. evaluation/README.md

First route

Use a skillset as the starting composition:

• skillsets/chef.yaml for broad culinary reasoning
• skillsets/recipe-development.yaml for recipe design, adaptation, testing, and scaling

Example:

Prompt: My chicken thighs keep charring on the grill before they are cooked near the bone.
Route: chef-core, equipment-cookery, protein-cookery, food-safety, cooking-techniques

The route combines equipment behavior, protein doneness, technique, and food safety without loading every specialist skill.

Troubleshooting

• Run commands from the repository root.
• Confirm Python is available with python --version.
• If scorecard validation fails after changing reports, regenerate the summary:

python .\scripts\summarize-scorecards.py --output .\evaluation\scorecards\summary.json

• If routing validation fails, inspect tests/scenarios/, tests/expected-routing.yaml, and router/routing-catalog.yaml together.