JSPM

  • Created
  • Published
  • Downloads 59
  • Score
    100M100P100Q89005F
  • License MIT

๐Ÿฉต Cyan CLI - Transform any project into perfect AI context in 30 seconds. Works with Claude, Codex, Gemini & ALL AI tools. Join 3000+ developers using .faf files. 100% FREE โ€ข Open Source โ€ข If helpful, a โญ is appreciated!

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.5.4 - When Claude Forgot FAF | Birth DNA Edition

Orange Smiley

Project DNA โœจ for ANY AI โ€ข Context-Mirroring โ€ข As fast as 8ms Sync

NPM Version Downloads License: MIT TypeScript

Website โ€ข Community โ€ข Issues


FAF Championship Banner


The Meta-Proof: Even Claude Forgot .FAF

The AI that built FAF scored it at 12% without .faf.

We created this tool together across thousands of conversations. Yet without project DNA, even Claude couldn't recognize its own work. That's the problem FAF solves.

Before .faf - Birth: 12%

FAF CLI birth score: 12% context

Context Score: 12% โ€” Even the AI that built it couldn't recognize it


The Transformation - 344ms Later

Running faf init - 344ms

faf init โ€” One command. Zero configuration. Project DNA created.


After .faf - Current: 89%

FAF CLI after .faf: 89% context score

Context Score: 89% โ€” Instant comprehension. Persistent memory.

+77% improvement in 344ms. That's what project DNA does for ANY AI, ANY project.


๐Ÿš€ What's New in v2.5.4 - Birth DNA Edition

What's New:

  • โœจ Birth DNA terminology (goodbye confusing "birth weight")
  • ๐ŸŽซ Birth Certificates with unique IDs (e.g., FAF-2025-CLIX-651L)
  • โฑ๏ธ Smart time display: Shows minutes/hours/days since birth
  • ๐Ÿ”ง Fixed: Chrome Extension false positive on CLI projects
  • ๐Ÿ“Š Track your journey: faf log shows complete evolution

Context-Mirroring + Championship Scoring

Keep .faf (structured data) and CLAUDE.md (human-readable) in perfect sync automatically, while tracking every improvement milestone from Lonely Heart ๐Ÿค 0% โ†’ ๐Ÿ† 100% Podium Champion.

Live C-MIRROR output:

๐Ÿ”— C-MIRROR LIVE
โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”
โ”œโ”€ Syncing โ† claude-to-faf...
โ”œโ”€ โ–ˆโ–ˆโ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘ 10% - Parsing CLAUDE.md content...
โ”œโ”€ โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘ 40% - Merging human context updates...
โ”œโ”€ โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘ 70% - Updating sync metadata...
โ”œโ”€ โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–‘โ–‘โ–‘ 90% - Generating .faf YAML...
โ””โ”€ ๐ŸŽ‰ Synchronized in 8ms ๐ŸŽ๏ธโšก๏ธ๐Ÿ’ฅ
   Files: .faf

โœ… Integrity: PERFECT
   Mirror verified - zero slippage
๐Ÿ’Ž Technical Credit ๐Ÿ’Ž +1 +4 points
โ””โ”€ Bi-sync harmony maintained

Key Features:

  • As fast as 8ms (typical 10-15ms, 95% under 50ms)
  • Bidirectional: .faf โ†” CLAUDE.md
  • Journey tracking: From ๐Ÿค project birth to the ๐Ÿ† podium
  • Zero-slippage: Atomic file operations guarantee
  • Cross-platform: Mac + Windows tested (20/20 tests)
  • Universal: Works with Claude, Gemini, Cursor, all AI tools

Championship Scoring Display - MCP Visual Polish Arrives in CLI

The Upgrade: Experience the same polished progress bar format from claude-faf-mcp, now in your terminal.

faf score
๐Ÿฅ‰ Score: 89/100
โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–‘โ–‘โ–‘ 89%
Status: Target 1 - Bronze

Next milestone: 95% ๐Ÿฅˆ Target 2 - Silver (6 points to go!)

๐ŸŽ๏ธ  FAF Championship Status
โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”
Initial DNA: 12% (born 2025-10-03)
Growth: +77% over 0 days
Next Milestone: 95% ๐Ÿฅˆ Target 2 - Silver (6% to go!)

