Farcaster Integration

Welcome to the comprehensive documentation for the @elizaos/plugin-farcaster package. This index provides organized access to all documentation resources.

The @elizaos/plugin-farcaster enables your elizaOS agent to interact with the Farcaster social network through casting, replying, and engaging with the decentralized social protocol.

📚 Documentation

• Developer Guide - Detailed technical reference
• Cast Flow - Visual guide to cast processing
• Examples - Practical implementation examples
• Testing Guide - Testing strategies and patterns

🔧 Configuration

Required Settings

• FARCASTER_NEYNAR_API_KEY - Neynar API key for authentication
• FARCASTER_SIGNER_UUID - Neynar signer UUID for your account
• FARCASTER_FID - Your Farcaster ID (FID)

Optional Settings

• ENABLE_CAST - Enable autonomous casting (default: true)
• ENABLE_ACTION_PROCESSING - Enable processing interactions (default: false)
• FARCASTER_DRY_RUN - Test mode without posting (default: false)
• CAST_INTERVAL_MIN - Minimum interval between casts in minutes (default: 90)
• CAST_INTERVAL_MAX - Maximum interval between casts in minutes (default: 180)
• ACTION_TIMELINE_TYPE - Type of timeline to use for actions (default: ForYou)