Release v0.4.1 (#4686)

Co-authored-by: Reinier van der Leer <github@pwuts.nl>
Co-authored-by: Nicholas Tindle <nick@ntindle.com>
Co-authored-by: Nicholas Tindle <nicktindle@outlook.com>
Co-authored-by: k-boikov <64261260+k-boikov@users.noreply.github.com>
Co-authored-by: merwanehamadi <merwanehamadi@gmail.com>
Co-authored-by: Merwane Hamadi <merwanehamadi@gmail.com>
Co-authored-by: Richard Beales <rich@richbeales.net>
Co-authored-by: Luke K <2609441+lc0rp@users.noreply.github.com>
Co-authored-by: Luke K (pr-0f3t) <2609441+lc0rp@users.noreply.github.com>
Co-authored-by: Erik Peterson <e@eriklp.com>
Co-authored-by: Auto-GPT-Bot <github-bot@agpt.co>
Co-authored-by: Benny van der Lans <49377421+bfalans@users.noreply.github.com>
Co-authored-by: Jan <jan-github@phobia.de>
Co-authored-by: Robin Richtsfeld <robin.richtsfeld@gmail.com>
Co-authored-by: Marc Bornträger <marc.borntraeger@gmail.com>
Co-authored-by: Stefan Ayala <stefanayala3266@gmail.com>
Co-authored-by: javableu <45064273+javableu@users.noreply.github.com>
Co-authored-by: DGdev91 <DGdev91@users.noreply.github.com>
Co-authored-by: Kinance <kinance@gmail.com>
Co-authored-by: digger yu <digger-yu@outlook.com>
Co-authored-by: David <scenaristeur@gmail.com>
Co-authored-by: gravelBridge <john.tian31@gmail.com>
Fix Python CI "update cassettes" step (#4591)
fix CI (#4596)
Fix inverted logic for deny_command (#4563)
fix current_score.json generation (#4601)
Fix duckduckgo rate limiting (#4592)
Fix debug code challenge (#4632)
Fix issues with information retrieval challenge a (#4622)
fix issues with env configuration and .env.template (#4630)
Fix prompt issue causing 'No Command' issues and challenge to fail (#4623)
Fix benchmark logs (#4653)
Fix typo in docs/setup.md (#4613)
Fix run.sh shebang (#4561)
Fix autogpt docker image not working because missing prompt_settings (#4680)
Fix execute_command coming from plugins (#4730)

.dockerignore

@@ -2,6 +2,7 @@
 *.template
 *.yaml
 *.yml
+!prompt_settings.yaml
 
 *.md
 *.png

.env.template

@@ -1,10 +1,16 @@
+# For further descriptions of these settings see docs/configuration/options.md or go to docs.agpt.co
+
 ################################################################################
 ### AUTO-GPT - GENERAL SETTINGS
 ################################################################################
 
+## OPENAI_API_KEY - OpenAI API Key (Example: my-openai-api-key)
+OPENAI_API_KEY=your-openai-api-key
+
 ## EXECUTE_LOCAL_COMMANDS - Allow local command execution (Default: False)
-## RESTRICT_TO_WORKSPACE - Restrict file operations to workspace ./auto_gpt_workspace (Default: True)
 # EXECUTE_LOCAL_COMMANDS=False
+
+## RESTRICT_TO_WORKSPACE - Restrict file operations to workspace ./auto_gpt_workspace (Default: True)
 # RESTRICT_TO_WORKSPACE=True
 
 ## USER_AGENT - Define the user-agent used by the requests library to browse website (string)
@@ -13,211 +19,186 @@
 ## AI_SETTINGS_FILE - Specifies which AI Settings file to use (defaults to ai_settings.yaml)
 # AI_SETTINGS_FILE=ai_settings.yaml
 
+## PLUGINS_CONFIG_FILE - The path to the plugins_config.yaml file (Default plugins_config.yaml)
+# PLUGINS_CONFIG_FILE=plugins_config.yaml
+
 ## PROMPT_SETTINGS_FILE - Specifies which Prompt Settings file to use (defaults to prompt_settings.yaml)
 # PROMPT_SETTINGS_FILE=prompt_settings.yaml
 
+## OPENAI_API_BASE_URL - Custom url for the OpenAI API, useful for connecting to custom backends. No effect if USE_AZURE is true, leave blank to keep the default url 
+# the following is an example:
+# OPENAI_API_BASE_URL=http://localhost:443/v1
+
 ## AUTHORISE COMMAND KEY - Key to authorise commands
 # AUTHORISE_COMMAND_KEY=y
+
 ## EXIT_KEY - Key to exit AUTO-GPT
 # EXIT_KEY=n
 
-## PLAIN_OUTPUT - Enabeling plain output will disable spinner (Default: False)
-## Note: Spinner is used to indicate that Auto-GPT is working on something in the background
+## PLAIN_OUTPUT - Plain output, which disables the spinner (Default: False)
 # PLAIN_OUTPUT=False
 
-## DISABLED_COMMAND_CATEGORIES - The list of categories of commands that are disabled. Each of the below are an option:
-## autogpt.commands.analyze_code
-## autogpt.commands.audio_text
-## autogpt.commands.execute_code
-## autogpt.commands.file_operations
-## autogpt.commands.git_operations
-## autogpt.commands.google_search
-## autogpt.commands.image_gen
-## autogpt.commands.improve_code
-## autogpt.commands.web_selenium
-## autogpt.commands.write_tests
-## autogpt.app
-## autogpt.commands.task_statuses
-## For example, to disable coding related features, uncomment the next line
-# DISABLED_COMMAND_CATEGORIES=autogpt.commands.analyze_code,autogpt.commands.execute_code,autogpt.commands.git_operations,autogpt.commands.improve_code,autogpt.commands.write_tests
-
-## DENY_COMMANDS - The list of commands that are not allowed to be executed by Auto-GPT (Default: None)
-# the following are examples:
-# DENY_COMMANDS=cd,nano,vim,vi,emacs,rm,sudo,top,ping,ssh,scp
-
-## ALLOW_COMMANDS - ONLY those commands will be allowed to be executed by Auto-GPT
-# the following are examples:
-# ALLOW_COMMANDS=ls,git,cat,grep,find,echo,ps,curl,wget
-
+## DISABLED_COMMAND_CATEGORIES - The list of categories of commands that are disabled (Default: None)
+# DISABLED_COMMAND_CATEGORIES=
 
 ################################################################################
 ### LLM PROVIDER
 ################################################################################
 
-### OPENAI
-## OPENAI_API_KEY - OpenAI API Key (Example: my-openai-api-key)
-
-
-## NOTE: https://platform.openai.com/docs/api-reference/completions
-# The temperature setting in language models like GPT controls the balance between predictable and random responses. 
-# Lower temperature makes the responses more focused and deterministic, while higher temperature makes them more 
-# creative and varied. The temperature range typically goes from 0 to 2 in OpenAI's implementation.
-##
 ## TEMPERATURE - Sets temperature in OpenAI (Default: 0)
-##
-###
+# TEMPERATURE=0
+
+## OPENAI_ORGANIZATION - Your OpenAI Organization key (Default: None)
+# OPENAI_ORGANIZATION=
 
 ## USE_AZURE - Use Azure OpenAI or not (Default: False)
-OPENAI_API_KEY=your-openai-api-key
-# TEMPERATURE=0
 # USE_AZURE=False
-# OPENAI_ORGANIZATION=your-openai-organization-key-if-applicable
-
-### AZURE
-# moved to `azure.yaml.template`
 
 ################################################################################
 ### LLM MODELS
 ################################################################################
 
-## SMART_LLM_MODEL - Smart language model (Default: gpt-4)
+## SMART_LLM_MODEL - Smart language model (Default: gpt-3.5-turbo)
+# SMART_LLM_MODEL=gpt-3.5-turbo
+
 ## FAST_LLM_MODEL - Fast language model (Default: gpt-3.5-turbo)
-# SMART_LLM_MODEL=gpt-4
 # FAST_LLM_MODEL=gpt-3.5-turbo
 
-### LLM MODEL SETTINGS
-## FAST_TOKEN_LIMIT - Fast token limit for OpenAI (Default: 4000)
-## SMART_TOKEN_LIMIT - Smart token limit for OpenAI (Default: 8000)
-## When using --gpt3only this needs to be set to 4000.
-# FAST_TOKEN_LIMIT=4000
-# SMART_TOKEN_LIMIT=8000
-
-### EMBEDDINGS
-## EMBEDDING_MODEL       - Model to use for creating embeddings
+## EMBEDDING_MODEL - Model to use for creating embeddings
 # EMBEDDING_MODEL=text-embedding-ada-002
 
+################################################################################
+### SHELL EXECUTION
+################################################################################
+
+## SHELL_COMMAND_CONTROL - Whether to use "allowlist" or "denylist" to determine what shell commands can be executed (Default: denylist)
+# SHELL_COMMAND_CONTROL=denylist
+
+## ONLY if SHELL_COMMAND_CONTROL is set to denylist:
+## SHELL_DENYLIST - List of shell commands that ARE NOT allowed to be executed by Auto-GPT (Default: sudo,su)
+# SHELL_DENYLIST=sudo,su
+
+## ONLY if SHELL_COMMAND_CONTROL is set to allowlist:
+## SHELL_ALLOWLIST - List of shell commands that ARE allowed to be executed by Auto-GPT (Default: None)
+# SHELL_ALLOWLIST=
+
 ################################################################################
 ### MEMORY
 ################################################################################
 
-### MEMORY_BACKEND - Memory backend type
-## json_file - Default
-## redis - Redis (if configured)
-## MEMORY_INDEX - Name of index created in Memory backend (Default: auto-gpt)
+### General
+
+## MEMORY_BACKEND - Memory backend type
 # MEMORY_BACKEND=json_file
-# MEMORY_INDEX=auto-gpt-memory
 
-### REDIS
+## MEMORY_INDEX - Value used in the Memory backend for scoping, naming, or indexing (Default: auto-gpt)
+# MEMORY_INDEX=auto-gpt
+
+### Redis
+
 ## REDIS_HOST - Redis host (Default: localhost, use "redis" for docker-compose)
-## REDIS_PORT - Redis port (Default: 6379)
-## REDIS_PASSWORD - Redis password (Default: "")
-## WIPE_REDIS_ON_START - Wipes data / index on start (Default: True)
 # REDIS_HOST=localhost
+
+## REDIS_PORT - Redis port (Default: 6379)
 # REDIS_PORT=6379
+
+## REDIS_PASSWORD - Redis password (Default: "")
 # REDIS_PASSWORD=
+
+## WIPE_REDIS_ON_START - Wipes data / index on start (Default: True)
 # WIPE_REDIS_ON_START=True
 
 ################################################################################
 ### IMAGE GENERATION PROVIDER
 ################################################################################
 
-### COMMON SETTINGS
-## IMAGE_PROVIDER - Image provider - dalle, huggingface, or sdwebui
-## IMAGE_SIZE - Image size (Example: 256)
-## Image sizes for dalle: 256, 512, 1024
+### Common
+
+## IMAGE_PROVIDER - Image provider (Default: dalle)
 # IMAGE_PROVIDER=dalle
+
+## IMAGE_SIZE - Image size (Default: 256)
 # IMAGE_SIZE=256
 
-### HUGGINGFACE
+### Huggingface (IMAGE_PROVIDER=huggingface)
+
 ## HUGGINGFACE_IMAGE_MODEL - Text-to-image model from Huggingface (Default: CompVis/stable-diffusion-v1-4)
-## HUGGINGFACE_API_TOKEN - HuggingFace API token (Example: my-huggingface-api-token)
 # HUGGINGFACE_IMAGE_MODEL=CompVis/stable-diffusion-v1-4
-# HUGGINGFACE_API_TOKEN=your-huggingface-api-token
 
-### STABLE DIFFUSION WEBUI
-## SD_WEBUI_AUTH - Stable diffusion webui username:password pair (Example: username:password)
-## SD_WEBUI_URL - Stable diffusion webui API URL (Example: http://127.0.0.1:7860)
+## HUGGINGFACE_API_TOKEN - HuggingFace API token (Default: None)
+# HUGGINGFACE_API_TOKEN=
+
+### Stable Diffusion (IMAGE_PROVIDER=sdwebui)
+
+## SD_WEBUI_AUTH - Stable Diffusion Web UI username:password pair (Default: None)
 # SD_WEBUI_AUTH=
-# SD_WEBUI_URL=http://127.0.0.1:7860
+
+## SD_WEBUI_URL - Stable Diffusion Web UI API URL (Default: http://localhost:7860)
+# SD_WEBUI_URL=http://localhost:7860
 
 ################################################################################
 ### AUDIO TO TEXT PROVIDER
 ################################################################################
 
-### HUGGINGFACE
-# HUGGINGFACE_AUDIO_TO_TEXT_MODEL=facebook/wav2vec2-base-960h
+## AUDIO_TO_TEXT_PROVIDER - Audio-to-text provider (Default: huggingface)
+# AUDIO_TO_TEXT_PROVIDER=huggingface
+
+## HUGGINGFACE_AUDIO_TO_TEXT_MODEL - The model for HuggingFace to use (Default: CompVis/stable-diffusion-v1-4)
+# HUGGINGFACE_AUDIO_TO_TEXT_MODEL=CompVis/stable-diffusion-v1-4
 
 ################################################################################
-### GIT Provider for repository actions
+### GITHUB
 ################################################################################
 
-### GITHUB
-## GITHUB_API_KEY - Github API key / PAT (Example: github_pat_123)
-## GITHUB_USERNAME - Github username
-# GITHUB_API_KEY=github_pat_123
-# GITHUB_USERNAME=your-github-username
+## GITHUB_API_KEY - Github API key / PAT (Default: None)
+# GITHUB_API_KEY=
+
+## GITHUB_USERNAME - Github username (Default: None)
+# GITHUB_USERNAME=
 
 ################################################################################
 ### WEB BROWSING
 ################################################################################
 
-### BROWSER
 ## HEADLESS_BROWSER - Whether to run the browser in headless mode (default: True)
-## USE_WEB_BROWSER - Sets the web-browser driver to use with selenium (default: chrome).
-##   Note: set this to either 'chrome', 'firefox', 'safari' or 'edge' depending on your current browser
 # HEADLESS_BROWSER=True
+
+## USE_WEB_BROWSER - Sets the web-browser driver to use with selenium (default: chrome)
 # USE_WEB_BROWSER=chrome
-## BROWSE_CHUNK_MAX_LENGTH - When browsing website, define the length of chunks to summarize (in number of tokens, excluding the response. 75 % of FAST_TOKEN_LIMIT is usually wise )
+
+## BROWSE_CHUNK_MAX_LENGTH - When browsing website, define the length of chunks to summarize (Default: 3000)
 # BROWSE_CHUNK_MAX_LENGTH=3000
-## BROWSE_SPACY_LANGUAGE_MODEL is used to split sentences. Install additional languages via pip, and set the model name here. Example Chinese:  python -m spacy download zh_core_web_sm
+
+## BROWSE_SPACY_LANGUAGE_MODEL - spaCy language model](https://spacy.io/usage/models) to use when creating chunks. (Default: en_core_web_sm)
 # BROWSE_SPACY_LANGUAGE_MODEL=en_core_web_sm
 
-### GOOGLE
-## GOOGLE_API_KEY - Google API key (Example: my-google-api-key)
-## CUSTOM_SEARCH_ENGINE_ID - Custom search engine ID (Example: my-custom-search-engine-id)
-# GOOGLE_API_KEY=your-google-api-key
-# CUSTOM_SEARCH_ENGINE_ID=your-custom-search-engine-id
+## GOOGLE_API_KEY - Google API key (Default: None)
+# GOOGLE_API_KEY=
+
+## GOOGLE_CUSTOM_SEARCH_ENGINE_ID - Google custom search engine ID (Default: None)
+# GOOGLE_CUSTOM_SEARCH_ENGINE_ID=
 
 ################################################################################
-### TTS PROVIDER
+### TEXT TO SPEECH PROVIDER
 ################################################################################
 
-### MAC OS
-## USE_MAC_OS_TTS - Use Mac OS TTS or not (Default: False)
-# USE_MAC_OS_TTS=False
-
-### STREAMELEMENTS
-## USE_BRIAN_TTS - Use Brian TTS or not (Default: False)
-# USE_BRIAN_TTS=False
+## TEXT_TO_SPEECH_PROVIDER - Which Text to Speech provider to use (Default: gtts)
+# TEXT_TO_SPEECH_PROVIDER=gtts
 
-### ELEVENLABS
-## ELEVENLABS_API_KEY - Eleven Labs API key (Example: my-elevenlabs-api-key)
-## ELEVENLABS_VOICE_1_ID - Eleven Labs voice 1 ID (Example: my-voice-id-1)
-## ELEVENLABS_VOICE_2_ID - Eleven Labs voice 2 ID (Example: my-voice-id-2)
-# ELEVENLABS_API_KEY=your-elevenlabs-api-key
-# ELEVENLABS_VOICE_1_ID=your-voice-id-1
-# ELEVENLABS_VOICE_2_ID=your-voice-id-2
+### Only if TEXT_TO_SPEECH_PROVIDER=streamelements
+## STREAMELEMENTS_VOICE - Voice to use for StreamElements (Default: Brian)
+# STREAMELEMENTS_VOICE=Brian
 
-################################################################################
-### TWITTER API
-################################################################################
+### Only if TEXT_TO_SPEECH_PROVIDER=elevenlabs
+## ELEVENLABS_API_KEY - Eleven Labs API key (Default: None)
+# ELEVENLABS_API_KEY=
 
-# TW_CONSUMER_KEY=
-# TW_CONSUMER_SECRET=
-# TW_ACCESS_TOKEN=
-# TW_ACCESS_TOKEN_SECRET=
+## ELEVENLABS_VOICE_ID - Eleven Labs voice ID (Example: None)
+# ELEVENLABS_VOICE_ID=
 
 ################################################################################
-### ALLOWLISTED PLUGINS
+### CHAT MESSAGES
 ################################################################################
 
-#ALLOWLISTED_PLUGINS - Sets the listed plugins that are allowed (Example: plugin1,plugin2,plugin3)
-#DENYLISTED_PLUGINS - Sets the listed plugins that are not allowed (Example: plugin1,plugin2,plugin3)
-ALLOWLISTED_PLUGINS=
-DENYLISTED_PLUGINS=
-
-################################################################################
-### CHAT PLUGIN SETTINGS
-################################################################################
-# CHAT_MESSAGES_ENABLED - Enable chat messages (Default: False)
+## CHAT_MESSAGES_ENABLED - Enable chat messages (Default: False)
 # CHAT_MESSAGES_ENABLED=False

.github/PULL_REQUEST_TEMPLATE.md

@@ -41,7 +41,7 @@ By following these guidelines, your PRs are more likely to be merged quickly aft
     black .
     isort .
     mypy
-    autoflake --remove-all-unused-imports --recursive --ignore-init-module-imports autogpt tests --in-place
+    autoflake --remove-all-unused-imports --recursive --ignore-init-module-imports --ignore-pass-after-docstring autogpt tests --in-place
     ```
 
 <!-- If you haven't added tests, please explain why. If you have, check the appropriate box. If you've ensured your PR is atomic and well-documented, check the corresponding boxes. -->