Skip to content

Wolfe-Jam/faf-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
FAF

faf-cli

IANA-Registered Format for AI Context · application/vnd.faf+yaml

.FAF optimizes AI for your codebase. At 100% (Gold Code), AI stops guessing and starts knowing. Live bi-sync between .fafCLAUDE.md means zero context-drift — your project DNA stays aligned with AI, forever.

NPM Downloads Homebrew Website License: MIT


The Problem: Context-Drift

AI assistants forget. They misunderstand. They drift.

Every new session, every new file, every new developer — AI starts guessing again. Your codebase context leaks away. Yesterday's perfect assistant becomes today's confused intern.

.FAF fixes this permanently.


The Solution: Gold Code

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
🏆  FAF AI-READINESS SCORE: 100/100 — GOLD CODE
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

At 100%, AI is optimized. No more guessing.
Peak AI performance activated.

├─ Project DNA locked in        ├─ Zero context-drift
├─ Architecture understood      ├─ Eternal bi-sync active
├─ Domain model captured        ├─ Team alignment permanent
└─ Every session starts smart   └─ AI works WITH you, not around you

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

💎 Lifecycle Value

Setup savings get you started. Lifecycle optimization keeps you ahead.

When Without FAF With FAF
Day 1 20 min setup per dev 0 min — instant context
Month 1 AI forgets between sessions AI remembers everything
Year 1 New devs re-explain everything New devs inherit full context
Year 3+ Institutional knowledge lost Project DNA preserved forever

Setup savings: 20 minutes. Lifecycle savings: Infinite.


⚡ Quick Start

# Install
npm install -g faf-cli    # or: brew install faf-cli

# Initialize
cd your-project
faf init                  # Creates project.faf

# Check your score
faf score                 # 0-100% AI-readiness

# Reach Gold Code
faf auto                  # Auto-enhance to 100%

What's New in v3.4.7 — Google Gemini Edition

Full interoperability with the Google Gemini ecosystem. One .faf file now works everywhere.

Platform Format FAF Command
Gemini CLI GEMINI.md faf gemini
Antigravity IDE ~/.gemini/GEMINI.md faf gemini --global
Conductor Extension conductor/ directory faf conductor
Claude Code CLAUDE.md faf bi-sync
# Import from Google formats
faf gemini import       # GEMINI.md → .faf
faf conductor import    # conductor/ → .faf

# Export to Google formats
faf gemini export       # .faf → GEMINI.md
faf conductor export    # .faf → conductor/

# Global Antigravity config
faf gemini --global     # ~/.gemini/GEMINI.md

Universal AI Context — Write once, use with Claude, Gemini CLI, Antigravity IDE, and Conductor.


🔄 Eternal Bi-Sync

The magic: .fafCLAUDE.md stay synchronized in milliseconds.

project.faf  ←──── 8ms ────→  CLAUDE.md
     │                            │
     └── Single source of truth ──┘
faf bi-sync              # Sync once
faf bi-sync --watch      # Continuous sync

Tier System: From Blind to Optimized

Tier Score Status
🏆 Trophy 100% AI Optimized — Gold Code
🥇 Gold 99%+ Near-perfect context
🥈 Silver 95%+ Excellent
🥉 Bronze 85%+ Production ready
🟢 Green 70%+ Solid foundation
🟡 Yellow 55%+ AI flipping coins
🔴 Red <55% AI working blind
🤍 White 0% No context at all

At 55%, AI is guessing half the time. At 100%, AI is optimized.


Core Commands

Command Purpose
faf init Create project.faf from your codebase
faf score Check AI-readiness (0-100%)
faf auto Auto-enhance to Gold Code
faf bi-sync Sync .faf ↔ CLAUDE.md (8ms)
faf readme Extract 6 Ws from README (+25-35% boost)
faf human Interactive human context entry
faf human-set Non-interactive field setting
faf formats Show 153 detected formats
faf conductor Google Conductor interop (import/export/sync)
faf gemini Gemini CLI / Antigravity interop
faf demo sync Live bi-sync demonstration

Run faf --help for all 46 commands.


Human Context (The 6 Ws)

Boost your score by 25-35% with human context — the information only YOU know.

# Auto-extract from README
faf readme --apply

# Manual entry
faf human-set who "Frontend team at Acme Corp"
faf human-set what "Customer dashboard with real-time analytics"
faf human-set why "10x faster than previous solution"

CLI vs MCP

Tool Use Case
faf-cli (this) Terminal, scripts, CI/CD, automation
claude-faf-mcp Claude Desktop via MCP protocol

Same .faf format. Same scoring. Same Gold Code. Different execution layer.


📦 Ecosystem


📚 Documentation


📄 License

MIT License — Free and open source


Zero drift. Eternal sync. AI optimized. 🏆

"It's so logical if it didn't exist, AI would have built it itself" — Claude