aljaz/Auto-GPT
1
0
Fork 0
mirror of https://github.com/aljazceru/Auto-GPT.git synced 2025-12-17 05:54:26 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
24008e87417786be62d19a014150e46ebca6d636
Auto-GPT/docs/content/AutoGPT/setup/index.md
Reinier van der Leer 24008e8741 docs: Streamline documentation for getting started (#6335) 
* README.md
  - Mark evo.ninja as hackathon winner and new Current Best Agent.
  - Remove hackathon banner.
  - Rewrite sections about Forge, Benchmark, UI, Agent Protocol.
  - Add sections about Leaderboard and CLI.
  - Add quick links for improved user navigation, including links to documentation, contributing guidelines, and quickstart guide.
  - Remove Quickstart.

* docs.agpt.co
  - Removed links to outdated pages from navbar.
  - Added quick links to several pages.
  - Refactored and updated titles in docs site navbar for better readability and consistency.
  - Rewrite intros on homepage to be more clear and professional and less cringe-worthy.
  - Fix broken links.
  - Rewrote setup and usage guides for AutoGPT Agent.
    - Removed mentions of Azure support, except in the Docker guide.
  - Added page with general information about AutoGPT.

* CONTRIBUTING.md
  - Make CONTRIBUTING.md more friendly and accessible: added link to public kanban board, encouraged collaboration, removed section about net-negative PRs.

* autogpt/README.md
  - Update description of AutoGPT to mention "modern Large Language Models" instead of GPT-4.
  - Add quick links for improved user navigation, including links to documentation and contributing guidelines.
  - Add features and setup guide: Agent Protocol, UI features, setup instructions, configuration options, Quickstart, CLI instructions, Agent Protocol server instructions, additional resources (wiki, project board, roadmap), and a note on sustainable development.
  - Update links: documentation, setup instructions.
  - Remove outdated Twitter accounts section.
2023-11-23 14:59:17 +01:00

4.1 KiB
Raw Blame History

AutoGPT Agent setup

🐋 Set up & Run with Docker  |  👷🏼 For Developers

📋 Requirements

Linux / macOS

Windows (WSL)

Windows

!!! attention We recommend setting up AutoGPT with WSL. Some things don't work exactly the same on Windows and we currently can't provide specialized instructions for all those cases.

🗝️ Getting an OpenAI API key

Get your OpenAI API key from: https://platform.openai.com/account/api-keys.

!!! attention To use the OpenAI API with AutoGPT, we strongly recommend setting up billing (AKA paid account). Free accounts are limited to 3 API calls per minute, which can cause the application to crash.

You can set up a paid account at [Manage account > Billing > Overview](https://platform.openai.com/account/billing/overview).

!!! important It's highly recommended that you keep track of your API costs on the Usage page. You can also set limits on how much you spend on the Usage limits page.

For OpenAI API key to work, set up paid account at OpenAI API > Billing

Setting up AutoGPT

Getting AutoGPT

Since we don't ship AutoGPT as a desktop application, you'll need to download the project from GitHub and give it a place on your computer.

Screenshot of the dialog to clone or download the repo

  • To get the latest bleeding edge version, use master.
  • If you're looking for more stability, check out the latest AutoGPT release.

!!! note These instructions don't apply if you're looking to run AutoGPT as a docker image. Instead, check out the Docker setup guide.

Completing the Setup

Once you have cloned or downloaded the project, you can find the AutoGPT Agent in the autogpts/autogpt/ folder. In this folder:

  1. Find the file named .env.template in the main Auto-GPT folder. This file may be hidden by default in some operating systems due to the dot prefix. To reveal hidden files, follow the instructions for your specific operating system: Windows and macOS.

  2. Create a copy of .env.template and call it .env; if you're already in a command prompt/terminal window:

    cp .env.template .env

  3. Open the .env file in a text editor.

  4. Find the line that says OPENAI_API_KEY=.

  5. Insert your OpenAI API Key directly after = without quotes or spaces..

    OPENAI_API_KEY=sk-qwertykeys123456

  6. Enter any other API keys or tokens for services you would like to use.

    !!! note To activate and adjust a setting, remove the # prefix.

  7. Save and close the .env file.

  8. Optional: run poetry install to install all required dependencies. The application also checks for and installs any required dependencies when it starts.

You should now be able to explore the CLI (./run.sh --help) and run the application.

See the user guide for further instructions.