⚠️💀 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.

⚙️ WORK IN PROGRESS ⚙️: The plugin api is not yet stabilized. If you are coding a plugin, expect it to change in the next few versions.

⚠️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 Auto-GPT directory

   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

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

There are two kinds of plugins: first party and third party. 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. You can see all the plugins and their contributors on this directory.

If you built a plugin and it's not on the directory yet simply make a PR to this repo by adding your plugin to the data array in plugins.tsx.

You can also see the plugins here:

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.

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.

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!

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

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!

Visit the discord server for more information.