Package Exports

faf-cli
faf-cli/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (faf-cli) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

🩵⚡️ faf-cli v2.4.4 | .faf - Project DNA for ANY AI✨

Transform Any Project into Perfect AI Context in 30 Seconds

3000+ Downloads • 100% FREE Forever • Works with ALL AI Tools

💬 Join Our Community • ⭐ Star on GitHub • 🐛 Report Issues

🚀 What is .faf?

.faf = Project DNA for ANY AI✨ [Foundational AI-context Format]

Universal, shareable AI-Context for any AI, human or team, regardless of size, location, languages, stack, setup or documentation.

Add a .faf file to your repo and watch Claude, Codex, Gemini, or any AI tool understand your entire codebase with speed and precision.

Join our growing community of 3000+ developers who save hours daily by using .faf files!

💬 Community-Driven • Open Source • Built by Developers, for Developers

🎯 Why Developers Love .faf

The Problem:

❌ Spending 20+ minutes explaining your project to AI
❌ AI gives wrong answers because it doesn't understand your codebase
❌ Copying and pasting files manually into ChatGPT/AI assistants
❌ AI forgets context between sessions/doesn't know your setup properly

The Solution:

✅ One command creates perfect AI context
✅ 30 seconds to complete AI understanding
✅ Works everywhere - Claude, ChatGPT, Gemini, Cursor, any AI
✅ Share context with your team instantly

🚀 Getting Started (30 Seconds!)

⚡️💥 GET BOTH! Double Down! (100% FREE)

# Install BOTH for maximum power - completely FREE!
npm install -g faf-cli           # 🩵 Cyan CLI - Command Line Tool
npm install -g claude-faf-mcp    # 🧡 Orange Smiley MCP - Claude Desktop integration

# Try it now!
cd your-project
faf init

Done! Your AI now understands your project 99% better! 🏁

🤖 Codex CLI Quickstart (AI Assistants)

Install with user approval when required: npm install -g faf-cli
Verify availability right away: faf --version
Run every command in quiet mode to suppress banners: faf init --quiet, faf auto --quiet, faf score --quiet
Pause for approval before any network or write action in sandboxed sessions
Summarize the key results instead of dumping raw output for the user

🌟 Join Our Growing Community!

💬 New Community Hub at github.com/Wolfe-Jam/faf/discussions

Connect with 2000+ developers using .faf to accelerate their AI workflows:

Share your projects - Show what you're building with .faf
Get help - Community support for any questions
Request features - Help shape the future of .faf
Learn best practices - Tips from experienced users

⚡ Key Features

For Developers

Universal Compatibility - Works with Claude, ChatGPT, Gemini, Cursor, and more
30-Second Setup - Run faf init in your project directory and you're done
Smart Auto-Detection - Automatically identifies your tech stack
Real-Time Scoring - Instantly see your AI-readiness score
100% Free & Open Source - No hidden costs, ever

Technical Excellence

Performance - <50ms operations, rigorously benchmarked
Reliability - Extensively tested including edge cases and stress scenarios
Type Safety - 100% TypeScript with strict mode enforcement
Security - Minimal dependencies, fully audited codebase
Production Ready - Zero-error tolerance with comprehensive error handling

💬 Join Our Community

We're building .faf together with our community!

🌟 Star us on GitHub - If you find it helpful!
💬 Join Discussions - Share ideas, get help, show your projects
🐛 Report Issues - Help us improve
📖 Read the Docs - Complete guides and tutorials
🤝 Contribute - PRs welcome!

🛠️ Available Commands

Core Commands

faf init - Initialize .faf context
faf auto - Auto-detect and generate
faf score - Calculate AI readiness score
faf quick - Quick mode with comma-separated values
faf index - Universal A-Z reference of all commands and concepts

Enhancement Commands

faf enhance - Optimized scoring system
faf sync - Sync .faf with CLAUDE.md
faf bi-sync - Bidirectional sync

Management Commands

faf trust - Validate context integrity
faf doctor - Diagnose and fix issues
faf welcome - First-time user guide
faf clear - Clear caches

📖 Usage Examples

# Quick setup for new project
faf quick "my-app, react, typescript, vercel"

# Auto-detect existing project
faf auto

# Check your score
faf score --details

# Fix any issues
faf doctor

# Optimize scoring
faf enhance

📊 Real Metrics

📈 Status: PRODUCTION
├─ 💎 Production Ready
├─ 🚀 Performance: <50ms
├─ 📦 Dependencies: 6 (minimal)
├─ 🧪 Tests Passed: 100%
└─ 🏆 AI Readiness: 100% target

🏁 Development

# Clone repo
git clone https://github.com/Wolfe-Jam/faf.git
cd faf/cli

# Install & build
npm install
npm run build

# Test
npm test

📋 Requirements

Node.js 18+
macOS, Linux, or Windows
Any AI tool (Claude, ChatGPT, Gemini, etc.)

🔗 Links

NPM: faf-cli
Website: faf.one
GitHub: Wolfe-Jam/faf
Community: Join Discussions
Support: support@faf.one

📄 License

MIT License - see LICENSE file for details.

Note: The .faf-Engine(s) are proprietary and available under license.

⚡️💥 The Complete FAF Ecosystem

🩵 Cyan CLI • 🧡 Orange Smiley MCP • 💚 WEB • 🧰 DevOps • 🖥️ Chrome

🏎️⚡️ FAST AF - Project DNA for ANY AI ✨

Made with 🧡 by wolfejam | 3000+ Weekly Downloads | Growing Community 🎉

100% FREE Forever • No Strings Attached • Just Build Faster with AI