What's New:

  • Progress Bar Format - MCP's championship-grade visualization ported to CLI
  • Scoreboard Title - Initial DNA โ†’ Current score tracking above ASCII art
  • Visual Polish - Clean white text with FAF brand colors (cyan/orange)
  • Asset Fix - Orange smiley logo and ASCII banner load properly on npm
  • Brotherhood Sync - CLI and MCP now share same visual DNA

๐Ÿ† Championship Scoring System

Track your project's AI-readiness with F1-inspired tiers:

๐Ÿ† Trophy (100%)    - Championship - Perfect 50|50 AI|HUMAN balance
๐Ÿฅ‡ Gold (99%)       - Gold standard
๐Ÿฅˆ Silver (95-98%)  - Excellence
๐Ÿฅ‰ Bronze (85-94%)  - Production ready
๐ŸŸข Green (70-84%)   - Good foundation
๐ŸŸก Yellow (55-69%)  - Getting there
๐Ÿ”ด Red (0-54%)      - Needs attention
๐Ÿค Heart 0%         = Starting Good Luck!

Live output in your terminal:

๐ŸŽ๏ธ  FAF Stats
โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•

๐Ÿ“Š Score: 100% ๐Ÿ†

๐Ÿ† Status: Championship - You're at the podium!
โš–๏ธ  Balance: โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘ AI:55% | โ–‘โ–‘โ–‘โ–‘โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆ HUMAN:45%

๐ŸŽฏ Achievement: Perfect AI readiness - Championship balance!

๐Ÿš€ Quick Start

# Install globally
npm install -g faf-cli

# Initialize in any project
cd your-project
faf init

# Auto-detect and score
faf auto
faf score

# Sync with CLAUDE.md (NEW!)
faf bi-sync

Your AI now understands your project! ๐Ÿ


๐ŸŽฏ What is faf-cli?

Command-line tool that creates .faf files for instant AI project understanding.

.faf = Project DNA โœจ for ANY AI Universal, shareable context for Claude, ChatGPT, Gemini, Cursor - regardless of stack, size, or setup.

Why Developers Love It

The Problem:

  • โŒ 20+ minutes explaining projects to AI
  • โŒ AI gives wrong answers without context
  • โŒ Manual copy/paste into chat interfaces
  • โŒ Context lost between sessions

The Solution:

  • โœ… One command creates perfect context
  • โœ… 30 seconds to complete understanding
  • โœ… Works with every AI tool
  • โœ… Share context with your team instantly
  • โœ… NEW: Bidirectional sync keeps everything in harmony

Key Features

  • โœ… Universal - Works with all AI tools
  • โœ… Fast - As fast as 8ms sync (typical 10-15ms)
  • โœ… Smart - Auto-detects your tech stack
  • โœ… Simple - One command setup
  • โœ… Bidirectional - Edit .faf or CLAUDE.md, both update
  • โœ… Free - 100% open source, forever

๐Ÿ› ๏ธ Available Commands

Core Commands

  • faf init - Initialize project context
  • faf auto - Auto-detect and populate
  • faf score - Calculate AI readiness
  • faf status - Project health check
  • faf quick "app, react, vercel" - Quick setup

Context-Mirroring

  • faf bi-sync - Bidirectional sync (.faf โ†” CLAUDE.md)
    • As fast as 8ms (typical 10-15ms)
    • Zero data loss guarantee
    • Edit either file, both update
    • Cross-platform verified

Enhancement Commands

  • faf enhance - Optimize scoring
  • faf sync - Sync with CLAUDE.md (one-way)

Management Commands

  • faf trust - Validate integrity
  • faf doctor - Diagnose issues
  • faf clear - Clear caches
  • faf index - A-Z command reference

Utility Commands

  • faf version - Show version (with ASCII art!)
  • faf welcome - First-time guide
  • faf help - Command help

๐Ÿ’ก Usage Examples

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

# Auto-detect existing project
faf auto

# Check your score with details
faf score --details

# See current status
faf status

# NEW: Bidirectional sync with CLAUDE.md
faf bi-sync

# Fix any issues
faf doctor

# Optimize scoring
faf enhance

# Quiet mode (for AI assistants)
faf init -q
faf auto -q

๐ŸŽ‰ Version History

