diff --git a/README.md b/README.md index 0cd5c2a..d690ba7 100644 --- a/README.md +++ b/README.md @@ -89,6 +89,7 @@ Now you're ready to use pre-commit hooks in your project! Explore the list of ho ## 🌐Languages +- [AKF — The AI Native File Format](languages/AKF.md) - [Python](languages/Python.md) ## šŸ¤Contributing diff --git a/languages/AKF.md b/languages/AKF.md new file mode 100644 index 0000000..ba2a50a --- /dev/null +++ b/languages/AKF.md @@ -0,0 +1,50 @@ +# AKF — The AI Native File Format + +## Overview + +- **GitHub Repository:** [AKF Pre-Commit Hooks](https://github.com/HMAKT99/akf-pre-commit) +- **Category(ies):** AI, Metadata, Compliance, Trust + +## Tutorial + +### What is AKF? + +AKF (Agent Knowledge Format) is the AI native file format — EXIF for AI. It embeds trust scores, source provenance, and compliance metadata into every file your AI touches. ~15 tokens of JSON that travel with the file across 20+ formats (DOCX, PDF, images, code). + +### Why Use AKF with Pre-Commit? + +As AI generates more code and content, every committed file should carry provenance — who generated it, what model, what confidence level, what sources. The AKF pre-commit hook auto-stamps this metadata on every commit, so your entire repo carries trust data. + +This is especially important with the EU AI Act Article 50 taking effect August 2, 2026, requiring transparency metadata on AI-generated content. + +### Installation via Pre-Commit Hook + +First install the AKF CLI: + +```bash +pip install akf +``` + +Then add the following to your `.pre-commit-config.yaml`: + +```yaml +repos: + - repo: https://github.com/HMAKT99/akf-pre-commit + rev: v1 + hooks: + - id: akf-stamp + - id: akf-audit +``` + +### Available Hooks + +| Hook | Description | +|------|-------------| +| `akf-stamp` | Stamps committed files with trust metadata (trust scores, provenance) | +| `akf-audit` | Checks files against EU AI Act Article 50 compliance | + +### Links + +- **Website:** [akf.dev](https://akf.dev) +- **Main Repo:** [HMAKT99/AKF](https://github.com/HMAKT99/AKF) +- **Demo:** [HuggingFace Space](https://huggingface.co/spaces/HANAKT19/akf)