@astreus-ai/x-plugin NPM

Astreus X Plugin

An X (formerly Twitter) integration plugin for the Astreus AI agent framework, allowing agents to interact with X.

Features

Official X API Integration: Uses the official X API v2
Comprehensive X Integration: Access profiles, tweets, search, post tweets, and more
Poll Support: Create polls on X
Rich Media Support: Post tweets with images and videos
Enhanced Logging: Detailed logging of API requests and responses for improved debugging
Integration with Astreus Logger: Consistent logging patterns with the core framework

Installation

npm install @astreus-ai/x-plugin

Configuration

Create a .env file with your X API credentials:

# X API v2 credentials
X_API_KEY=your_api_key
X_API_SECRET_KEY=your_api_secret
X_ACCESS_TOKEN=your_access_token
X_ACCESS_TOKEN_SECRET=your_access_token_secret

# Configuration options
CACHE_TWEET_SECONDS=300  # Cache tweets for 5 minutes
CACHE_PROFILE_SECONDS=3600  # Cache profiles for 1 hour

# Logging options
LOG_LEVEL=info  # Options: error, warn, info, debug

Usage

Basic Usage

import { createAgent } from 'astreus';
import XPlugin from '@astreus-ai/x-plugin';

// Create an X plugin instance
const xPlugin = new XPlugin();

// Initialize the plugin
await xPlugin.init();

// Create an agent with the X plugin
const agent = await createAgent({
  name: 'Social Media Agent',
  description: 'An agent that can interact with X',
  plugins: [xPlugin]
});

// Now the agent can use X functionality
const response = await agent.chat(`Find the latest tweets from Elon Musk and summarize them.`);

Custom Configuration

import { createAgent } from 'astreus';
import XPlugin from '@astreus-ai/x-plugin';

// Create a plugin with custom configuration
const xPlugin = new XPlugin({
  apiKey: 'your_api_key',
  apiSecret: 'your_api_secret',
  accessToken: 'your_access_token',
  accessSecret: 'your_access_token_secret',
  cacheTweetSeconds: 600,
  logLevel: 'debug'  // Set logging verbosity
});

// Initialize the plugin
await xPlugin.init();

// Create an agent with the plugin
const agent = await createAgent({
  name: 'Social Media Agent',
  description: 'An agent that can interact with X',
  plugins: [xPlugin]
});