Skip to main content

@elizaos/plugin-twitter

⚠️ MAINTANENCE NOTICE
This plugin is undergoing maintanence.

A plugin for Twitter/X integration, providing automated tweet posting capabilities with character-aware content generation.

Overview​

This plugin provides functionality to:

  • Compose context-aware tweets
  • Post tweets to Twitter/X platform
  • Manage tweet length restrictions

Installation​

npm install @elizaos/plugin-twitter

Usage​

Import and register the plugin in your Eliza configuration:

import { twitterPlugin } from '@elizaos/plugin-twitter';

export default {
  plugins: [twitterPlugin],
  // ... other configuration
};

Features​

Tweet Composition​

The plugin uses context-aware templates to generate appropriate tweets:

import { postAction } from '@elizaos/plugin-twitter';

// Tweet will be composed based on context and character limits
const result = await postAction.handler(runtime, message, state);

Tweet Posting​

// Post with automatic content generation
await postAction.handler(runtime, message, state);

// Dry run mode (for testing)
process.env.TWITTER_DRY_RUN = 'true';
await postAction.handler(runtime, message, state);

Development​

Building​

npm run build

Testing​

npm run test

Development Mode​

npm run dev

Dependencies​

  • @elizaos/core: Core Eliza functionality
  • tsup: Build tool
  • Other standard dependencies listed in package.json

Core Interfaces​

interface TweetContent {
  text: string;
}

// Tweet Schema
const TweetSchema = z.object({
  text: z.string().describe('The text of the tweet'),
});

// Action Interface
interface Action {
  name: 'POST_TWEET';
  similes: string[];
  description: string;
  validate: (runtime: IAgentRuntime, message: Memory, state?: State) => Promise<boolean>;
  handler: (runtime: IAgentRuntime, message: Memory, state?: State) => Promise<boolean>;
  examples: Array<Array<any>>;
}

Plugin Methods​

  • postAction.handler: Main method for posting tweets
  • postAction.validate: Validates Twitter credentials
  • composeTweet: Internal method for tweet generation
  • postTweet: Internal method for tweet posting

Common Issues/Troubleshooting​

Issue: Tweet Length Errors​

  • Cause: Content exceeds Twitter's character limit
  • Solution: Enable TWITTER_PREMIUM for extended tweets or ensure content is within limits

Security Best Practices​

  • Use 2FA when possible
  • Implement proper error handling
  • Keep dependencies updated
  • Use dry run mode for testing
  • Monitor Twitter API usage

Template System​

The plugin uses a sophisticated template system for tweet generation:

const tweetTemplate = `
# Context
{{recentMessages}}

# Topics
{{topics}}

# Post Directions
{{postDirections}}

# Recent interactions
{{recentPostInteractions}}

# Task
Generate a tweet that:
1. Relates to the recent conversation
2. Matches the character's style
3. Is concise and engaging
4. Must be UNDER 180 characters
5. Speaks from the perspective of {{agentName}}
`;

Contributing​

Contributions are welcome! Please see the CONTRIBUTING.md file for more information.

Credits​

This plugin integrates with and builds upon several key technologies:

  • Twitter/X API: Official Twitter platform API
  • Zod: TypeScript-first schema validation

Special thanks to:

  • The Twitter/X Developer Platform team
  • The Eliza community for their contributions and feedback

For more information about Twitter/X integration capabilities: