Skip to content

Latest commit

 

History

History
117 lines (82 loc) · 7.07 KB

README.md

File metadata and controls

117 lines (82 loc) · 7.07 KB
Raw

Auto-GPT-Plugins

⚠️💀 WARNING 💀⚠️: Review the code of any plugin you use thoroughly, as plugins can execute any Python code, potentially leading to malicious activities, such as stealing your API keys.

Installation

⚠️This is a work in progress⚠️

Follow these steps to configure the Auto-GPT Plugins:

  1. Install Auto-GPT

    If you haven't already, follow the installation instructions provided by Auto-GPT to install it.

  2. Run the following to pull the plugins folder down from the root of autogpt

    To download it directly from your Auto-GPT directory, you can run this command on Linux or MacOS:

    curl -L -o ./plugins/Auto-GPT-Plugins.zip https://github.com/Significant-Gravitas/Auto-GPT-Plugins/archive/refs/heads/master.zip

    In PowerShell:

    Invoke-WebRequest -Uri "https://github.com/Significant-Gravitas/Auto-GPT-Plugins/archive/refs/heads/master.zip"     -OutFile "./plugins/Auto-GPT-Plugins.zip"

  3. Run the dependency install script for plugins You can run it with either: Linux or MacOS:

    ./run.sh --install-plugin-deps

    Windows:

    .\run.bat --install-plugin-deps

    Or directly via the CLI:

    python -m autogpt --install-plugin-deps

Plugins in the repository

For interactionless use, set ALLOWLISTED_PLUGINS=example-plugin1,example-plugin2,example-plugin3 in your .env

Plugin Description Location
Twitter AutoGPT is capable of retrieving Twitter posts and other related content by accessing the Twitter platform via the v1.1 API using Tweepy. autogpt_plugins/twitter
Email Revolutionize email management with the Auto-GPT Email Plugin, leveraging AI to automate drafting and intelligent replies. autogpt_plugins/email
SceneX Explore image storytelling beyond pixels with the Auto-GPT SceneX Plugin. autogpt_plugins/scenex
Bing Search This search plugin integrates Bing search engines into Auto-GPT. autogpt_plugins/bing_search
News Search This search plugin integrates News Articles searches, using the NewsAPI aggregator into Auto-GPT. autogpt_plugins/news_search
Wikipedia Search This allows AutoGPT to use Wikipedia directly. autogpt_plugins/wikipedia_search

Some third-party plugins have been created by contributors that are not included in this repository. For more information about these plugins, please visit their respective GitHub pages.

Plugin Description Repository
System Information This plugin adds an extra line to the prompt, serving as a hint for the AI to use shell commands likely supported by the current system. By incorporating this plugin, you can ensure that the AI model provides more accurate and system-specific shell commands, improving its overall performance and usefulness. hdkiller/Auto-GPT-SystemInfo
Notion Notion plugin for Auto-GPT. doutv/Auto-GPT-Notion
Telegram A smoothly working Telegram bot that gives you all the messages you would normally get through the Terminal. Wladastic/Auto-GPT-Telegram-Plugin
MetaTrader Connect your MetaTrader Account to Auto-GPT. isaiahbjork/Auto-GPT-MetaTrader-Plugin
Google Analytics Connect your Google Analytics Account to Auto-GPT. isaiahbjork/Auto-GPT-Google-Analytics-Plugin
YouTube Various YouTube features including downloading and understanding jpetzke/AutoGPT-YouTube
Mastodon Simple Mastodon plugin to send toots through a Mastodon account ppetermann/AutoGPTMastodonPlugin
TiDB Serverless Connect your TiDB Serverless database to Auto-GPT, enable get query results from database pingcap/Auto-GPT-TiDB-Serverless-Plugin
Instagram Instagram access jpetzke/AutoGPT-Instagram
Crypto Trade crypto with Auto-GPT isaiahbjork/Auto-GPT-Crypto-Plugin

Configuration

For interactionless use, set ALLOWLISTED_PLUGINS=example-plugin1,example-plugin2,etc in your .env file.

Making a plugin

Creating a plugin is a rewarding experience! You can choose between first-party or third-party plugins. First-party plugins are included in this repo and are installed by default along with other plugins when the plugin platform is installed. Third-party plugins need to be added individually. Use first-party plugins for plugins you expect others to use and want, and third-party for things specific to you.

First Party How-To

  1. Clone the plugins repo
  2. Follow the structure of the other plugins, implementing the plugin interface as required
  3. Write your tests
  4. Add your name to the codeowners file
  5. Add your plugin to the Readme
  6. Make a PR back to this repo!

Third Party How-To

  1. Clone the third party template
  2. Follow the instructions in the third party template readme

Migrating Third Party to First Party

Thanks for contributing a plugin to the project!

  1. Clone this repo.
  2. Make a folder for your plugin under src/autogpt_plugins. Name it a simple descriptive name such as notion, twitter, or web_ui.
  3. Take the files from your third-party plugin located at src/auto_gpt_plugin_template and add them into the folder you created
  4. Add your readme from your third-party plugin to the folder you created
  5. Add your plugin to the root readme with a description and a link to your plugin-specific readme
  6. Add your plugin's Python package requirements to requirements.txt
  7. Add tests to get your plugin to 80% code coverage
  8. Add your name to the codeowners file
  9. Add your plugin to the Readme
  10. Make a PR back to this repo!

Get Help

Visit the discord server for more information.