mirror of
https://github.com/aljazceru/Auto-GPT.git
synced 2025-12-18 06:24:20 +01:00
bcdc8d46f5
* Adding More Info To The Docs * Start of main page rebuild and adding new folders * Starting to move the AutoGPT(agent) Docs to a subfolder and start setup forge's subfolder * small fixes in links * fix file name * added the benchmakrs page * added front-end page * re-aranging the layout * moved the config section to be under the AutoGPT folder * fix image link * moved "Share Logs" and "Testing" to be under the AutoGPT folder * index.md: fix broken links on home page * Index.md: Testing Something with the links * index.md: Added the Benchmarks section * small fix for Frontend * Added a chat ai to the docs for testing as part of #5694 * index.md: sepetating the sections and making it easier to read * index.md: Added discord Link * index.md: Added better info to each section from @Yash-Ambekar * index.md: trying to fix the layout * Index.md: updating layout * Move Docker Setup To Its Own File * small fix * seperating the installation setups to there own page for making things clear * small fix in links * fix links again * change nav titles color to help make things clear * fix css * mv custom.css * fix for css not working * rm custom css as it didnt work * fix img * update image url * update nav * index.md: improving layout and wordings * index.md: testing line breaks * index.md: Fixed the line breaks * setup/docker-setp.md: small fix * Docker-setup.md update link to correct memory page * docker-setup.md: added note about docker install being broken * Docker-Setup.md: Updating the warning * Docker-Setup.md : Test * docker-setup.md: fix * docker-setup.md: fix * docker-setup.md final update to the warning * Docker-Setup.md * Updates to mkdocs.yml and docker-setup based on the feedback * fix to docker-setup.md * docker-setup.md fix * introduction.md: fix * Update docs/content/AutoGPT/Setups/Docker-setup.md Co-authored-by: Andy Hooker <58448663+andrewhooker2@users.noreply.github.com> * docker-setup.md update link * Update docs/content/AutoGPT/Setups/Git-setup.md Co-authored-by: Andy Hooker <58448663+andrewhooker2@users.noreply.github.com> * Update docs/content/AutoGPT/Setups/Git-setup.md Co-authored-by: Andy Hooker <58448663+andrewhooker2@users.noreply.github.com> * nogit-setup.md: updated links * Update docs/content/AutoGPT/Setups/Git-setup.md Co-authored-by: Andy Hooker <58448663+andrewhooker2@users.noreply.github.com> * Update docs/content/index.md Co-authored-by: Andy Hooker <58448663+andrewhooker2@users.noreply.github.com> * Update docs/content/index.md Co-authored-by: Andy Hooker <58448663+andrewhooker2@users.noreply.github.com> * Update docs/content/index.md Co-authored-by: Andy Hooker <58448663+andrewhooker2@users.noreply.github.com> * Update docs/content/index.md Co-authored-by: Andy Hooker <58448663+andrewhooker2@users.noreply.github.com> * setup.md: added extra info about the docker insall * setup.md small changs to clean things up * removed emojis from forge get-started.md * get-started.md - small changes * Update AutoGPT intro in index.md --------- Co-authored-by: sohamtembhurne <sohamatembhurne@outlook.com> Co-authored-by: Yash-Ambekar <yashambekar03@gmail.com> Co-authored-by: Nicholas Tindle <nicholas.tindle@agpt.co> Co-authored-by: Andy Hooker <58448663+andrewhooker2@users.noreply.github.com> Co-authored-by: Reinier van der Leer <pwuts@agpt.co>
49 lines
2.1 KiB
Markdown
49 lines
2.1 KiB
Markdown
# Setting up AutoGPT
|
|
|
|
## 📋 Requirements
|
|
|
|
Choose an environment to run AutoGPT in (pick one):
|
|
|
|
- [Docker](https://docs.docker.com/get-docker/) (*recommended*)
|
|
- Python 3.10 or later (instructions: [for Windows](https://www.tutorialspoint.com/how-to-install-python-in-windows))
|
|
- [VSCode + devcontainer](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
|
|
|
|
|
|
## 🗝️ Getting an API key
|
|
|
|
Get your OpenAI API key from: [https://platform.openai.com/account/api-keys](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][openai/api limits] 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).
|
|
|
|
[openai/api limits]: https://platform.openai.com/docs/guides/rate-limits/overview#:~:text=Free%20trial%20users,RPM%0A40%2C000%20TPM
|
|
|
|
!!! important
|
|
It's highly recommended that you keep track of your API costs on [the Usage page](https://platform.openai.com/account/usage).
|
|
You can also set limits on how much you spend on [the Usage limits page](https://platform.openai.com/account/billing/limits).
|
|
|
|
|
|
|
|
|
|
## Setting up AutoGPT
|
|
|
|
### If you plan to use Docker please follow this setup.
|
|
|
|
!!! important "Docker Setup Issue"
|
|
We are addressing a known issue with the Docker setup related to Poetry.
|
|
|
|
[**We have an open PR if you'd like to take a look**](https://github.com/python-poetry/poetry/issues/8548)
|
|
|
|
Please keep this in mind. We apologize for any inconvenience, and thank you for your patience.
|
|
|
|
[Docker Install Here.](Setups/Docker-setup.md)
|
|
|
|
### If you plan to use Git please follow this setup.
|
|
[Git Setup Here.](Setups/Git-setup.md)
|
|
|
|
### If you dont want to use git or docker for the setup follow here.
|
|
[No Git Or Docker Setup Here.](Setups/nogit-setup.md) |