⚠️ 💀 WARNING 💀⚠️ : Always examine the code of any plugin you use thoroughly, as plugins can execute any Python code, leading to potential malicious activities such as stealing your API keys.
⚙️ WORK IN PROGRESS ⚙️: The plugin API is still being refined. If you are developing a plugin, expect changes in the upcoming versions.
Here are the steps to configure Auto-GPT Plugins:
Install Auto-GPT
If you haven't done so, follow the installation instructions given by Auto-GPT to install it.
Download the plugins folder from the
rootofAuto-GPTdirectoryTo 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
Or in PowerShell:
Invoke-WebRequest-Uri "https://github.com/Significant-Gravitas/Auto-GPT-Plugins/archive/refs/heads/master.zip"-OutFile "./plugins/Auto-GPT-Plugins.zip"
Execute the dependency install script for plugins
This can be run via:
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
For interactionless use, set
ALLOWLISTED_PLUGINS=example-plugin1,example-plugin2,example-plugin3in your.env
There are two categories of plugins: first party and third party. First-party plugins are included in this repo and are installed by default when the plugin platform is installed. Third-party plugins need to be added individually. Use first-party plugins for widely-used plugins, and third-party for your specific needs. You can view all the plugins and their contributors on this directory.
If you've built a plugin and it's not listed in the directory, you can make a PR to this repo by adding your plugin to the data array in plugins.tsx.
You can also see the plugins here:
| Plugin | Description | Location |
|---|---|---|
| Astro Info | This gives Auto-GPT info about astronauts. | autogpt_plugins/astro |
| API Tools | This allows Auto-GPT to make API calls of various kinds. | autogpt_plugins/api_tools |
| Baidu Search | This search plugin integrates Baidu search engines into Auto-GPT. | autogpt_plugins/baidu_search |
| Bing Search | This search plugin integrates Bing search engines into Auto-GPT. | autogpt_plugins/bing_search |
| Bluesky | Enables Auto-GPT to retrieve posts from Bluesky and create new posts. | autogpt_plugins/bluesky |
| Revolutionize email management with the Auto-GPT Email Plugin, leveraging AI to automate drafting and intelligent replies. | autogpt_plugins/email | |
| News Search | This search plugin integrates News Articles searches, using the NewsAPI aggregator into Auto-GPT. | autogpt_plugins/news_search |
| Planner | Simple Task Planner Module for Auto-GPT | autogpt_plugins/planner |
| Random Values | Enable Auto-GPT to generate various random numbers and strings. | autogpt_plugins/random_values |
| SceneX | Explore image storytelling beyond pixels with the Auto-GPT SceneX Plugin. | autogpt_plugins/scenex |
| Telegram | A smoothly working Telegram bot that gives you all the messages you would normally get through the Terminal. | autogpt_plugins/telegram |
| Auto-GPT 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 | |
| Wikipedia Search | This allows Auto-GPT to use Wikipedia directly. | autogpt_plugins/wikipedia_search |
| WolframAlpha Search | This allows AutoGPT to use WolframAlpha directly. | autogpt_plugins/wolframalpha_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 |
|---|---|---|
| Alpaca-Trading | Trade stocks and crypto, paper or live with Auto-GPT | danikhan632/Auto-GPT-AlpacaTrader-Plugin |
| AutoGPT User Input Request | Allow Auto-GPT to specifically request user input in continous mode | HFrovinJensen/Auto-GPT-User-Input-Plugin |
| BingAI | Enable Auto-GPT to fetch information via BingAI, saving time, API requests while maintaining accuracy. This does not remove the need for OpenAI API keys | gravelBridge/AutoGPT-BingAI |
| Crypto | Trade crypto with Auto-GPT | isaiahbjork/Auto-GPT-Crypto-Plugin |
| Discord | Interact with your Auto-GPT instance through Discord | gravelBridge/AutoGPT-Discord |
| Dolly AutoGPT Cloner | A way to compose & run multiple Auto-GPT processes that cooperate, till core has multi-agent support | pr-0f3t/Auto-GPT-Dolly-Plugin |
| Google Analytics | Connect your Google Analytics Account to Auto-GPT. | isaiahbjork/Auto-GPT-Google-Analytics-Plugin |
| IFTTT webhooks | This plugin allows you to easily integrate IFTTT connectivity using Maker | AntonioCiolino/AutoGPT-IFTTT |
| iMessage | Send and Get iMessages using Auto-GPT | danikhan632/Auto-GPT-Messages-Plugin |
| Instagram access | jpetzke/AutoGPT-Instagram | |
| Mastodon | Simple Mastodon plugin to send toots through a Mastodon account | ppetermann/AutoGPTMastodonPlugin |
| MetaTrader | Connect your MetaTrader Account to Auto-GPT. | isaiahbjork/Auto-GPT-MetaTrader-Plugin |
| Notion | Notion plugin for Auto-GPT. | doutv/Auto-GPT-Notion |
| Slack | This plugin allows to receive commands and send messages to slack channels | adithya77/Auto-GPT-slack-plugin |
| Spoonacular | Find recipe insiprations using Auto-GPT | minfenglu/Auto-GPT-Spoonacular-Plugin |
| 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 |
| TiDB Serverless | Connect your TiDB Serverless database to Auto-GPT, enable get query results from database | pingcap/Auto-GPT-TiDB-Serverless-Plugin |
| Todoist-Plugin | Allow Auto-GPT to programatically interact with yor Todoist to create, update, and manage your Todoist | danikhan632/Auto-GPT-Todoist-Plugin |
| Weather | A simple weather plugin wrapping around python-weather | ppetermann/Auto-GPT-WeatherPlugin |
| Web-Interaction | Enable Auto-GPT to fully interact with websites! Allows Auto-GPT to click elements, input text, and scroll | gravelBridge/AutoGPT-Web-Interaction |
| WolframAlpha | Access to WolframAlpha to do math and get accurate information | gravelBridge/AutoGPT-WolframAlpha |
| YouTube | Various YouTube features including downloading and understanding | jpetzke/AutoGPT-YouTube |
| Zapier webhooks | This plugin allows you to easily integrate Zapier connectivity | AntonioCiolino/AutoGPT-Zapier |
| Project Management | Streamline your Project Management with ease: Jira, Trello, and Google Calendar Made Effortless | minfenglu/AutoGPT-PM-Plugin |
For interactionless use, set:
ALLOWLISTED_PLUGINS=example-plugin1,example-plugin2,etc in your .env file to allow plugins to load without prompting. DENYLISTED_PLUGINS=example-plugin1,example-plugin2,etc in your .env file to block plugins from loading without prompting.
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.
- Clone the plugins repo
- Follow the structure of the other plugins, implementing the plugin interface as required
- Write your tests
- Add your name to the codeowners file
- Add your plugin to the Readme
- Add your plugin to the autogpt-package. You can copy the line of any of the standard plugins and just add another entry in the dictionary. Raise a PR & get it merged
- Add your plugin to the plugin installation integration test
- Make a PR back to this repo!
- Clone the third party template.
- Follow the instructions in the third party template readme.
We appreciate your contribution of a plugin to the project!
- Clone this repository.
- Make a folder for your plugin under
src/autogpt_plugins. Use a simple descriptive name such asnotion,twitter, orweb_ui. - Add the files from your third-party plugin located at
src/auto_gpt_plugin_templateinto the folder you created. - Include your README from your third-party plugin in the folder you created.
- Add your plugin to the root README with a description and a link to your plugin-specific README.
- Add your plugin's Python package requirements to
requirements.txt. - Add tests to get your plugin to 80% code coverage.
- Add your name to the codeowners file.
- Add your plugin to the Readme.
- Submit a pull request back to this repository!
For more information, visit the discord server.