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 - The JPEG for AIโข
๐ MAJOR UPDATE v2.2.0 - FREE for all Developers!
No pricing, no subscriptions, 100% FREE & Open Source CLI
๐ FREE & Open Source AI Context Management
20 minutes โ 3 minutes โข <50ms processing โข 99% AI understanding
๐งก What is .faf?
.faf (Foundational AI-context Format) is the universal standard for AI context management. Like JPEG revolutionized image compression, .faf revolutionizes how AI understands your projects.
The Problem We Solve
- ๐ 20+ minutes manually feeding context to AI
- ๐ค 78% incomplete context leading to wrong outputs
- ๐ธ Wasted time re-explaining your project repeatedly
- ๐คฏ AI confusion from poor project understanding
The .faf Solution
- โก๏ธ 3 minutes to 99% AI understanding (3 seconds AI, 2:57 human clicking ๐)
- ๐๏ธ <50ms processing time
- ๐ฏ 154+ formats validated and supported
- ๐ Eternal-Syncโข keeps context always current
๐ Real Achievements
- ๐ 100% FREE - Open source CLI tool
- ๐ฆ 800+ Weekly Downloads - Growing community
- ๐ MCP Integration - Works with Claude Desktop
- โ TypeScript Strict Mode - Zero violations
- โ Battle Tested - 20 extreme stress tests passed
- ๐๏ธ Championship Grade - <50ms performance
๐ Quick Start
Install the FREE CLI
# 100% FREE - No credit card required
npm install -g faf-cliGenerate Your First .faf
cd your-project
faf autoThat's it! Your AI now understands your project 99% better.
๐ ๏ธ The FAF Ecosystem
1. FAF CLI - Command Line Power
faf auto # Smart .faf generation with instant scoring
faf score --details # See your AI-readiness percentage
faf trust # View trust dashboard & achievements๐ฆ NPM Package โข ๐ CLI Docs
2. Chrome Extension - Browser Magic
Extract context from any web-based IDE or platform:
- GitHub/GitLab/Bitbucket
- Replit/CodeSandbox/StackBlitz
- VS Code Web/Codespaces
- 15+ platforms supported
๐ฏ Install Extension โข ๐ Extension Docs
3. MCP Server - Claude Desktop Integration
{
"mcpServers": {
"faf": {
"command": "npx",
"args": ["@faf/mcp-server"]
}
}
}๐ฆ NPM Package โข ๐ MCP Docs
4. Svelte Engine - Visual Excellence
Beautiful web interface with real-time scoring visualization.
๐ Live Demo โข ๐ Engine Docs
๐ Performance Metrics
| Metric | Before FAF | With FAF | Improvement |
|---|---|---|---|
| Context Setup | 20 minutes | 3 minutes | 6.7x faster |
| AI Understanding | 22% | 99% | 4.5x better |
| Processing Time | 3+ seconds | <50ms | 60x faster |
| Format Support | Manual | 154+ auto | โ better |
๐๏ธ Repository Structure
FAF/
โโโ cli/ # FAF CLI - NPM package
โโโ chrome-extension/ # Browser extension
โโโ claude-faf-mcp/ # MCP server for Claude
โโโ faf-svelte-engine/ # Web interface
โโโ faf-engine/ # Core scoring engine
โโโ fafdev-tools/ # Desktop DevOps tools
โโโ faf-one-deploy/ # Website & deployment๐ค Contributing
We welcome contributions! Please read our Contributing Guide first.
Development Setup
git clone https://github.com/yourusername/faf.git
cd faf/cli
npm install
npm testRunning Tests
npm run test # Run all tests
npm run test:watch # Watch mode
npm run test:perf # Performance tests๐ฆ Dependencies (Lean & Mean)
Production Dependencies (6 only!):
@faf/engine(local) - Our core enginechalk(^4.1.2) - Terminal colorscommander(^9.5.0) - CLI frameworkglob(^11.0.3) - File patternsinquirer(^12.9.4) - Interactive promptsyaml(^2.4.1) - The .faf language (YAML & ๐ noodles)
โ Cleanup Complete:
- Removed
openai- Not used - Removed
enquirer- Duplicate - Moved
@types/inquirerto devDependencies - 33% reduction achieved! (9 โ 6 dependencies)
๐๏ธ F1-Inspired Philosophy
We build software like F1 teams build race cars:
- Performance Mad - <50ms or it's too slow
- Zero Errors - Perfection is the standard
- Championship Grade - 85%+ scores minimum
- Premium Quality - AMG Mercedes, not Honda Civic
๐ Roadmap
- CLI Tool (NPM Published)
- Chrome Extension (Live in Store)
- MCP Server (Claude Ready)
- Web Engine (Production)
- VS Code Extension (Q1 2025)
- Desktop App (Q1 2025)
- Team Features (Q2 2025)
- Enterprise SSO (Q2 2025)
๐ฏ Use Cases
For Developers
- Instant AI context for any project
- Never re-explain your codebase
- 6.7x faster AI interactions
For Teams
- Shared context across team
- Onboard new devs instantly
- Consistent AI assistance
For Enterprises
- Standardized AI context
- Security-first approach
- Measurable productivity gains
๐ Documentation
๐ Awards & Recognition
- ๐ฅ MCP PR Submitted - #2759 (pending review)
- โญ 9.3/10 AI Rating - Highest in category
- ๐ ProductHunt - Coming soon
- ๐ฐ Press Coverage - View Press Kit
๐ Support & Contact
- ๐ฆ NPM Package: npmjs.com/package/faf-cli
- ๐ Issues: GitHub Issues
- ๐ง Email: support@faf.one
- ๐ Docs: faf.one/docs
๐ License
MIT License - see LICENSE file for details.
๐ Acknowledgments
Built with thousands of hours of expert development. From the creators of .iff (Commodore Amiga) to .faf - 4 decades of format expertise.
Stop Faffing About. Start Shipping.
๐ Get Started Now โข ๐ Founder $9/month
Made with ๐งก by the .faf Team