From e70a6129cf185b5a48a653fbf00e24b426b1c6bc Mon Sep 17 00:00:00 2001 From: Reinier van der Leer Date: Sat, 25 Nov 2023 18:05:59 +0100 Subject: [PATCH] docs: Add workspace information to AutoGPT user guide - Added information about the workspace folder in the AutoGPT user guide - Clarified that files outside the workspace folder are inaccessible unless RESTRICT_TO_WORKSPACE is set to False. Provided a warning against disabling RESTRICT_TO_WORKSPACE unless in a sandbox environment. --- docs/content/AutoGPT/usage.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/content/AutoGPT/usage.md b/docs/content/AutoGPT/usage.md index e1f5bd8c..4ab752dc 100644 --- a/docs/content/AutoGPT/usage.md +++ b/docs/content/AutoGPT/usage.md @@ -189,6 +189,17 @@ in various ways: its history. * Share your agent! +## Workspace +[workspace]: #workspace + +Agents can read and write files. This happens in the `workspace` folder, which +is in `data/agents//`. Files outside of this folder can not be accessed by the +agent *unless* `RESTRICT_TO_WORKSPACE` is set to `False`. + +!!! warning + We do not recommend disabling `RESTRICT_TO_WORKSPACE`, unless AutoGPT is running in + a sandbox environment where it couldn't do any damage (e.g. Docker or a VM). + ## Logs Activity, Error, and Debug logs are located in `logs`.