faf-validate

Validate project.faf files against the FAF format specification.

4|1|Updated Nov 2, 2025
One-click install
npx skills add https://github.com/Wolfe-Jam/faf-skills --skill faf-validate
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: faf-validate
Source: https://github.com/Wolfe-Jam/faf-skills/tree/main/skills/faf-validate
Command: npx skills add https://github.com/Wolfe-Jam/faf-skills --skill faf-validate

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Validate FAF project.faf format against the IANA-registered application/vnd.faf+yaml specification. Checks YAML syntax, required fields, format version, and best practices.

Core Features & Use Cases

  • Verifies syntax correctness, required metadata, and architecture constraints.
  • Detects missing fields and format_version misalignments before publish or sync.
  • Use case: run validation after edits or prior to distribution to ensure FAF compliance.

Quick Start

Run faf validate to verify your project.faf format and compliance.

Frequently Asked Questions about faf-validate

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

FAQPage Schema
How do I validate my project.faf file against the FAF format specification?

To validate a project.faf file, run the validate command to check YAML syntax, required fields, format_version, and IANA media type compliance, returning clear errors and guidance for any deviations found.

What does YAML compliance check for in an application/vnd.faf+yaml file?

YAML compliance checks for syntax correctness, required metadata fields, format_version alignment, and architecture constraints to ensure the project.faf file meets the IANA-registered application/vnd.faf+yaml specification.

When should I run FAF validation during my development workflow?

Run FAF validation after edits, during pre-publish checks, or as an ongoing quality gate across development workflows to detect missing fields and format_version misalignments before distribution or sync.

Can I use this validation to catch missing required fields before publishing?

Yes, FAF validation verifies required metadata and architecture constraints, detecting missing fields and format_version misalignments before publish or sync to ensure full compliance with the specification.

What is the best way to ensure IANA media type compliance for project.faf files?

The best way to ensure IANA media type compliance is to validate the project.faf file against the application/vnd.faf+yaml specification, which checks YAML syntax, required fields, and format version adherence.

Why does my project.faf file fail format_version validation?

Format_version validation fails when the project.faf file contains misalignments between the declared format version and the IANA-registered specification requirements, which are detected during pre-publish or ongoing quality gate checks.