v2.5.4 (October 5th, 2025) - When Claude Forgot FAF | Birth DNA Edition

  • Meta-proof section - 12% โ†’ 89% transformation documented with before/after screenshots
  • Birth DNA terminology - Clearer language replacing "birth weight"
  • Birth Certificates - Unique IDs for every project (e.g., FAF-2025-CLIX-651L)
  • Smart time display - Minutes/hours/days since project birth
  • Chrome Extension detection fix - Only shows when contextually relevant
  • faf log command - Track complete project evolution

v2.5.3 (October 4th, 2025)

  • Removed Mk2 engine fragments from scoring
  • TypeScript strict mode improvements
  • Code cleanup and review refinements
  • Updated documentation

v2.5.2 (October 3rd, 2025) - Championship Scoring & Asset Fix

  • Championship Scoring Display - MCP's progress bar format ported to CLI
  • Asset Fix - Orange smiley logo and ASCII banner now load properly on npm
  • Visual Polish - Clean white text with FAF brand colors
  • Scoreboard Title - Initial DNA and current score above ASCII art box

v2.5.0 (October 3rd, 2025) - Context-Mirroring Release

  • Context-Mirroring engine - Bidirectional .faf โ†” CLAUDE.md sync
  • C-Mirror - Championship-grade sync in 15ms average
  • Zero-slippage guarantee - Atomic file operations
  • Cross-platform verified - Mac + Windows tested
  • 20/20 test suite - All edge cases conquered
  • Event-driven architecture - Power Chords system
  • TypeScript strict mode - 100% type safety

v2.4.6 - Performance Championship

  • 60% faster operations across all commands
  • Native engine - Championship-grade performance
  • Zero display bugs - Perfect terminal rendering
  • 100% backwards compatible - Same commands, more speed

v2.4 Highlights

  • AI|HUMAN Balance - Track 50|50 balance for championship
  • Enhanced auto-detection - Smarter tech stack recognition
  • Improved scoring - More accurate AI-readiness metrics

๐Ÿ“Š Technical Specs

Version:       2.5.4
Performance:   As fast as 8ms (typical 10-15ms, 95% under 50ms)
C-Mirror:      Championship-grade bidirectional sync
TypeScript:    100% strict mode
Dependencies:  2 (inquirer, yaml)
Tests:         100% passing (20/20 C-Mirror suite)
Build:         Zero errors
Platform:      Mac, Linux, Windows

๐Ÿ”ฌ Context-Mirroring Technical Details

Architecture

  • Event-driven: Power Chords broadcast at lowest level
  • Atomic operations: Write โ†’ Validate โ†’ Commit pattern
  • Bidirectional intelligence: Preserves technical fields during sync
  • Format-agnostic: Works with any Tool.md format
  • Self-healing: Automatic backup and recovery

Performance

  • Best case: 8ms (championship performance)
  • Typical: 10-15ms per sync operation
  • 95th percentile: Under 50ms
  • Worst case: <110ms (complex validation)

Testing

  • 20/20 test suite passed (WJTC certified)
  • Edge cases conquered: Emoji, Unicode, nested quotes, Windows paths
  • Round-trip verified: Perfect data preservation
  • Cross-platform: Mac + PC tested

๐Ÿค– For AI Assistants (Codex, Cursor, Copilot)

When using faf-cli programmatically:

  1. Install with user approval: npm install -g faf-cli
  2. Verify: faf --version
  3. Use quiet mode: faf init -q, faf auto -q, faf score -q
  4. Use faf bi-sync for CLAUDE.md synchronization
  5. Request approval before network/write operations
  6. Summarize results instead of raw output

๐Ÿ—๏ธ Development

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

# Install & Build
npm install
npm run build

# Test
npm test

# Test C-Mirror specifically
npm run test -- tests/c-mirror/

# Link locally
npm link

๐Ÿ“‹ Requirements

  • Node.js 18+
  • OS: macOS, Linux, or Windows
  • AI Tools: Works with Claude, ChatGPT, Gemini, Cursor, etc.

๐Ÿ”— The FAF Ecosystem


๐Ÿ“„ License

MIT License - See LICENSE file


๐Ÿค Contributing

We welcome contributions! Join our community discussions or submit issues/PRs.

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

  • Share your projects
  • Get help from the community
  • Request features
  • Learn best practices

Made with ๐Ÿงก by wolfejam

100% FREE Forever โ€ข 3000+ Weekly Downloads โ€ข Zero Faffโ„ข

โญ Star on GitHub โ€ข ๐Ÿ“ฆ View on NPM