From f45bf53681b65e42fba36507cef52e91d891aebe Mon Sep 17 00:00:00 2001 From: Bently Date: Tue, 15 Jul 2025 18:39:12 +0100 Subject: [PATCH] feat(docs): Add info about auto setup script to docs + readme (#10347) Updates to the readme + docs to add info about the newly added auto setup script. Changes to ``new_blocks.md`` and ``installer.md`` are to make netlify CI happy and pass --------- Co-authored-by: Reinier van der Leer --- README.md | 18 ++++++++++++++++++ docs/content/platform/getting-started.md | 18 +++++++++++++++++- docs/content/platform/installer.md | 2 +- docs/content/platform/new_blocks.md | 6 +++--- 4 files changed, 39 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 63f54036b5..5044d2a212 100644 --- a/README.md +++ b/README.md @@ -49,6 +49,24 @@ We've moved to a fully maintained and regularly updated documentation site. This tutorial assumes you have Docker, VSCode, git and npm installed. +--- + +#### ⚡ Quick Setup with One-Line Script (Recommended for Local Hosting) + +Skip the manual steps and get started in minutes using our automatic setup script. + +For macOS/Linux: +``` +curl -fsSL https://setup.agpt.co/install.sh -o install.sh && bash install.sh +``` + +For Windows (PowerShell): +``` +powershell -c "iwr https://setup.agpt.co/install.bat -o install.bat; ./install.bat" +``` + +This will install dependencies, configure Docker, and launch your local instance — all in one go. + ### 🧱 AutoGPT Frontend The AutoGPT frontend is where users interact with our powerful AI automation platform. It offers multiple ways to engage with and leverage our AI agents. This is the interface where you'll bring your AI automation ideas to life: diff --git a/docs/content/platform/getting-started.md b/docs/content/platform/getting-started.md index 82ce95bfbb..7719c2ade3 100644 --- a/docs/content/platform/getting-started.md +++ b/docs/content/platform/getting-started.md @@ -79,7 +79,23 @@ Once you have Docker and Docker Compose installed, you can proceed to the next s See supabase/supabase #33816 for additional context. -## Setup +## Quick Setup with Auto Setup Script (Recommended) +If you're self-hosting AutoGPT locally, we recommend using our official setup script to simplify the process. This will install dependencies (like Docker), pull the latest code, and launch the app with minimal effort. + +For macOS/Linux: +``` +curl -fsSL https://setup.agpt.co/install.sh -o install.sh && bash install.sh +``` + +For Windows (PowerShell): +``` +powershell -c "iwr https://setup.agpt.co/install.bat -o install.bat; ./install.bat" +``` + +This method is ideal if you're setting up for development or testing and want to skip manual configuration. + + +## Manual Setup ### Cloning the Repository The first step is cloning the AutoGPT repository to your computer. diff --git a/docs/content/platform/installer.md b/docs/content/platform/installer.md index 3faf6a8239..a1bce35e83 100644 --- a/docs/content/platform/installer.md +++ b/docs/content/platform/installer.md @@ -43,7 +43,7 @@ If you prefer, you can manually download and run the installer scripts: - **Linux/macOS:** `setup-autogpt.sh` - **Windows:** `setup-autogpt.bat` -Follow the instructions in the [installer README](../../../../autogpt_platform/installer/README.md) for more details. +These scripts are located in the `autogpt_platform/installer/` directory. ## After Installation diff --git a/docs/content/platform/new_blocks.md b/docs/content/platform/new_blocks.md index f436aedb7b..29d4d0f413 100644 --- a/docs/content/platform/new_blocks.md +++ b/docs/content/platform/new_blocks.md @@ -337,10 +337,10 @@ You will need to add the provider (api or oauth) to the `CredentialsInput` compo --8<-- "autogpt_platform/frontend/src/components/integrations/credentials-input.tsx:ProviderIconsEmbed" ``` -You will also need to add the provider to the `CredentialsProvider` component in [`frontend/src/components/integrations/credentials-provider.tsx`](https://github.com/Significant-Gravitas/AutoGPT/blob/master/autogpt_platform/frontend/src/components/integrations/credentials-provider.tsx). +You will also need to add the provider to the credentials provider list in [`frontend/src/components/integrations/helper.ts`](https://github.com/Significant-Gravitas/AutoGPT/blob/master/autogpt_platform/frontend/src/components/integrations/helper.ts). -```ts title="frontend/src/components/integrations/credentials-provider.tsx" ---8<-- "autogpt_platform/frontend/src/components/integrations/credentials-provider.tsx:CredentialsProviderNames" +```ts title="frontend/src/components/integrations/helper.ts" +--8<-- "autogpt_platform/frontend/src/components/integrations/helper.ts:CredentialsProviderNames" ``` Finally you will need to add the provider to the `CredentialsType` enum in [`frontend/src/lib/autogpt-server-api/types.ts`](https://github.com/Significant-Gravitas/AutoGPT/blob/master/autogpt_platform/frontend/src/lib/autogpt-server-api/types.ts).