Skip to content

Latest commit

 

History

History
85 lines (63 loc) · 2.3 KB

README.md

File metadata and controls

85 lines (63 loc) · 2.3 KB

@elizaos/plugin-verifiable-twitter

Overview

@elizaos/plugin-verifiable-twitter is a plugin designed for the ElizaOS platform, providing integration with verifiable Twitter/X subagent. The

Features

  • Integration with Twitter API
  • Supports verifiable actions on Twitter

Usage

To use the plugin, you need to configure the following environment variables with your Twitter API credentials:

  • TWITTER_CONSUMER_KEY: Twitter API Key
  • TWITTER_CONSUMER_SECRET: Twitter API Key Secret
  • TWITTER_ACCESS_TOKEN: Twitter API Access Token
  • TWITTER_ACCESS_TOKEN_SECRET: Twitter API Access Token Secret

These credentials can be obtained from the X Developer Portal.

Add dependencies to agent/package.json in eliza

{
    "name": "@elizaos/agent",
    ...
    "dependencies": {
        ...
        "@elizaos/plugin-verifiable-twitter": "github:automata-network/eliza-plugin-verifiable-twitter"
    },
    ...
}

Add plugin and secret to character configuration

{
    "name": "MyAgent",
    "settings": {
        ...
        "secrets": {
            "TWITTER_CONSUMER_KEY": "",
            "TWITTER_CONSUMER_SECRET": "",
            "TWITTER_ACCESS_TOKEN": "",
            "TWITTER_ACCESS_TOKEN_SECRET": ""
        }
    },
    "plugins": [
        "@elizaos/plugin-verifiable-twitter"
    ]
}

Note: If you have already set the secrets in .env, you don't need to set them again in the character configuration.

Installation

To install the plugin, use the following command:

pnpm install @elizaos/plugin-verifiable-twitter

Development

To build the project, run:

pnpm build

License

This project is licensed under the Apache2 License. See the LICENSE file for details.