dia-gov commited on
Commit
cd6f98e
·
verified ·
1 Parent(s): 5b8b14e

Upload 569 files

Browse files
This view is limited to 50 files because it contains too many changes.   See raw diff
Files changed (50) hide show
  1. .editorconfig +9 -0
  2. .env.example +51 -0
  3. .gitattributes +5 -0
  4. .github/CODE_OF_CONDUCT.md +128 -0
  5. .github/CONTRIBUTING.md +64 -0
  6. .github/FUNDING.yml +1 -0
  7. .github/ISSUE_TEMPLATE/bug-report.yaml +91 -0
  8. .github/ISSUE_TEMPLATE/config.yml +7 -0
  9. .github/ISSUE_TEMPLATE/docs.yml +46 -0
  10. .github/ISSUE_TEMPLATE/feature-request.yaml +63 -0
  11. .github/PULL_REQUEST_TEMPLATE/pull_request_template.md +59 -0
  12. .github/SECURITY.md +9 -0
  13. .github/SUPPORT.md +9 -0
  14. .github/dependabot.yml +19 -0
  15. .github/workflows/node.js.yml +32 -0
  16. .github/workflows/python.yml +80 -0
  17. .github/workflows/sponsors.yml +29 -0
  18. .github/workflows/webhooks.yml +22 -0
  19. .gitignore +55 -0
  20. LICENSE +674 -0
  21. cli/.gitignore +24 -0
  22. cli/README.md +27 -0
  23. cli/package-lock.json +0 -0
  24. cli/package.json +32 -0
  25. cli/src/envGenerator.js +142 -0
  26. cli/src/helpers.js +26 -0
  27. cli/src/index.js +60 -0
  28. cli/src/questions/existingEnvQuestions.js +5 -0
  29. cli/src/questions/newEnvQuestions.js +87 -0
  30. cli/src/questions/sharedQuestions.js +10 -0
  31. cli/tsconfig.json +115 -0
  32. db/Dockerfile +3 -0
  33. db/setup.sql +11 -0
  34. docker-compose.yml +58 -0
  35. docs/README.hu-Cs4K1Sr4C.md +235 -0
  36. docs/README.md +0 -0
  37. docs/README.zh-HANS.md +127 -0
  38. docs/development/auth.mdx +63 -0
  39. docs/development/memory.mdx +35 -0
  40. docs/development/prompts.mdx +34 -0
  41. docs/development/setup.mdx +87 -0
  42. docs/development/translations.mdx +90 -0
  43. docs/development/workflow-input.mdx +28 -0
  44. docs/development/workflows.mdx +43 -0
  45. docs/essentials/FAQ.mdx +94 -0
  46. docs/essentials/contributing.mdx +47 -0
  47. docs/essentials/roadmap.mdx +65 -0
  48. docs/essentials/usecases.mdx +58 -0
  49. docs/favicon.png +0 -0
  50. docs/images/background.png +0 -0
.editorconfig ADDED
@@ -0,0 +1,9 @@
 
 
 
 
 
 
 
 
 
 
1
+ root = true
2
+
3
+ [*]
4
+ indent_style = space
5
+ indent_size = 2
6
+ end_of_line = lf
7
+ charset = utf-8
8
+ trim_trailing_whitespace = true
9
+ insert_final_newline = true
.env.example ADDED
@@ -0,0 +1,51 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Platform Config: (max loops determines how many times the agent may execute)
2
+ NEXT_PUBLIC_MAX_LOOPS="100"
3
+ REWORKD_PLATFORM_MAX_LOOPS=${NEXT_PUBLIC_MAX_LOOPS}
4
+
5
+ # Deployment Environment:
6
+ NODE_ENV="development"
7
+ NEXT_PUBLIC_VERCEL_ENV="${NODE_ENV}"
8
+
9
+ # NextJS:
10
+ NEXT_PUBLIC_BACKEND_URL="http://localhost:8000"
11
+
12
+ # Next Auth config:
13
+ NEXTAUTH_SECRET=changeme
14
+ NEXTAUTH_URL="http://localhost:3000"
15
+
16
+ # Auth providers (Use if you want to get out of development mode sign-in):
17
+ GOOGLE_CLIENT_ID="***"
18
+ GOOGLE_CLIENT_SECRET="***"
19
+ GITHUB_CLIENT_ID="***"
20
+ GITHUB_CLIENT_SECRET="***"
21
+ DISCORD_CLIENT_SECRET="***"
22
+ DISCORD_CLIENT_ID="***"
23
+
24
+ # Backend:
25
+ REWORKD_PLATFORM_ENVIRONMENT="${NODE_ENV}"
26
+ REWORKD_PLATFORM_FF_MOCK_MODE_ENABLED="false"
27
+ REWORKD_PLATFORM_OPENAI_API_KEY="changeme"
28
+ REWORKD_PLATFORM_FRONTEND_URL="http://localhost:3000"
29
+ REWORKD_PLATFORM_RELOAD="true"
30
+ REWORKD_PLATFORM_OPENAI_API_BASE="https://api.openai.com/v1"
31
+ REWORKD_PLATFORM_SERP_API_KEY="changeme"
32
+ REWORKD_PLATFORM_REPLICATE_API_KEY="changeme"
33
+ REWORKD_PLATFORM_SID_CLIENT_ID="changeme"
34
+ REWORKD_PLATFORM_SID_CLIENT_SECRET="changeme"
35
+ REWORKD_PLATFORM_SID_REDIRECT_URI="http://localhost:8000/api/auth/sid/callback"
36
+
37
+ # Database (Backend):
38
+ REWORKD_PLATFORM_DATABASE_USER="reworkd_platform"
39
+ REWORKD_PLATFORM_DATABASE_PASSWORD="reworkd_platform"
40
+ REWORKD_PLATFORM_DATABASE_HOST="agentgpt_db"
41
+ REWORKD_PLATFORM_DATABASE_PORT="3307"
42
+ REWORKD_PLATFORM_DATABASE_NAME="reworkd_platform"
43
+ REWORKD_PLATFORM_DATABASE_URL="mysql://${REWORKD_PLATFORM_DATABASE_USER}:${REWORKD_PLATFORM_DATABASE_PASSWORD}@${REWORKD_PLATFORM_DATABASE_HOST}:${REWORKD_PLATFORM_DATABASE_PORT}/${REWORKD_PLATFORM_DATABASE_NAME}"
44
+
45
+ # Database (Frontend):
46
+ DATABASE_USER="reworkd_platform"
47
+ DATABASE_PASSWORD="reworkd_platform"
48
+ DATABASE_HOST="agentgpt_db"
49
+ DATABASE_PORT="3307"
50
+ DATABASE_NAME="reworkd_platform"
51
+ DATABASE_URL="mysql://${DATABASE_USER}:${DATABASE_PASSWORD}@${DATABASE_HOST}:${DATABASE_PORT}/${DATABASE_NAME}"
.gitattributes CHANGED
@@ -33,3 +33,8 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
33
  *.zip filter=lfs diff=lfs merge=lfs -text
34
  *.zst filter=lfs diff=lfs merge=lfs -text
35
  *tfevents* filter=lfs diff=lfs merge=lfs -text
 
 
 
 
 
 
33
  *.zip filter=lfs diff=lfs merge=lfs -text
34
  *.zst filter=lfs diff=lfs merge=lfs -text
35
  *tfevents* filter=lfs diff=lfs merge=lfs -text
36
+ next/public/fonts/NanumMyeongjo-Regular.ttf filter=lfs diff=lfs merge=lfs -text
37
+ next/public/fonts/Nasu-Regular.ttf filter=lfs diff=lfs merge=lfs -text
38
+ next/public/fonts/SimSun.ttf filter=lfs diff=lfs merge=lfs -text
39
+ next/public/orb-v1-medium.webm filter=lfs diff=lfs merge=lfs -text
40
+ next/public/prod_square.png filter=lfs diff=lfs merge=lfs -text
.github/CODE_OF_CONDUCT.md ADDED
@@ -0,0 +1,128 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ We as members, contributors, and leaders pledge to make participation in our
6
+ community a harassment-free experience for everyone, regardless of age, body
7
+ size, visible or invisible disability, ethnicity, sex characteristics, gender
8
+ identity and expression, level of experience, education, socio-economic status,
9
+ nationality, personal appearance, race, religion, or sexual identity
10
+ and orientation.
11
+
12
+ We pledge to act and interact in ways that contribute to an open, welcoming,
13
+ diverse, inclusive, and healthy community.
14
+
15
+ ## Our Standards
16
+
17
+ Examples of behavior that contributes to a positive environment for our
18
+ community include:
19
+
20
+ * Demonstrating empathy and kindness toward other people
21
+ * Being respectful of differing opinions, viewpoints, and experiences
22
+ * Giving and gracefully accepting constructive feedback
23
+ * Accepting responsibility and apologizing to those affected by our mistakes,
24
+ and learning from the experience
25
+ * Focusing on what is best not just for us as individuals, but for the
26
+ overall community
27
+
28
+ Examples of unacceptable behavior include:
29
+
30
+ * The use of sexualized language or imagery, and sexual attention or
31
+ advances of any kind
32
+ * Trolling, insulting or derogatory comments, and personal or political attacks
33
+ * Public or private harassment
34
+ * Publishing others' private information, such as a physical or email
35
+ address, without their explicit permission
36
+ * Other conduct which could reasonably be considered inappropriate in a
37
+ professional setting
38
+
39
+ ## Enforcement Responsibilities
40
+
41
+ Community leaders are responsible for clarifying and enforcing our standards of
42
+ acceptable behavior and will take appropriate and fair corrective action in
43
+ response to any behavior that they deem inappropriate, threatening, offensive,
44
+ or harmful.
45
+
46
+ Community leaders have the right and responsibility to remove, edit, or reject
47
+ comments, commits, code, wiki edits, issues, and other contributions that are
48
+ not aligned to this Code of Conduct, and will communicate reasons for moderation
49
+ decisions when appropriate.
50
+
51
+ ## Scope
52
+
53
+ This Code of Conduct applies within all community spaces, and also applies when
54
+ an individual is officially representing the community in public spaces.
55
+ Examples of representing our community include using an official e-mail address,
56
+ posting via an official social media account, or acting as an appointed
57
+ representative at an online or offline event.
58
+
59
+ ## Enforcement
60
+
61
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
62
+ reported to the community leaders responsible for enforcement at twitter
63
+ @asimdotshrestha.
64
+ All complaints will be reviewed and investigated promptly and fairly.
65
+
66
+ All community leaders are obligated to respect the privacy and security of the
67
+ reporter of any incident.
68
+
69
+ ## Enforcement Guidelines
70
+
71
+ Community leaders will follow these Community Impact Guidelines in determining
72
+ the consequences for any action they deem in violation of this Code of Conduct:
73
+
74
+ ### 1. Correction
75
+
76
+ **Community Impact**: Use of inappropriate language or other behavior deemed
77
+ unprofessional or unwelcome in the community.
78
+
79
+ **Consequence**: A private, written warning from community leaders, providing
80
+ clarity around the nature of the violation and an explanation of why the
81
+ behavior was inappropriate. A public apology may be requested.
82
+
83
+ ### 2. Warning
84
+
85
+ **Community Impact**: A violation through a single incident or series
86
+ of actions.
87
+
88
+ **Consequence**: A warning with consequences for continued behavior. No
89
+ interaction with the people involved, including unsolicited interaction with
90
+ those enforcing the Code of Conduct, for a specified period of time. This
91
+ includes avoiding interactions in community spaces as well as external channels
92
+ like social media. Violating these terms may lead to a temporary or
93
+ permanent ban.
94
+
95
+ ### 3. Temporary Ban
96
+
97
+ **Community Impact**: A serious violation of community standards, including
98
+ sustained inappropriate behavior.
99
+
100
+ **Consequence**: A temporary ban from any sort of interaction or public
101
+ communication with the community for a specified period of time. No public or
102
+ private interaction with the people involved, including unsolicited interaction
103
+ with those enforcing the Code of Conduct, is allowed during this period.
104
+ Violating these terms may lead to a permanent ban.
105
+
106
+ ### 4. Permanent Ban
107
+
108
+ **Community Impact**: Demonstrating a pattern of violation of community
109
+ standards, including sustained inappropriate behavior, harassment of an
110
+ individual, or aggression toward or disparagement of classes of individuals.
111
+
112
+ **Consequence**: A permanent ban from any sort of public interaction within
113
+ the community.
114
+
115
+ ## Attribution
116
+
117
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118
+ version 2.0, available at
119
+ https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120
+
121
+ Community Impact Guidelines were inspired by [Mozilla's code of conduct
122
+ enforcement ladder](https://github.com/mozilla/diversity).
123
+
124
+ [homepage]: https://www.contributor-covenant.org
125
+
126
+ For answers to common questions about this code of conduct, see the FAQ at
127
+ https://www.contributor-covenant.org/faq. Translations are available at
128
+ https://www.contributor-covenant.org/translations.
.github/CONTRIBUTING.md ADDED
@@ -0,0 +1,64 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Contributing to AgentGPT
2
+
3
+ First of all, thank you for your interest in contributing to AgentGPT! We appreciate the time and effort you're willing to invest in making our project better. This document provides guidelines and information to make the contribution process as smooth as possible.
4
+
5
+ ## Table of Contents
6
+
7
+ - [Code of Conduct](#code-of-conduct)
8
+ - [Getting Started](#getting-started)
9
+ - [How to Contribute](#how-to-contribute)
10
+ - [Reporting Bugs](#reporting-bugs)
11
+ - [Suggesting Enhancements](#suggesting-enhancements)
12
+ - [Submitting Pull Requests](#submitting-pull-requests)
13
+ - [Style Guidelines](#style-guidelines)
14
+ - [Code Style](#code-style)
15
+ - [Commit Messages](#commit-messages)
16
+ - [Additional Resources](#additional-resources)
17
+
18
+ ## Code of Conduct
19
+
20
+ All contributors are expected to adhere to our [Code of Conduct](CODE_OF_CONDUCT.md). Please read it before participating in the AgentGPT community.
21
+
22
+ ## Getting Started
23
+
24
+ 1. Fork the repository and clone it to your local machine.
25
+ 2. Set up the development environment by following the instructions in the [README.md](https://github.com/reworkd/AgentGPT/tree/main/README.md) file.
26
+ 3. Explore the codebase, run tests, and verify that everything works as expected.
27
+
28
+ ## How to Contribute
29
+
30
+ ### Reporting Bugs
31
+
32
+ If you encounter a bug or issue while using AgentGPT, please open a new issue on the [GitHub Issues](https://github.com/reworkd/AgentGPT/issues) page. Provide a clear and concise description of the problem, steps to reproduce it, and any relevant error messages or logs.
33
+
34
+ ### Suggesting Enhancements
35
+
36
+ We welcome ideas for improvements and new features. To suggest an enhancement, open a new issue on the [GitHub Issues](https://github.com/reworkd/AgentGPT/issues) page. Describe the enhancement in detail, explain the use case, and outline the benefits it would bring to the project.
37
+
38
+ ### Submitting Pull Requests
39
+
40
+ 1. Create a new branch for your feature or bugfix. Use a descriptive name like `feature/your-feature-name` or `fix/your-bugfix-name`.
41
+ 2. Make your changes, following the [Style Guidelines](#style-guidelines) below.
42
+ 3. Test your changes and ensure that they don't introduce new issues or break existing functionality.
43
+ 4. Commit your changes, following the [commit message guidelines](#commit-messages).
44
+ 5. Push your branch to your fork on GitHub.
45
+ 6. Open a new pull request against the `main` branch of the Wolverine repository. Include a clear and concise description of your changes, referencing any related issues.
46
+
47
+ ## Style Guidelines
48
+
49
+ ### Code Style
50
+
51
+ AgentGPT uses [ESLint](https://eslint.org/) as its code style guide. Please ensure that your code follows these guidelines.
52
+
53
+ ### Commit Messages
54
+
55
+ Write clear and concise commit messages that briefly describe the changes made in each commit. Use the imperative mood and start with a capitalized verb, e.g., "Add new feature" or "Fix bug in function".
56
+
57
+ ## Additional Resources
58
+
59
+ - [GitHub Help](https://help.github.com/)
60
+ - [GitHub Pull Request Documentation](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests)
61
+ - [ESLint Style Guide](https://eslint.org/)
62
+
63
+ Thank you once again for your interest in contributing to AgentGPT. We look forward to collaborating with you and creating an even better project together!
64
+
.github/FUNDING.yml ADDED
@@ -0,0 +1 @@
 
 
1
+ github: reworkd-admin
.github/ISSUE_TEMPLATE/bug-report.yaml ADDED
@@ -0,0 +1,91 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ name: Bug Report
2
+ description: File a bug report
3
+ labels: ["bug", "needs triage"]
4
+ body:
5
+ - type: markdown
6
+ attributes:
7
+ value: |
8
+ ## Before you start
9
+ Please **make sure you are on the latest version.**
10
+ If you encountered the issue after you installed, updated, or reloaded, **please try restarting before reporting the bug**.
11
+
12
+ - type: checkboxes
13
+ id: no-duplicate-issues
14
+ attributes:
15
+ label: "Please check that this issue hasn't been reported before."
16
+ description: "The **Label filters** may help make your search more focussed."
17
+ options:
18
+ - label: "I searched previous [Bug Reports](https://github.com/reworkd/AgentGPT/labels/bug) didn't find any similar reports."
19
+ required: true
20
+
21
+ - type: textarea
22
+ id: expected
23
+ attributes:
24
+ label: Expected Behavior
25
+ description: Tell us what **should** happen.
26
+ validations:
27
+ required: true
28
+
29
+ - type: textarea
30
+ id: what-happened
31
+ attributes:
32
+ label: Current behaviour
33
+ description: |
34
+ Tell us what happens instead of the expected behavior.
35
+ Adding of screenshots really helps.
36
+ validations:
37
+ required: true
38
+
39
+ - type: textarea
40
+ id: reproduce
41
+ attributes:
42
+ label: Steps to reproduce
43
+ description: |
44
+ Which exact steps can a developer take to reproduce the issue?
45
+ The more detail you provide, the easier it will be to narrow down and fix the bug.
46
+ Please paste in tasks and/or queries **as text, not screenshots**.
47
+ placeholder: |
48
+ Example of the level of detail needed to reproduce any bugs efficiently and reliably.
49
+ 1. Go to the '...' page.
50
+ 2. Click on the '...' button.
51
+ 3. Scroll down to '...'.
52
+ 4. Observe the error.
53
+ validations:
54
+ required: true
55
+
56
+ - type: textarea
57
+ id: possible-solution
58
+ attributes:
59
+ label: Possible solution
60
+ placeholder: I think that change foo to type bar would fix it...
61
+ description: |
62
+ Not obligatory, but please suggest a fix or reason for the bug, if you have an idea.
63
+
64
+
65
+ - type: checkboxes
66
+ id: operating-systems
67
+ attributes:
68
+ label: Which Operating Systems are you using?
69
+ description: You may select more than one.
70
+ options:
71
+ - label: Android
72
+ - label: iPhone/iPad
73
+ - label: Linux
74
+ - label: macOS
75
+ - label: Windows
76
+
77
+ - type: checkboxes
78
+ id: acknowledgements
79
+ attributes:
80
+ label: 'Acknowledgements'
81
+ description: 'Please confirm the following:'
82
+ options:
83
+ - label: 'My issue title is concise, descriptive, and in title casing.'
84
+ required: true
85
+ - label: 'I have searched the existing issues to make sure this bug has not been reported yet.'
86
+ required: true
87
+ - label: 'I am using the latest version of AgentGPT.'
88
+ required: true
89
+ - label: 'I have provided enough information for the maintainers to reproduce and diagnose the issue.'
90
+ required: true
91
+
.github/ISSUE_TEMPLATE/config.yml ADDED
@@ -0,0 +1,7 @@
 
 
 
 
 
 
 
 
1
+ blank_issues_enabled: true
2
+ contact_links:
3
+ - name: Ask a question
4
+ url: https://github.com/reworkd/AgentGPT/discussions/categories/q-a
5
+ about: Ask questions and discuss with other community members
6
+ - name: Discuss the Project in Discord
7
+ url: https://discord.gg/jjYCfaqu
.github/ISSUE_TEMPLATE/docs.yml ADDED
@@ -0,0 +1,46 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ name: Documentation Improvement / Clarity
2
+ description: Make a suggestion to improve the project documentation.
3
+ labels: ['needs triage']
4
+ body:
5
+ - type: markdown
6
+ attributes:
7
+ value: '## :book: Documentation :book:'
8
+ - type: markdown
9
+ attributes:
10
+ value: |
11
+ * Ask questions in [Discord](https://discord.gg/jjYCfaqu).
12
+ * Before you file an issue read the [Contributing guide](https://github.com/reworkd/AgentGPT/tree/main/.github/CONTRIBUTING.md).
13
+ * Check to make sure someone hasn't already opened a [similar issue](https://github.com/reworkd/AgentGPT/issues).
14
+ - type: textarea
15
+ attributes:
16
+ label: What piece of documentation is affected?
17
+ description: Please link to the article you'd like to see updated.
18
+ validations:
19
+ required: true
20
+ - type: textarea
21
+ attributes:
22
+ label: What part(s) of the article would you like to see updated?
23
+ description: |
24
+ - Give as much detail as you can to help us understand the change you want to see.
25
+ - Why should the docs be changed? What use cases does it support?
26
+ - What is the expected outcome?
27
+ validations:
28
+ required: true
29
+ - type: textarea
30
+ attributes:
31
+ label: Additional Information
32
+ description: Add any other context or screenshots about the feature request here.
33
+ validations:
34
+ required: false
35
+ - type: checkboxes
36
+ id: acknowledgements
37
+ attributes:
38
+ label: 'Acknowledgements'
39
+ description: 'Please confirm the following:'
40
+ options:
41
+ - label: 'My issue title is concise, descriptive, and in title casing.'
42
+ required: true
43
+ - label: 'I have searched the existing issues to make sure this feature has not been requested yet.'
44
+ required: true
45
+ - label: 'I have provided enough information for the maintainers to understand and evaluate this request.'
46
+ required: true
.github/ISSUE_TEMPLATE/feature-request.yaml ADDED
@@ -0,0 +1,63 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ name: Feature Request / Enhancement
2
+ description: Suggest a new feature or feature enhancement for the project
3
+ labels: ["enhancement", "needs triage"]
4
+ body:
5
+ - type: checkboxes
6
+ id: no-duplicate-issues
7
+ attributes:
8
+ label: "⚠️ Please check that this feature request hasn't been suggested before."
9
+ description: "There are two locations for previous feature requests. Please search in both. Thank you. The **Label filters** may help make your search more focussed."
10
+ options:
11
+ - label: "I searched previous [Ideas in Discussions](https://github.com/reworkd/AgentGPT/discussions/categories/ideas) didn't find any similar feature requests."
12
+ required: true
13
+ - label: "I searched previous [Issues](https://github.com/reworkd/AgentGPT/labels/enhancement) didn't find any similar feature requests."
14
+ required: true
15
+
16
+ - type: textarea
17
+ id: feature-description
18
+ validations:
19
+ required: true
20
+ attributes:
21
+ label: "🔖 Feature description"
22
+ description: "A clear and concise description of what the feature request is."
23
+ placeholder: "You should add ..."
24
+
25
+ - type: textarea
26
+ id: solution
27
+ validations:
28
+ required: true
29
+ attributes:
30
+ label: "✔️ Solution"
31
+ description: "A clear and concise description of what you want to happen, and why."
32
+ placeholder: "In my use-case, ..."
33
+
34
+ - type: textarea
35
+ id: alternatives
36
+ validations:
37
+ required: false
38
+ attributes:
39
+ label: "❓ Alternatives"
40
+ description: "A clear and concise description of any alternative solutions or features you've considered."
41
+ placeholder: "I have considered ..."
42
+
43
+ - type: textarea
44
+ id: additional-context
45
+ validations:
46
+ required: false
47
+ attributes:
48
+ label: "📝 Additional Context"
49
+ description: "Add any other context or screenshots about the feature request here."
50
+ placeholder: "..."
51
+
52
+ - type: checkboxes
53
+ id: acknowledgements
54
+ attributes:
55
+ label: 'Acknowledgements'
56
+ description: 'Please confirm the following:'
57
+ options:
58
+ - label: 'My issue title is concise, descriptive, and in title casing.'
59
+ required: true
60
+ - label: 'I have searched the existing issues to make sure this feature has not been requested yet.'
61
+ required: true
62
+ - label: 'I have provided enough information for the maintainers to understand and evaluate this request.'
63
+ required: true
.github/PULL_REQUEST_TEMPLATE/pull_request_template.md ADDED
@@ -0,0 +1,59 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ <!--- Provide a general summary of your changes in the Title above -->
2
+
3
+ # Description
4
+
5
+ <!--- Describe your changes in detail -->
6
+
7
+ ## Motivation and Context
8
+
9
+ <!--- Why is this change required? What problem does it solve? -->
10
+ <!--- If it fixes an open issue, please link to the issue here. -->
11
+
12
+ ## How has this been tested?
13
+
14
+ <!--- Please describe in detail how you tested your changes. -->
15
+ <!--- Include details of your testing environment, tests ran to see how -->
16
+ <!--- your change affects other areas of the code, etc. -->
17
+
18
+ ## Screenshots (if appropriate)
19
+
20
+ ## Types of changes
21
+
22
+ <!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
23
+
24
+ Changes visible to users:
25
+
26
+ - [ ] **Bug fix** (prefix: `fix` - non-breaking change which fixes an issue)
27
+ - [ ] **New feature** (prefix: `feat` - non-breaking change which adds functionality)
28
+ - [ ] **Breaking change** (prefix: `feat!!` or `fix!!` - fix or feature that would cause existing functionality to not work as expected)
29
+ - [ ] **Documentation** (prefix: `docs` - improvements to any documentation content **for users**)
30
+ - [ ] **Homepage** (prefix: `page` - improvements to the [Homepage](https://agentgpt.reworkd.ai/) #{HOMEPAGE} should lead to the place where one could actually change the homepage
31
+ - [ ] **Contributing Guidelines** (prefix: `contrib` - any improvements to documentation content **for contributors** - see [Contributing](https://github.com/reworkd/AgentGPT/tree/main/.github/CONTRIBUTING.md)
32
+
33
+ Internal changes:
34
+
35
+ - [ ] **Refactor** (prefix: `refactor` - non-breaking change which only improves the design or structure of existing code, and making no changes to its external behaviour)
36
+ - [ ] **Tests** (prefix: `test` - additions and improvements to unit tests and the smoke tests)
37
+ - [ ] **Infrastructure** (prefix: `chore` - examples include GitHub Actions, issue templates)
38
+
39
+ ## Checklist
40
+
41
+ <!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
42
+ <!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
43
+
44
+ - [ ] My code follows the code style of this project and passes `npm run lint`.
45
+ - [ ] My change requires a change to the documentation.
46
+ - [ ] I have [updated the documentation](https://docs.reworkd.ai) accordingly. # {DOCUMENTATION} <------- this should lead to the doc that could be changed/ didnt find it
47
+ - [ ] My change has adequate [Unit Test coverage]({PLACEHOLDER}).
48
+
49
+ ## Terms
50
+
51
+ <!--
52
+ By submitting this pull request, you must agree to follow our
53
+ [contributing guide](https://github.com/reworkd/AgentGPT/tree/main/.github/CONTRIBUTING.md) and
54
+ [Code of Conduct](https://github.com/reworkd/AgentGPT/tree/main/.github/CODE_OF_CONDUCT.md).
55
+ Put an x in the boxes to confirm you agree.
56
+ -->
57
+
58
+ - [ ] My contribution follow this project's [contributing guide](https://github.com/reworkd/AgentGPT/tree/main/.github/CONTRIBUTING.md)
59
+ - [ ] I agree to follow this project's [Code of Conduct](https://github.com/reworkd/AgentGPT/tree/main/.github/CODE_OF_CONDUCT.md)
.github/SECURITY.md ADDED
@@ -0,0 +1,9 @@
 
 
 
 
 
 
 
 
 
 
1
+ # Security Policy
2
+
3
+ ## Supported Versions
4
+
5
+ Due to the nature of the fast development that is happening in this project, only the latest released version can be supported.
6
+
7
+ ## Reporting a Vulnerability
8
+
9
+ If you find a vulnerability, please either report a vulnerability [here](https://github.com/reworkd/AgentGPT/security) or contact us on twitter @asimdotshrestha. Please don't create a GitHub before contacting a maintainer to allow us to fix the vulnerability before others can take advantage of it.
.github/SUPPORT.md ADDED
@@ -0,0 +1,9 @@
 
 
 
 
 
 
 
 
 
 
1
+ # Support
2
+
3
+ If you need help with this project or have questions, please:
4
+
5
+ 1. Check the documentation.
6
+ 2. Search the existing issues and pull requests.
7
+ 3. Create a new issue if your question is not answered or your problem is not solved.
8
+
9
+ Please note that this project is maintained by volunteers who have limited availability. We'll do our best to address your questions and concerns in a timely manner.
.github/dependabot.yml ADDED
@@ -0,0 +1,19 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Please see the documentation for all configuration options:
2
+ # https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
3
+
4
+ version: 2
5
+ updates:
6
+ - package-ecosystem: npm
7
+ directory: /cli
8
+ schedule:
9
+ interval: weekly
10
+
11
+ - package-ecosystem: npm
12
+ directory: /next
13
+ schedule:
14
+ interval: weekly
15
+
16
+ - package-ecosystem: pip
17
+ directory: /platform
18
+ schedule:
19
+ interval: weekly
.github/workflows/node.js.yml ADDED
@@ -0,0 +1,32 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ name: Node.js CI
2
+
3
+ on:
4
+ push:
5
+ branches: [ "main" ]
6
+ paths:
7
+ - 'next/**'
8
+ pull_request:
9
+ branches: [ "main" ]
10
+ paths:
11
+ - 'next/**'
12
+
13
+ jobs:
14
+ build:
15
+ runs-on: ubuntu-latest
16
+ defaults:
17
+ run:
18
+ working-directory: next
19
+ steps:
20
+ - uses: actions/checkout@v3
21
+ - name: Use Node.js 18
22
+ uses: actions/setup-node@v3
23
+ with:
24
+ node-version: 18.x
25
+ cache: "npm"
26
+ cache-dependency-path: next/package-lock.json
27
+ - run: npm ci
28
+ - run: npm test
29
+ env:
30
+ OPENAI_API_KEY: sk-0000000000
31
+ - run: ./prisma/useSqlite.sh && npm run postinstall
32
+
.github/workflows/python.yml ADDED
@@ -0,0 +1,80 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ name: Testing Platform
2
+ on:
3
+ pull_request:
4
+ branches: [ "main" ]
5
+ paths:
6
+ - 'platform/**'
7
+
8
+ env:
9
+ PYTHON_VERSION: "3.11"
10
+
11
+ jobs:
12
+ black:
13
+ runs-on: ubuntu-latest
14
+ defaults:
15
+ run:
16
+ working-directory: platform
17
+ steps:
18
+ - uses: actions/checkout@v3
19
+ - name: Install poetry
20
+ run: pipx install poetry
21
+ - uses: actions/setup-python@v4
22
+ with:
23
+ python-version: ${{ env.PYTHON_VERSION }}
24
+ cache: 'poetry'
25
+ - run: poetry install
26
+ - name: Run black check
27
+ run: poetry run black --check .
28
+
29
+ mypy:
30
+ runs-on: ubuntu-latest
31
+ defaults:
32
+ run:
33
+ working-directory: platform
34
+ steps:
35
+ - uses: actions/checkout@v3
36
+ - name: Install poetry
37
+ run: pipx install poetry
38
+ - uses: actions/setup-python@v4
39
+ with:
40
+ python-version: ${{ env.PYTHON_VERSION }}
41
+ cache: 'poetry'
42
+ - run: poetry install
43
+ - name: Run mypy check
44
+ run: poetry run mypy .
45
+
46
+ pytest:
47
+ runs-on: ubuntu-latest
48
+ defaults:
49
+ run:
50
+ working-directory: platform
51
+ services:
52
+ reworkd_platform-db:
53
+ image: bitnami/mysql:8.0.30
54
+ env:
55
+ MYSQL_ROOT_PASSWORD: "reworkd_platform"
56
+ MYSQL_ROOT_USER: "reworkd_platform"
57
+ MYSQL_DATABASE: "reworkd_platform"
58
+ MYSQL_AUTHENTICATION_PLUGIN: "mysql_native_password"
59
+ options: >-
60
+ --health-cmd="mysqladmin ping -u root"
61
+ --health-interval=15s
62
+ --health-timeout=5s
63
+ --health-retries=6
64
+ ports:
65
+ - 3306:3306
66
+ steps:
67
+ - uses: actions/checkout@v3
68
+ - name: Install poetry
69
+ run: pipx install poetry
70
+ - uses: actions/setup-python@v4
71
+ with:
72
+ python-version: ${{ env.PYTHON_VERSION }}
73
+ cache: 'poetry'
74
+ - run: poetry install
75
+ - name: Run pytest check
76
+ run: poetry run pytest -vv --cov="reworkd_platform" .
77
+ env:
78
+ REWORKD_PLATFORM_HOST: "0.0.0.0"
79
+ REWORKD_PLATFORM_DB_HOST: localhost
80
+ REWORKD_PLATFORM_KAFKA_BOOTSTRAP_SERVERS: '["localhost:9092"]'
.github/workflows/sponsors.yml ADDED
@@ -0,0 +1,29 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ name: Generate Sponsors README
2
+ on:
3
+ workflow_dispatch:
4
+ schedule:
5
+ - cron: 0 0 * * *
6
+ jobs:
7
+ deploy:
8
+ runs-on: ubuntu-latest
9
+ steps:
10
+ - name: Checkout 🛎️
11
+ uses: actions/checkout@v2
12
+
13
+ - name: Generate Sponsors 💖
14
+ uses: JamesIves/[email protected]
15
+ with:
16
+ token: ${{ secrets.SPONSOR_WORKFLOW_PAT }}
17
+ file: 'README.md'
18
+ minimum: 1399
19
+
20
+ - name: Create Pull Request
21
+ uses: peter-evans/[email protected]
22
+ with:
23
+ token: ${{ secrets.SPONSOR_WORKFLOW_PAT }}
24
+ branch: "workflow/sponsors"
25
+ title: "🤖 Update Sponsors"
26
+ commit-message: "🤖 Update Sponsors"
27
+ body: "🤖 Automated pull request created by [sponsors action](https://github.com/reworkd/AgentGPT/actions/workflows/sponsors.yml)"
28
+ labels: "documentation"
29
+
.github/workflows/webhooks.yml ADDED
@@ -0,0 +1,22 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ name: Invoke Deployment Webhooks
2
+ on:
3
+ workflow_dispatch:
4
+ push:
5
+ branches: [ "main" ]
6
+
7
+ jobs:
8
+ invoke:
9
+ name: Invoke Webhooks
10
+ runs-on: ubuntu-latest
11
+ environment: production
12
+ if: github.repository == 'reworkd/AgentGPT'
13
+ steps:
14
+ - name: Trigger Webhooks
15
+ run: |
16
+ curl -L \
17
+ -X POST \
18
+ -H "Accept: application/vnd.github+json" \
19
+ -H ${{ secrets.WEBHOOK_AUTHORIZATION }} \
20
+ -H "X-GitHub-Api-Version: 2022-11-28" \
21
+ -d '{"ref":"main"}' \
22
+ ${{ secrets.DEPLOYMENT_WEBHOOK_URL }}
.gitignore ADDED
@@ -0,0 +1,55 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
2
+
3
+ # dependencies
4
+ /node_modules
5
+ /.pnp
6
+ .pnp.js
7
+
8
+ # testing
9
+ /coverage
10
+
11
+ # database
12
+ /prisma/db.sqlite
13
+ /prisma/db.sqlite-journal
14
+ /db/db.sqlite
15
+
16
+ # next.js
17
+ /.next/
18
+ /out/
19
+ next-env.d.ts
20
+
21
+ # production
22
+ /build
23
+
24
+ # misc
25
+ .DS_Store
26
+ *.pem
27
+
28
+ # debug
29
+ npm-debug.log*
30
+ yarn-debug.log*
31
+ yarn-error.log*
32
+ .pnpm-debug.log*
33
+
34
+ # local env files
35
+ # do not commit any .env files to git, except for the .env.example file. https://create.t3.gg/en/usage/env-variables#using-environment-variables
36
+ .env*
37
+
38
+ # vercel
39
+ .vercel
40
+
41
+ # typescript
42
+ *.tsbuildinfo
43
+ .idea
44
+ .swc
45
+
46
+ # extracted language files
47
+ /public/locales/$LOCALES
48
+
49
+ .eslintcache
50
+
51
+ # Sentry Auth Token
52
+ .sentryclirc
53
+ /volumes/
54
+ schema.prismae
55
+ *.sql
LICENSE ADDED
@@ -0,0 +1,674 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ GNU GENERAL PUBLIC LICENSE
2
+ Version 3, 29 June 2007
3
+
4
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
5
+ Everyone is permitted to copy and distribute verbatim copies
6
+ of this license document, but changing it is not allowed.
7
+
8
+ Preamble
9
+
10
+ The GNU General Public License is a free, copyleft license for
11
+ software and other kinds of works.
12
+
13
+ The licenses for most software and other practical works are designed
14
+ to take away your freedom to share and change the works. By contrast,
15
+ the GNU General Public License is intended to guarantee your freedom to
16
+ share and change all versions of a program--to make sure it remains free
17
+ software for all its users. We, the Free Software Foundation, use the
18
+ GNU General Public License for most of our software; it applies also to
19
+ any other work released this way by its authors. You can apply it to
20
+ your programs, too.
21
+
22
+ When we speak of free software, we are referring to freedom, not
23
+ price. Our General Public Licenses are designed to make sure that you
24
+ have the freedom to distribute copies of free software (and charge for
25
+ them if you wish), that you receive source code or can get it if you
26
+ want it, that you can change the software or use pieces of it in new
27
+ free programs, and that you know you can do these things.
28
+
29
+ To protect your rights, we need to prevent others from denying you
30
+ these rights or asking you to surrender the rights. Therefore, you have
31
+ certain responsibilities if you distribute copies of the software, or if
32
+ you modify it: responsibilities to respect the freedom of others.
33
+
34
+ For example, if you distribute copies of such a program, whether
35
+ gratis or for a fee, you must pass on to the recipients the same
36
+ freedoms that you received. You must make sure that they, too, receive
37
+ or can get the source code. And you must show them these terms so they
38
+ know their rights.
39
+
40
+ Developers that use the GNU GPL protect your rights with two steps:
41
+ (1) assert copyright on the software, and (2) offer you this License
42
+ giving you legal permission to copy, distribute and/or modify it.
43
+
44
+ For the developers' and authors' protection, the GPL clearly explains
45
+ that there is no warranty for this free software. For both users' and
46
+ authors' sake, the GPL requires that modified versions be marked as
47
+ changed, so that their problems will not be attributed erroneously to
48
+ authors of previous versions.
49
+
50
+ Some devices are designed to deny users access to install or run
51
+ modified versions of the software inside them, although the manufacturer
52
+ can do so. This is fundamentally incompatible with the aim of
53
+ protecting users' freedom to change the software. The systematic
54
+ pattern of such abuse occurs in the area of products for individuals to
55
+ use, which is precisely where it is most unacceptable. Therefore, we
56
+ have designed this version of the GPL to prohibit the practice for those
57
+ products. If such problems arise substantially in other domains, we
58
+ stand ready to extend this provision to those domains in future versions
59
+ of the GPL, as needed to protect the freedom of users.
60
+
61
+ Finally, every program is threatened constantly by software patents.
62
+ States should not allow patents to restrict development and use of
63
+ software on general-purpose computers, but in those that do, we wish to
64
+ avoid the special danger that patents applied to a free program could
65
+ make it effectively proprietary. To prevent this, the GPL assures that
66
+ patents cannot be used to render the program non-free.
67
+
68
+ The precise terms and conditions for copying, distribution and
69
+ modification follow.
70
+
71
+ TERMS AND CONDITIONS
72
+
73
+ 0. Definitions.
74
+
75
+ "This License" refers to version 3 of the GNU General Public License.
76
+
77
+ "Copyright" also means copyright-like laws that apply to other kinds of
78
+ works, such as semiconductor masks.
79
+
80
+ "The Program" refers to any copyrightable work licensed under this
81
+ License. Each licensee is addressed as "you". "Licensees" and
82
+ "recipients" may be individuals or organizations.
83
+
84
+ To "modify" a work means to copy from or adapt all or part of the work
85
+ in a fashion requiring copyright permission, other than the making of an
86
+ exact copy. The resulting work is called a "modified version" of the
87
+ earlier work or a work "based on" the earlier work.
88
+
89
+ A "covered work" means either the unmodified Program or a work based
90
+ on the Program.
91
+
92
+ To "propagate" a work means to do anything with it that, without
93
+ permission, would make you directly or secondarily liable for
94
+ infringement under applicable copyright law, except executing it on a
95
+ computer or modifying a private copy. Propagation includes copying,
96
+ distribution (with or without modification), making available to the
97
+ public, and in some countries other activities as well.
98
+
99
+ To "convey" a work means any kind of propagation that enables other
100
+ parties to make or receive copies. Mere interaction with a user through
101
+ a computer network, with no transfer of a copy, is not conveying.
102
+
103
+ An interactive user interface displays "Appropriate Legal Notices"
104
+ to the extent that it includes a convenient and prominently visible
105
+ feature that (1) displays an appropriate copyright notice, and (2)
106
+ tells the user that there is no warranty for the work (except to the
107
+ extent that warranties are provided), that licensees may convey the
108
+ work under this License, and how to view a copy of this License. If
109
+ the interface presents a list of user commands or options, such as a
110
+ menu, a prominent item in the list meets this criterion.
111
+
112
+ 1. Source Code.
113
+
114
+ The "source code" for a work means the preferred form of the work
115
+ for making modifications to it. "Object code" means any non-source
116
+ form of a work.
117
+
118
+ A "Standard Interface" means an interface that either is an official
119
+ standard defined by a recognized standards body, or, in the case of
120
+ interfaces specified for a particular programming language, one that
121
+ is widely used among developers working in that language.
122
+
123
+ The "System Libraries" of an executable work include anything, other
124
+ than the work as a whole, that (a) is included in the normal form of
125
+ packaging a Major Component, but which is not part of that Major
126
+ Component, and (b) serves only to enable use of the work with that
127
+ Major Component, or to implement a Standard Interface for which an
128
+ implementation is available to the public in source code form. A
129
+ "Major Component", in this context, means a major essential component
130
+ (kernel, window system, and so on) of the specific operating system
131
+ (if any) on which the executable work runs, or a compiler used to
132
+ produce the work, or an object code interpreter used to run it.
133
+
134
+ The "Corresponding Source" for a work in object code form means all
135
+ the source code needed to generate, install, and (for an executable
136
+ work) run the object code and to modify the work, including scripts to
137
+ control those activities. However, it does not include the work's
138
+ System Libraries, or general-purpose tools or generally available free
139
+ programs which are used unmodified in performing those activities but
140
+ which are not part of the work. For example, Corresponding Source
141
+ includes interface definition files associated with source files for
142
+ the work, and the source code for shared libraries and dynamically
143
+ linked subprograms that the work is specifically designed to require,
144
+ such as by intimate data communication or control flow between those
145
+ subprograms and other parts of the work.
146
+
147
+ The Corresponding Source need not include anything that users
148
+ can regenerate automatically from other parts of the Corresponding
149
+ Source.
150
+
151
+ The Corresponding Source for a work in source code form is that
152
+ same work.
153
+
154
+ 2. Basic Permissions.
155
+
156
+ All rights granted under this License are granted for the term of
157
+ copyright on the Program, and are irrevocable provided the stated
158
+ conditions are met. This License explicitly affirms your unlimited
159
+ permission to run the unmodified Program. The output from running a
160
+ covered work is covered by this License only if the output, given its
161
+ content, constitutes a covered work. This License acknowledges your
162
+ rights of fair use or other equivalent, as provided by copyright law.
163
+
164
+ You may make, run and propagate covered works that you do not
165
+ convey, without conditions so long as your license otherwise remains
166
+ in force. You may convey covered works to others for the sole purpose
167
+ of having them make modifications exclusively for you, or provide you
168
+ with facilities for running those works, provided that you comply with
169
+ the terms of this License in conveying all material for which you do
170
+ not control copyright. Those thus making or running the covered works
171
+ for you must do so exclusively on your behalf, under your direction
172
+ and control, on terms that prohibit them from making any copies of
173
+ your copyrighted material outside their relationship with you.
174
+
175
+ Conveying under any other circumstances is permitted solely under
176
+ the conditions stated below. Sublicensing is not allowed; section 10
177
+ makes it unnecessary.
178
+
179
+ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180
+
181
+ No covered work shall be deemed part of an effective technological
182
+ measure under any applicable law fulfilling obligations under article
183
+ 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184
+ similar laws prohibiting or restricting circumvention of such
185
+ measures.
186
+
187
+ When you convey a covered work, you waive any legal power to forbid
188
+ circumvention of technological measures to the extent such circumvention
189
+ is effected by exercising rights under this License with respect to
190
+ the covered work, and you disclaim any intention to limit operation or
191
+ modification of the work as a means of enforcing, against the work's
192
+ users, your or third parties' legal rights to forbid circumvention of
193
+ technological measures.
194
+
195
+ 4. Conveying Verbatim Copies.
196
+
197
+ You may convey verbatim copies of the Program's source code as you
198
+ receive it, in any medium, provided that you conspicuously and
199
+ appropriately publish on each copy an appropriate copyright notice;
200
+ keep intact all notices stating that this License and any
201
+ non-permissive terms added in accord with section 7 apply to the code;
202
+ keep intact all notices of the absence of any warranty; and give all
203
+ recipients a copy of this License along with the Program.
204
+
205
+ You may charge any price or no price for each copy that you convey,
206
+ and you may offer support or warranty protection for a fee.
207
+
208
+ 5. Conveying Modified Source Versions.
209
+
210
+ You may convey a work based on the Program, or the modifications to
211
+ produce it from the Program, in the form of source code under the
212
+ terms of section 4, provided that you also meet all of these conditions:
213
+
214
+ a) The work must carry prominent notices stating that you modified
215
+ it, and giving a relevant date.
216
+
217
+ b) The work must carry prominent notices stating that it is
218
+ released under this License and any conditions added under section
219
+ 7. This requirement modifies the requirement in section 4 to
220
+ "keep intact all notices".
221
+
222
+ c) You must license the entire work, as a whole, under this
223
+ License to anyone who comes into possession of a copy. This
224
+ License will therefore apply, along with any applicable section 7
225
+ additional terms, to the whole of the work, and all its parts,
226
+ regardless of how they are packaged. This License gives no
227
+ permission to license the work in any other way, but it does not
228
+ invalidate such permission if you have separately received it.
229
+
230
+ d) If the work has interactive user interfaces, each must display
231
+ Appropriate Legal Notices; however, if the Program has interactive
232
+ interfaces that do not display Appropriate Legal Notices, your
233
+ work need not make them do so.
234
+
235
+ A compilation of a covered work with other separate and independent
236
+ works, which are not by their nature extensions of the covered work,
237
+ and which are not combined with it such as to form a larger program,
238
+ in or on a volume of a storage or distribution medium, is called an
239
+ "aggregate" if the compilation and its resulting copyright are not
240
+ used to limit the access or legal rights of the compilation's users
241
+ beyond what the individual works permit. Inclusion of a covered work
242
+ in an aggregate does not cause this License to apply to the other
243
+ parts of the aggregate.
244
+
245
+ 6. Conveying Non-Source Forms.
246
+
247
+ You may convey a covered work in object code form under the terms
248
+ of sections 4 and 5, provided that you also convey the
249
+ machine-readable Corresponding Source under the terms of this License,
250
+ in one of these ways:
251
+
252
+ a) Convey the object code in, or embodied in, a physical product
253
+ (including a physical distribution medium), accompanied by the
254
+ Corresponding Source fixed on a durable physical medium
255
+ customarily used for software interchange.
256
+
257
+ b) Convey the object code in, or embodied in, a physical product
258
+ (including a physical distribution medium), accompanied by a
259
+ written offer, valid for at least three years and valid for as
260
+ long as you offer spare parts or customer support for that product
261
+ model, to give anyone who possesses the object code either (1) a
262
+ copy of the Corresponding Source for all the software in the
263
+ product that is covered by this License, on a durable physical
264
+ medium customarily used for software interchange, for a price no
265
+ more than your reasonable cost of physically performing this
266
+ conveying of source, or (2) access to copy the
267
+ Corresponding Source from a network server at no charge.
268
+
269
+ c) Convey individual copies of the object code with a copy of the
270
+ written offer to provide the Corresponding Source. This
271
+ alternative is allowed only occasionally and noncommercially, and
272
+ only if you received the object code with such an offer, in accord
273
+ with subsection 6b.
274
+
275
+ d) Convey the object code by offering access from a designated
276
+ place (gratis or for a charge), and offer equivalent access to the
277
+ Corresponding Source in the same way through the same place at no
278
+ further charge. You need not require recipients to copy the
279
+ Corresponding Source along with the object code. If the place to
280
+ copy the object code is a network server, the Corresponding Source
281
+ may be on a different server (operated by you or a third party)
282
+ that supports equivalent copying facilities, provided you maintain
283
+ clear directions next to the object code saying where to find the
284
+ Corresponding Source. Regardless of what server hosts the
285
+ Corresponding Source, you remain obligated to ensure that it is
286
+ available for as long as needed to satisfy these requirements.
287
+
288
+ e) Convey the object code using peer-to-peer transmission, provided
289
+ you inform other peers where the object code and Corresponding
290
+ Source of the work are being offered to the general public at no
291
+ charge under subsection 6d.
292
+
293
+ A separable portion of the object code, whose source code is excluded
294
+ from the Corresponding Source as a System Library, need not be
295
+ included in conveying the object code work.
296
+
297
+ A "User Product" is either (1) a "consumer product", which means any
298
+ tangible personal property which is normally used for personal, family,
299
+ or household purposes, or (2) anything designed or sold for incorporation
300
+ into a dwelling. In determining whether a product is a consumer product,
301
+ doubtful cases shall be resolved in favor of coverage. For a particular
302
+ product received by a particular user, "normally used" refers to a
303
+ typical or common use of that class of product, regardless of the status
304
+ of the particular user or of the way in which the particular user
305
+ actually uses, or expects or is expected to use, the product. A product
306
+ is a consumer product regardless of whether the product has substantial
307
+ commercial, industrial or non-consumer uses, unless such uses represent
308
+ the only significant mode of use of the product.
309
+
310
+ "Installation Information" for a User Product means any methods,
311
+ procedures, authorization keys, or other information required to install
312
+ and execute modified versions of a covered work in that User Product from
313
+ a modified version of its Corresponding Source. The information must
314
+ suffice to ensure that the continued functioning of the modified object
315
+ code is in no case prevented or interfered with solely because
316
+ modification has been made.
317
+
318
+ If you convey an object code work under this section in, or with, or
319
+ specifically for use in, a User Product, and the conveying occurs as
320
+ part of a transaction in which the right of possession and use of the
321
+ User Product is transferred to the recipient in perpetuity or for a
322
+ fixed term (regardless of how the transaction is characterized), the
323
+ Corresponding Source conveyed under this section must be accompanied
324
+ by the Installation Information. But this requirement does not apply
325
+ if neither you nor any third party retains the ability to install
326
+ modified object code on the User Product (for example, the work has
327
+ been installed in ROM).
328
+
329
+ The requirement to provide Installation Information does not include a
330
+ requirement to continue to provide support service, warranty, or updates
331
+ for a work that has been modified or installed by the recipient, or for
332
+ the User Product in which it has been modified or installed. Access to a
333
+ network may be denied when the modification itself materially and
334
+ adversely affects the operation of the network or violates the rules and
335
+ protocols for communication across the network.
336
+
337
+ Corresponding Source conveyed, and Installation Information provided,
338
+ in accord with this section must be in a format that is publicly
339
+ documented (and with an implementation available to the public in
340
+ source code form), and must require no special password or key for
341
+ unpacking, reading or copying.
342
+
343
+ 7. Additional Terms.
344
+
345
+ "Additional permissions" are terms that supplement the terms of this
346
+ License by making exceptions from one or more of its conditions.
347
+ Additional permissions that are applicable to the entire Program shall
348
+ be treated as though they were included in this License, to the extent
349
+ that they are valid under applicable law. If additional permissions
350
+ apply only to part of the Program, that part may be used separately
351
+ under those permissions, but the entire Program remains governed by
352
+ this License without regard to the additional permissions.
353
+
354
+ When you convey a copy of a covered work, you may at your option
355
+ remove any additional permissions from that copy, or from any part of
356
+ it. (Additional permissions may be written to require their own
357
+ removal in certain cases when you modify the work.) You may place
358
+ additional permissions on material, added by you to a covered work,
359
+ for which you have or can give appropriate copyright permission.
360
+
361
+ Notwithstanding any other provision of this License, for material you
362
+ add to a covered work, you may (if authorized by the copyright holders of
363
+ that material) supplement the terms of this License with terms:
364
+
365
+ a) Disclaiming warranty or limiting liability differently from the
366
+ terms of sections 15 and 16 of this License; or
367
+
368
+ b) Requiring preservation of specified reasonable legal notices or
369
+ author attributions in that material or in the Appropriate Legal
370
+ Notices displayed by works containing it; or
371
+
372
+ c) Prohibiting misrepresentation of the origin of that material, or
373
+ requiring that modified versions of such material be marked in
374
+ reasonable ways as different from the original version; or
375
+
376
+ d) Limiting the use for publicity purposes of names of licensors or
377
+ authors of the material; or
378
+
379
+ e) Declining to grant rights under trademark law for use of some
380
+ trade names, trademarks, or service marks; or
381
+
382
+ f) Requiring indemnification of licensors and authors of that
383
+ material by anyone who conveys the material (or modified versions of
384
+ it) with contractual assumptions of liability to the recipient, for
385
+ any liability that these contractual assumptions directly impose on
386
+ those licensors and authors.
387
+
388
+ All other non-permissive additional terms are considered "further
389
+ restrictions" within the meaning of section 10. If the Program as you
390
+ received it, or any part of it, contains a notice stating that it is
391
+ governed by this License along with a term that is a further
392
+ restriction, you may remove that term. If a license document contains
393
+ a further restriction but permits relicensing or conveying under this
394
+ License, you may add to a covered work material governed by the terms
395
+ of that license document, provided that the further restriction does
396
+ not survive such relicensing or conveying.
397
+
398
+ If you add terms to a covered work in accord with this section, you
399
+ must place, in the relevant source files, a statement of the
400
+ additional terms that apply to those files, or a notice indicating
401
+ where to find the applicable terms.
402
+
403
+ Additional terms, permissive or non-permissive, may be stated in the
404
+ form of a separately written license, or stated as exceptions;
405
+ the above requirements apply either way.
406
+
407
+ 8. Termination.
408
+
409
+ You may not propagate or modify a covered work except as expressly
410
+ provided under this License. Any attempt otherwise to propagate or
411
+ modify it is void, and will automatically terminate your rights under
412
+ this License (including any patent licenses granted under the third
413
+ paragraph of section 11).
414
+
415
+ However, if you cease all violation of this License, then your
416
+ license from a particular copyright holder is reinstated (a)
417
+ provisionally, unless and until the copyright holder explicitly and
418
+ finally terminates your license, and (b) permanently, if the copyright
419
+ holder fails to notify you of the violation by some reasonable means
420
+ prior to 60 days after the cessation.
421
+
422
+ Moreover, your license from a particular copyright holder is
423
+ reinstated permanently if the copyright holder notifies you of the
424
+ violation by some reasonable means, this is the first time you have
425
+ received notice of violation of this License (for any work) from that
426
+ copyright holder, and you cure the violation prior to 30 days after
427
+ your receipt of the notice.
428
+
429
+ Termination of your rights under this section does not terminate the
430
+ licenses of parties who have received copies or rights from you under
431
+ this License. If your rights have been terminated and not permanently
432
+ reinstated, you do not qualify to receive new licenses for the same
433
+ material under section 10.
434
+
435
+ 9. Acceptance Not Required for Having Copies.
436
+
437
+ You are not required to accept this License in order to receive or
438
+ run a copy of the Program. Ancillary propagation of a covered work
439
+ occurring solely as a consequence of using peer-to-peer transmission
440
+ to receive a copy likewise does not require acceptance. However,
441
+ nothing other than this License grants you permission to propagate or
442
+ modify any covered work. These actions infringe copyright if you do
443
+ not accept this License. Therefore, by modifying or propagating a
444
+ covered work, you indicate your acceptance of this License to do so.
445
+
446
+ 10. Automatic Licensing of Downstream Recipients.
447
+
448
+ Each time you convey a covered work, the recipient automatically
449
+ receives a license from the original licensors, to run, modify and
450
+ propagate that work, subject to this License. You are not responsible
451
+ for enforcing compliance by third parties with this License.
452
+
453
+ An "entity transaction" is a transaction transferring control of an
454
+ organization, or substantially all assets of one, or subdividing an
455
+ organization, or merging organizations. If propagation of a covered
456
+ work results from an entity transaction, each party to that
457
+ transaction who receives a copy of the work also receives whatever
458
+ licenses to the work the party's predecessor in interest had or could
459
+ give under the previous paragraph, plus a right to possession of the
460
+ Corresponding Source of the work from the predecessor in interest, if
461
+ the predecessor has it or can get it with reasonable efforts.
462
+
463
+ You may not impose any further restrictions on the exercise of the
464
+ rights granted or affirmed under this License. For example, you may
465
+ not impose a license fee, royalty, or other charge for exercise of
466
+ rights granted under this License, and you may not initiate litigation
467
+ (including a cross-claim or counterclaim in a lawsuit) alleging that
468
+ any patent claim is infringed by making, using, selling, offering for
469
+ sale, or importing the Program or any portion of it.
470
+
471
+ 11. Patents.
472
+
473
+ A "contributor" is a copyright holder who authorizes use under this
474
+ License of the Program or a work on which the Program is based. The
475
+ work thus licensed is called the contributor's "contributor version".
476
+
477
+ A contributor's "essential patent claims" are all patent claims
478
+ owned or controlled by the contributor, whether already acquired or
479
+ hereafter acquired, that would be infringed by some manner, permitted
480
+ by this License, of making, using, or selling its contributor version,
481
+ but do not include claims that would be infringed only as a
482
+ consequence of further modification of the contributor version. For
483
+ purposes of this definition, "control" includes the right to grant
484
+ patent sublicenses in a manner consistent with the requirements of
485
+ this License.
486
+
487
+ Each contributor grants you a non-exclusive, worldwide, royalty-free
488
+ patent license under the contributor's essential patent claims, to
489
+ make, use, sell, offer for sale, import and otherwise run, modify and
490
+ propagate the contents of its contributor version.
491
+
492
+ In the following three paragraphs, a "patent license" is any express
493
+ agreement or commitment, however denominated, not to enforce a patent
494
+ (such as an express permission to practice a patent or covenant not to
495
+ sue for patent infringement). To "grant" such a patent license to a
496
+ party means to make such an agreement or commitment not to enforce a
497
+ patent against the party.
498
+
499
+ If you convey a covered work, knowingly relying on a patent license,
500
+ and the Corresponding Source of the work is not available for anyone
501
+ to copy, free of charge and under the terms of this License, through a
502
+ publicly available network server or other readily accessible means,
503
+ then you must either (1) cause the Corresponding Source to be so
504
+ available, or (2) arrange to deprive yourself of the benefit of the
505
+ patent license for this particular work, or (3) arrange, in a manner
506
+ consistent with the requirements of this License, to extend the patent
507
+ license to downstream recipients. "Knowingly relying" means you have
508
+ actual knowledge that, but for the patent license, your conveying the
509
+ covered work in a country, or your recipient's use of the covered work
510
+ in a country, would infringe one or more identifiable patents in that
511
+ country that you have reason to believe are valid.
512
+
513
+ If, pursuant to or in connection with a single transaction or
514
+ arrangement, you convey, or propagate by procuring conveyance of, a
515
+ covered work, and grant a patent license to some of the parties
516
+ receiving the covered work authorizing them to use, propagate, modify
517
+ or convey a specific copy of the covered work, then the patent license
518
+ you grant is automatically extended to all recipients of the covered
519
+ work and works based on it.
520
+
521
+ A patent license is "discriminatory" if it does not include within
522
+ the scope of its coverage, prohibits the exercise of, or is
523
+ conditioned on the non-exercise of one or more of the rights that are
524
+ specifically granted under this License. You may not convey a covered
525
+ work if you are a party to an arrangement with a third party that is
526
+ in the business of distributing software, under which you make payment
527
+ to the third party based on the extent of your activity of conveying
528
+ the work, and under which the third party grants, to any of the
529
+ parties who would receive the covered work from you, a discriminatory
530
+ patent license (a) in connection with copies of the covered work
531
+ conveyed by you (or copies made from those copies), or (b) primarily
532
+ for and in connection with specific products or compilations that
533
+ contain the covered work, unless you entered into that arrangement,
534
+ or that patent license was granted, prior to 28 March 2007.
535
+
536
+ Nothing in this License shall be construed as excluding or limiting
537
+ any implied license or other defenses to infringement that may
538
+ otherwise be available to you under applicable patent law.
539
+
540
+ 12. No Surrender of Others' Freedom.
541
+
542
+ If conditions are imposed on you (whether by court order, agreement or
543
+ otherwise) that contradict the conditions of this License, they do not
544
+ excuse you from the conditions of this License. If you cannot convey a
545
+ covered work so as to satisfy simultaneously your obligations under this
546
+ License and any other pertinent obligations, then as a consequence you may
547
+ not convey it at all. For example, if you agree to terms that obligate you
548
+ to collect a royalty for further conveying from those to whom you convey
549
+ the Program, the only way you could satisfy both those terms and this
550
+ License would be to refrain entirely from conveying the Program.
551
+
552
+ 13. Use with the GNU Affero General Public License.
553
+
554
+ Notwithstanding any other provision of this License, you have
555
+ permission to link or combine any covered work with a work licensed
556
+ under version 3 of the GNU Affero General Public License into a single
557
+ combined work, and to convey the resulting work. The terms of this
558
+ License will continue to apply to the part which is the covered work,
559
+ but the special requirements of the GNU Affero General Public License,
560
+ section 13, concerning interaction through a network will apply to the
561
+ combination as such.
562
+
563
+ 14. Revised Versions of this License.
564
+
565
+ The Free Software Foundation may publish revised and/or new versions of
566
+ the GNU General Public License from time to time. Such new versions will
567
+ be similar in spirit to the present version, but may differ in detail to
568
+ address new problems or concerns.
569
+
570
+ Each version is given a distinguishing version number. If the
571
+ Program specifies that a certain numbered version of the GNU General
572
+ Public License "or any later version" applies to it, you have the
573
+ option of following the terms and conditions either of that numbered
574
+ version or of any later version published by the Free Software
575
+ Foundation. If the Program does not specify a version number of the
576
+ GNU General Public License, you may choose any version ever published
577
+ by the Free Software Foundation.
578
+
579
+ If the Program specifies that a proxy can decide which future
580
+ versions of the GNU General Public License can be used, that proxy's
581
+ public statement of acceptance of a version permanently authorizes you
582
+ to choose that version for the Program.
583
+
584
+ Later license versions may give you additional or different
585
+ permissions. However, no additional obligations are imposed on any
586
+ author or copyright holder as a result of your choosing to follow a
587
+ later version.
588
+
589
+ 15. Disclaimer of Warranty.
590
+
591
+ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592
+ APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593
+ HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594
+ OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595
+ THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596
+ PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597
+ IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598
+ ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599
+
600
+ 16. Limitation of Liability.
601
+
602
+ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603
+ WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604
+ THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605
+ GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606
+ USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607
+ DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608
+ PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609
+ EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610
+ SUCH DAMAGES.
611
+
612
+ 17. Interpretation of Sections 15 and 16.
613
+
614
+ If the disclaimer of warranty and limitation of liability provided
615
+ above cannot be given local legal effect according to their terms,
616
+ reviewing courts shall apply local law that most closely approximates
617
+ an absolute waiver of all civil liability in connection with the
618
+ Program, unless a warranty or assumption of liability accompanies a
619
+ copy of the Program in return for a fee.
620
+
621
+ END OF TERMS AND CONDITIONS
622
+
623
+ How to Apply These Terms to Your New Programs
624
+
625
+ If you develop a new program, and you want it to be of the greatest
626
+ possible use to the public, the best way to achieve this is to make it
627
+ free software which everyone can redistribute and change under these terms.
628
+
629
+ To do so, attach the following notices to the program. It is safest
630
+ to attach them to the start of each source file to most effectively
631
+ state the exclusion of warranty; and each file should have at least
632
+ the "copyright" line and a pointer to where the full notice is found.
633
+
634
+ <one line to give the program's name and a brief idea of what it does.>
635
+ Copyright (C) <year> <name of author>
636
+
637
+ This program is free software: you can redistribute it and/or modify
638
+ it under the terms of the GNU General Public License as published by
639
+ the Free Software Foundation, either version 3 of the License, or
640
+ (at your option) any later version.
641
+
642
+ This program is distributed in the hope that it will be useful,
643
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
644
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645
+ GNU General Public License for more details.
646
+
647
+ You should have received a copy of the GNU General Public License
648
+ along with this program. If not, see <https://www.gnu.org/licenses/>.
649
+
650
+ Also add information on how to contact you by electronic and paper mail.
651
+
652
+ If the program does terminal interaction, make it output a short
653
+ notice like this when it starts in an interactive mode:
654
+
655
+ <program> Copyright (C) <year> <name of author>
656
+ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657
+ This is free software, and you are welcome to redistribute it
658
+ under certain conditions; type `show c' for details.
659
+
660
+ The hypothetical commands `show w' and `show c' should show the appropriate
661
+ parts of the General Public License. Of course, your program's commands
662
+ might be different; for a GUI interface, you would use an "about box".
663
+
664
+ You should also get your employer (if you work as a programmer) or school,
665
+ if any, to sign a "copyright disclaimer" for the program, if necessary.
666
+ For more information on this, and how to apply and follow the GNU GPL, see
667
+ <https://www.gnu.org/licenses/>.
668
+
669
+ The GNU General Public License does not permit incorporating your program
670
+ into proprietary programs. If your program is a subroutine library, you
671
+ may consider it more useful to permit linking proprietary applications with
672
+ the library. If this is what you want to do, use the GNU Lesser General
673
+ Public License instead of this License. But first, please read
674
+ <https://www.gnu.org/licenses/why-not-lgpl.html>.
cli/.gitignore ADDED
@@ -0,0 +1,24 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
2
+
3
+ # dependencies
4
+ /node_modules
5
+ /.pnp
6
+ .pnp.js
7
+
8
+ # testing
9
+ /coverage
10
+
11
+ # production
12
+ /build
13
+
14
+ # misc
15
+ .DS_Store
16
+ *.pem
17
+
18
+ # debug
19
+ npm-debug.log*
20
+ yarn-debug.log*
21
+ yarn-error.log*
22
+ .pnpm-debug.log*
23
+
24
+ .eslintcache
cli/README.md ADDED
@@ -0,0 +1,27 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ## AgentGPT CLI
2
+
3
+ AgentGPT CLI is a utility designed to streamline the setup process of your AgentGPT environment.
4
+ It uses Inquirer to interactively build up ENV values while also validating they are correct.
5
+
6
+ This was first created by @JPDucky on GitHub.
7
+
8
+ ### Running the tool
9
+
10
+ ```
11
+ // Running from the root of the project
12
+ ./setup.sh
13
+ ```
14
+
15
+ ```
16
+ // Running from the cli directory
17
+ cd cli/
18
+ npm run start
19
+ ```
20
+
21
+ ### Updating ENV values
22
+
23
+ To update ENV values:
24
+
25
+ - Add a question to the list of questions in `index.js` for the ENV value
26
+ - Add a value in the `envDefinition` for the ENV value
27
+ - Add the ENV value to the `.env.example` in the root of the project
cli/package-lock.json ADDED
The diff for this file is too large to render. See raw diff
 
cli/package.json ADDED
@@ -0,0 +1,32 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "name": "agentgpt-cli",
3
+ "version": "1.0.0",
4
+ "description": "A CLI to create your AgentGPT environment",
5
+ "private": true,
6
+ "engines": {
7
+ "node": ">=18.0.0 <19.0.0"
8
+ },
9
+ "type": "module",
10
+ "main": "index.js",
11
+ "scripts": {
12
+ "start": "node src/index.js",
13
+ "dev": "node src/index.js"
14
+ },
15
+ "author": "reworkd",
16
+ "dependencies": {
17
+ "@octokit/auth-basic": "^1.4.8",
18
+ "@octokit/rest": "^20.0.2",
19
+ "chalk": "^5.3.0",
20
+ "clear": "^0.1.0",
21
+ "clui": "^0.3.6",
22
+ "configstore": "^6.0.0",
23
+ "dotenv": "^16.3.1",
24
+ "figlet": "^1.7.0",
25
+ "inquirer": "^9.2.12",
26
+ "lodash": "^4.17.21",
27
+ "minimist": "^1.2.8",
28
+ "node-fetch": "^3.3.2",
29
+ "simple-git": "^3.20.0",
30
+ "touch": "^3.1.0"
31
+ }
32
+ }
cli/src/envGenerator.js ADDED
@@ -0,0 +1,142 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ import crypto from "crypto";
2
+ import fs from "fs";
3
+ import chalk from "chalk";
4
+
5
+ export const generateEnv = (envValues) => {
6
+ let isDockerCompose = envValues.runOption === "docker-compose";
7
+ let dbPort = isDockerCompose ? 3307 : 3306;
8
+ let platformUrl = isDockerCompose
9
+ ? "http://host.docker.internal:8000"
10
+ : "http://localhost:8000";
11
+
12
+ const envDefinition = getEnvDefinition(
13
+ envValues,
14
+ isDockerCompose,
15
+ dbPort,
16
+ platformUrl
17
+ );
18
+
19
+ const envFileContent = generateEnvFileContent(envDefinition);
20
+ saveEnvFile(envFileContent);
21
+ };
22
+
23
+ const getEnvDefinition = (envValues, isDockerCompose, dbPort, platformUrl) => {
24
+ return {
25
+ "Deployment Environment": {
26
+ NODE_ENV: "development",
27
+ NEXT_PUBLIC_VERCEL_ENV: "${NODE_ENV}",
28
+ },
29
+ NextJS: {
30
+ NEXT_PUBLIC_BACKEND_URL: "http://localhost:8000",
31
+ NEXT_PUBLIC_MAX_LOOPS: 100,
32
+ },
33
+ "Next Auth config": {
34
+ NEXTAUTH_SECRET: generateAuthSecret(),
35
+ NEXTAUTH_URL: "http://localhost:3000",
36
+ },
37
+ "Auth providers (Use if you want to get out of development mode sign-in)": {
38
+ GOOGLE_CLIENT_ID: "***",
39
+ GOOGLE_CLIENT_SECRET: "***",
40
+ GITHUB_CLIENT_ID: "***",
41
+ GITHUB_CLIENT_SECRET: "***",
42
+ DISCORD_CLIENT_SECRET: "***",
43
+ DISCORD_CLIENT_ID: "***",
44
+ },
45
+ Backend: {
46
+ REWORKD_PLATFORM_ENVIRONMENT: "${NODE_ENV}",
47
+ REWORKD_PLATFORM_FF_MOCK_MODE_ENABLED: false,
48
+ REWORKD_PLATFORM_MAX_LOOPS: "${NEXT_PUBLIC_MAX_LOOPS}",
49
+ REWORKD_PLATFORM_OPENAI_API_KEY:
50
+ envValues.OpenAIApiKey || '"<change me>"',
51
+ REWORKD_PLATFORM_FRONTEND_URL: "http://localhost:3000",
52
+ REWORKD_PLATFORM_RELOAD: true,
53
+ REWORKD_PLATFORM_OPENAI_API_BASE: "https://api.openai.com/v1",
54
+ REWORKD_PLATFORM_SERP_API_KEY: envValues.serpApiKey || '""',
55
+ REWORKD_PLATFORM_REPLICATE_API_KEY: envValues.replicateApiKey || '""',
56
+ },
57
+ "Database (Backend)": {
58
+ REWORKD_PLATFORM_DATABASE_USER: "reworkd_platform",
59
+ REWORKD_PLATFORM_DATABASE_PASSWORD: "reworkd_platform",
60
+ REWORKD_PLATFORM_DATABASE_HOST: "agentgpt_db",
61
+ REWORKD_PLATFORM_DATABASE_PORT: dbPort,
62
+ REWORKD_PLATFORM_DATABASE_NAME: "reworkd_platform",
63
+ REWORKD_PLATFORM_DATABASE_URL:
64
+ "mysql://${REWORKD_PLATFORM_DATABASE_USER}:${REWORKD_PLATFORM_DATABASE_PASSWORD}@${REWORKD_PLATFORM_DATABASE_HOST}:${REWORKD_PLATFORM_DATABASE_PORT}/${REWORKD_PLATFORM_DATABASE_NAME}",
65
+ },
66
+ "Database (Frontend)": {
67
+ DATABASE_USER: "reworkd_platform",
68
+ DATABASE_PASSWORD: "reworkd_platform",
69
+ DATABASE_HOST: "agentgpt_db",
70
+ DATABASE_PORT: dbPort,
71
+ DATABASE_NAME: "reworkd_platform",
72
+ DATABASE_URL:
73
+ "mysql://${DATABASE_USER}:${DATABASE_PASSWORD}@${DATABASE_HOST}:${DATABASE_PORT}/${DATABASE_NAME}",
74
+ },
75
+ };
76
+ };
77
+
78
+ const generateEnvFileContent = (config) => {
79
+ let configFile = "";
80
+
81
+ Object.entries(config).forEach(([section, variables]) => {
82
+ configFile += `# ${section}:\n`;
83
+ Object.entries(variables).forEach(([key, value]) => {
84
+ configFile += `${key}=${value}\n`;
85
+ });
86
+ configFile += "\n";
87
+ });
88
+
89
+ return configFile.trim();
90
+ };
91
+
92
+ const generateAuthSecret = () => {
93
+ const length = 32;
94
+ const buffer = crypto.randomBytes(length);
95
+ return buffer.toString("base64");
96
+ };
97
+
98
+ const ENV_PATH = "../next/.env";
99
+ const BACKEND_ENV_PATH = "../platform/.env";
100
+
101
+ export const doesEnvFileExist = () => {
102
+ return fs.existsSync(ENV_PATH);
103
+ };
104
+
105
+ // Read the existing env file, test if it is missing any keys or contains any extra keys
106
+ export const testEnvFile = () => {
107
+ const data = fs.readFileSync(ENV_PATH, "utf8");
108
+
109
+ // Make a fake definition to compare the keys of
110
+ const envDefinition = getEnvDefinition({}, "", "", "", "");
111
+
112
+ const lines = data
113
+ .split("\n")
114
+ .filter((line) => !line.startsWith("#") && line.trim() !== "");
115
+ const envKeysFromFile = lines.map((line) => line.split("=")[0]);
116
+
117
+ const envKeysFromDef = Object.entries(envDefinition).flatMap(
118
+ ([section, entries]) => Object.keys(entries)
119
+ );
120
+
121
+ const missingFromFile = envKeysFromDef.filter(
122
+ (key) => !envKeysFromFile.includes(key)
123
+ );
124
+
125
+ if (missingFromFile.length > 0) {
126
+ let errorMessage = "\nYour ./next/.env is missing the following keys:\n";
127
+ missingFromFile.forEach((key) => {
128
+ errorMessage += chalk.whiteBright(`- ❌ ${key}\n`);
129
+ });
130
+ errorMessage += "\n";
131
+
132
+ errorMessage += chalk.red(
133
+ "We recommend deleting your .env file(s) and restarting this script."
134
+ );
135
+ throw new Error(errorMessage);
136
+ }
137
+ };
138
+
139
+ export const saveEnvFile = (envFileContent) => {
140
+ fs.writeFileSync(ENV_PATH, envFileContent);
141
+ fs.writeFileSync(BACKEND_ENV_PATH, envFileContent);
142
+ };
cli/src/helpers.js ADDED
@@ -0,0 +1,26 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ import chalk from "chalk";
2
+ import figlet from "figlet";
3
+
4
+ export const printTitle = () => {
5
+ console.log(
6
+ chalk.red(
7
+ figlet.textSync("AgentGPT", {
8
+ horizontalLayout: "full",
9
+ font: "ANSI Shadow",
10
+ })
11
+ )
12
+ );
13
+ console.log(
14
+ "Welcome to the AgentGPT CLI! This CLI will generate the required .env files."
15
+ );
16
+ console.log(
17
+ "Copies of the generated envs will be created in `./next/.env` and `./platform/.env`.\n"
18
+ );
19
+ };
20
+
21
+ // Function to check if entered api key is in the correct format or empty
22
+ export const isValidKey = (apikey, pattern) => {
23
+ return (apikey === "" || pattern.test(apikey))
24
+ };
25
+
26
+ export const validKeyErrorMessage = "\nInvalid api key. Please try again."
cli/src/index.js ADDED
@@ -0,0 +1,60 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ import inquirer from "inquirer";
2
+ import dotenv from "dotenv";
3
+ import { printTitle } from "./helpers.js";
4
+ import { doesEnvFileExist, generateEnv, testEnvFile } from "./envGenerator.js";
5
+ import { newEnvQuestions } from "./questions/newEnvQuestions.js";
6
+ import { existingEnvQuestions } from "./questions/existingEnvQuestions.js";
7
+ import { spawn } from "child_process";
8
+ import chalk from "chalk";
9
+
10
+ const handleExistingEnv = () => {
11
+ console.log(chalk.yellow("Existing ./next/env file found. Validating..."));
12
+
13
+ try {
14
+ testEnvFile();
15
+ } catch (e) {
16
+ console.log(e.message);
17
+ return;
18
+ }
19
+
20
+ inquirer.prompt(existingEnvQuestions).then((answers) => {
21
+ handleRunOption(answers.runOption);
22
+ });
23
+ };
24
+
25
+ const handleNewEnv = () => {
26
+ inquirer.prompt(newEnvQuestions).then((answers) => {
27
+ dotenv.config({ path: "./.env" });
28
+ generateEnv(answers);
29
+ console.log("\nEnv files successfully created!");
30
+ handleRunOption(answers.runOption);
31
+ });
32
+ };
33
+
34
+ const handleRunOption = (runOption) => {
35
+ if (runOption === "docker-compose") {
36
+ const dockerComposeUp = spawn("docker-compose", ["up", "--build"], {
37
+ stdio: "inherit",
38
+ });
39
+ }
40
+
41
+ if (runOption === "manual") {
42
+ console.log(
43
+ "Please go into the ./next folder and run `npm install && npm run dev`."
44
+ );
45
+ console.log(
46
+ "Please also go into the ./platform folder and run `poetry install && poetry run python -m reworkd_platform`."
47
+ );
48
+ console.log(
49
+ "Please use or update the MySQL database configuration in the env file(s)."
50
+ );
51
+ }
52
+ };
53
+
54
+ printTitle();
55
+
56
+ if (doesEnvFileExist()) {
57
+ handleExistingEnv();
58
+ } else {
59
+ handleNewEnv();
60
+ }
cli/src/questions/existingEnvQuestions.js ADDED
@@ -0,0 +1,5 @@
 
 
 
 
 
 
1
+ import { RUN_OPTION_QUESTION } from "./sharedQuestions.js";
2
+
3
+ export const existingEnvQuestions = [
4
+ RUN_OPTION_QUESTION
5
+ ];
cli/src/questions/newEnvQuestions.js ADDED
@@ -0,0 +1,87 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ import { isValidKey, validKeyErrorMessage } from "../helpers.js";
2
+ import { RUN_OPTION_QUESTION } from "./sharedQuestions.js";
3
+ import fetch from "node-fetch";
4
+
5
+ export const newEnvQuestions = [
6
+ RUN_OPTION_QUESTION,
7
+ {
8
+ type: "input",
9
+ name: "OpenAIApiKey",
10
+ message:
11
+ "Enter your openai key (eg: sk...) or press enter to continue with no key:",
12
+ validate: async(apikey) => {
13
+ if(apikey === "") return true;
14
+
15
+ if(!isValidKey(apikey, /^sk-[a-zA-Z0-9]{48}$/)) {
16
+ return validKeyErrorMessage
17
+ }
18
+
19
+ const endpoint = "https://api.openai.com/v1/models"
20
+ const response = await fetch(endpoint, {
21
+ headers: {
22
+ "Authorization": `Bearer ${apikey}`,
23
+ },
24
+ });
25
+ if(!response.ok) {
26
+ return validKeyErrorMessage
27
+ }
28
+
29
+ return true
30
+ },
31
+ },
32
+ {
33
+ type: "input",
34
+ name: "serpApiKey",
35
+ message:
36
+ "What is your SERP API key (https://serper.dev/)? Leave empty to disable web search.",
37
+ validate: async(apikey) => {
38
+ if(apikey === "") return true;
39
+
40
+ if(!isValidKey(apikey, /^[a-zA-Z0-9]{40}$/)) {
41
+ return validKeyErrorMessage
42
+ }
43
+
44
+ const endpoint = "https://google.serper.dev/search"
45
+ const response = await fetch(endpoint, {
46
+ method: 'POST',
47
+ headers: {
48
+ "X-API-KEY": apikey,
49
+ "Content-Type": "application/json",
50
+ },
51
+ body: JSON.stringify({
52
+ "q": "apple inc"
53
+ }),
54
+ });
55
+ if(!response.ok) {
56
+ return validKeyErrorMessage
57
+ }
58
+
59
+ return true
60
+ },
61
+ },
62
+ {
63
+ type: "input",
64
+ name: "replicateApiKey",
65
+ message:
66
+ "What is your Replicate API key (https://replicate.com/)? Leave empty to just use DALL-E for image generation.",
67
+ validate: async(apikey) => {
68
+ if(apikey === "") return true;
69
+
70
+ if(!isValidKey(apikey, /^r8_[a-zA-Z0-9]{37}$/)) {
71
+ return validKeyErrorMessage
72
+ }
73
+
74
+ const endpoint = "https://api.replicate.com/v1/models/replicate/hello-world"
75
+ const response = await fetch(endpoint, {
76
+ headers: {
77
+ "Authorization": `Token ${apikey}`,
78
+ },
79
+ });
80
+ if(!response.ok) {
81
+ return validKeyErrorMessage
82
+ }
83
+
84
+ return true
85
+ },
86
+ },
87
+ ];
cli/src/questions/sharedQuestions.js ADDED
@@ -0,0 +1,10 @@
 
 
 
 
 
 
 
 
 
 
 
1
+ export const RUN_OPTION_QUESTION = {
2
+ type: 'list',
3
+ name: 'runOption',
4
+ choices: [
5
+ { value: "docker-compose", name: "🐋 Docker-compose (Recommended)" },
6
+ { value: "manual", name: "💪 Manual (Not recommended)" },
7
+ ],
8
+ message: 'How will you be running AgentGPT?',
9
+ default: "docker-compose",
10
+ }
cli/tsconfig.json ADDED
@@ -0,0 +1,115 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "compilerOptions": {
3
+ /* Visit https://aka.ms/tsconfig to read more about this file */
4
+
5
+ /* Projects */
6
+ // "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
7
+ // "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */
8
+ // "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */
9
+ // "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */
10
+ // "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */
11
+ // "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */
12
+
13
+ /* Language and Environment */
14
+ "target": "es2016",
15
+ /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
16
+ // "src": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
17
+ // "jsx": "preserve", /* Specify what JSX code is generated. */
18
+ // "experimentalDecorators": true, /* Enable experimental support for legacy experimental decorators. */
19
+ // "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
20
+ // "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
21
+ // "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
22
+ // "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
23
+ // "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
24
+ // "noLib": true, /* Disable including any library files, including the default src.d.ts. */
25
+ // "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */
26
+ // "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */
27
+
28
+ /* Modules */
29
+ "module": "commonjs",
30
+ /* Specify what module code is generated. */
31
+ // "rootDir": "./", /* Specify the root folder within your source files. */
32
+ // "moduleResolution": "node10", /* Specify how TypeScript looks up a file from a given module specifier. */
33
+ // "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
34
+ // "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
35
+ // "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
36
+ // "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */
37
+ // "types": [], /* Specify type package names to be included without being referenced in a source file. */
38
+ // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
39
+ // "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */
40
+ // "allowImportingTsExtensions": true, /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
41
+ // "resolvePackageJsonExports": true, /* Use the package.json 'exports' field when resolving package imports. */
42
+ // "resolvePackageJsonImports": true, /* Use the package.json 'imports' field when resolving imports. */
43
+ // "customConditions": [], /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
44
+ // "resolveJsonModule": true, /* Enable importing .json files. */
45
+ // "allowArbitraryExtensions": true, /* Enable importing files with any extension, provided a declaration file is present. */
46
+ // "noResolve": true, /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
47
+
48
+ /* JavaScript Support */
49
+ // "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
50
+ // "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */
51
+ // "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
52
+
53
+ /* Emit */
54
+ // "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
55
+ // "declarationMap": true, /* Create sourcemaps for d.ts files. */
56
+ // "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
57
+ // "sourceMap": true, /* Create source map files for emitted JavaScript files. */
58
+ // "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
59
+ // "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
60
+ // "outDir": "./", /* Specify an output folder for all emitted files. */
61
+ // "removeComments": true, /* Disable emitting comments. */
62
+ // "noEmit": true, /* Disable emitting files from a compilation. */
63
+ // "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
64
+ // "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */
65
+ // "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
66
+ // "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */
67
+ // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
68
+ // "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */
69
+ // "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
70
+ // "newLine": "crlf", /* Set the newline character for emitting files. */
71
+ // "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
72
+ // "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */
73
+ // "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */
74
+ // "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */
75
+ // "declarationDir": "./", /* Specify the output directory for generated declaration files. */
76
+ // "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
77
+
78
+ /* Interop Constraints */
79
+ // "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */
80
+ // "verbatimModuleSyntax": true, /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
81
+ // "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
82
+ "esModuleInterop": true,
83
+ /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
84
+ // "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
85
+ "forceConsistentCasingInFileNames": true,
86
+ /* Ensure that casing is correct in imports. */
87
+
88
+ /* Type Checking */
89
+ "strict": true,
90
+ /* Enable all strict type-checking options. */
91
+ // "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */
92
+ // "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */
93
+ // "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
94
+ // "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
95
+ // "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
96
+ // "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */
97
+ // "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */
98
+ // "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
99
+ // "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */
100
+ // "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */
101
+ // "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
102
+ // "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */
103
+ // "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */
104
+ // "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */
105
+ // "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */
106
+ // "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */
107
+ // "allowUnusedLabels": true, /* Disable error reporting for unused labels. */
108
+ // "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */
109
+
110
+ /* Completeness */
111
+ // "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
112
+ "skipLibCheck": true
113
+ /* Skip type checking all .d.ts files. */
114
+ }
115
+ }
db/Dockerfile ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ FROM mysql:8.0
2
+
3
+ ADD setup.sql /docker-entrypoint-initdb.d
db/setup.sql ADDED
@@ -0,0 +1,11 @@
 
 
 
 
 
 
 
 
 
 
 
 
1
+ -- Prisma requires DB creation privileges to create a shadow database (https://pris.ly/d/migrate-shadow)
2
+ -- This is not available to our user by default, so we must manually add this
3
+
4
+ -- Create the user
5
+ CREATE USER IF NOT EXISTS 'reworkd_platform'@'%' IDENTIFIED BY 'reworkd_platform';
6
+
7
+ -- Grant the necessary permissions
8
+ GRANT CREATE, ALTER, DROP, INSERT, UPDATE, DELETE, SELECT ON *.* TO 'reworkd_platform'@'%';
9
+
10
+ -- Apply the changes
11
+ FLUSH PRIVILEGES;
docker-compose.yml ADDED
@@ -0,0 +1,58 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ version: '3.9'
2
+
3
+ services:
4
+ frontend:
5
+ container_name: frontend
6
+ build:
7
+ context: ./next
8
+ dockerfile: Dockerfile
9
+ ports:
10
+ - "3000:3000"
11
+ volumes:
12
+ - ./next/.env:/next/.env
13
+ - ./next/:/next/
14
+ - /next/node_modules
15
+ - /next/.next
16
+
17
+ platform:
18
+ container_name: platform
19
+ build:
20
+ context: ./platform
21
+ target: prod
22
+ ports:
23
+ - "8000:8000"
24
+ restart: always
25
+ volumes:
26
+ - ./platform:/app/src/
27
+ env_file:
28
+ - next/.env
29
+ environment:
30
+ REWORKD_PLATFORM_HOST: 0.0.0.0
31
+ REWORKD_PLATFORM_DB_HOST: agentgpt_db
32
+ REWORKD_PLATFORM_DB_PORT: "3307"
33
+ REWORKD_PLATFORM_DB_USER: "reworkd_platform"
34
+ REWORKD_PLATFORM_DB_PASS: "reworkd_platform"
35
+ REWORKD_PLATFORM_DB_BASE: "reworkd_platform"
36
+ depends_on:
37
+ - agentgpt_db
38
+
39
+ agentgpt_db:
40
+ image: mysql:8.0
41
+ container_name: agentgpt_db
42
+ restart: always
43
+ build:
44
+ context: ./db
45
+ ports:
46
+ - "3308:3307"
47
+ environment:
48
+ MYSQL_DATABASE: "reworkd_platform"
49
+ MYSQL_USER: "reworkd_platform"
50
+ MYSQL_PASSWORD: "reworkd_platform"
51
+ MYSQL_ROOT_PASSWORD: "reworkd_platform"
52
+ MYSQL_TCP_PORT: 3307
53
+ volumes:
54
+ - agentgpt_db:/var/lib/mysql
55
+ command: [ 'mysqld', '--character-set-server=utf8mb4', '--collation-server=utf8mb4_unicode_ci' ]
56
+
57
+ volumes:
58
+ agentgpt_db:
docs/README.hu-Cs4K1Sr4C.md ADDED
@@ -0,0 +1,235 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ <p align="center">
2
+ <img src="https://raw.githubusercontent.com/reworkd/AgentGPT/main/public/banner.png?token=GHSAT0AAAAAAB7JND3U3VGGF3UYYHGYO4RAZBSDJAQ" height="300"/>
3
+ </p>
4
+ <p align="center">
5
+ <em>🤖 Szerelje össze, konfigurálja és telepítse az autonóm AI-ügynököket a böngészőjében. 🤖 </em>
6
+ </p>
7
+ <p align="center">
8
+ <img alt="Node version" src="https://img.shields.io/static/v1?label=node&message=%20%3E=16.0.0&logo=node.js&color=2334D058" />
9
+ <a href="https://github.com/reworkd/AgentGPT/blob/master/README.md"><img src="https://img.shields.io/badge/lang-English-blue.svg" alt="English"></a>
10
+ <a href="https://github.com/reworkd/AgentGPT/blob/master/docs/README.zh-HANS.md"><img src="https://img.shields.io/badge/lang-简体中文-red.svg" alt="简体中文"></a>
11
+ <a href="https://github.com/reworkd/AgentGPT/blob/master/docs/README.hu-Cs4K1Sr4C.md"><img src="https://img.shields.io/badge/lang-Hungarian-red.svg" alt="Hungarian"></a>
12
+ </p>
13
+
14
+ <p align="center">
15
+ <a href="https://agentgpt.reworkd.ai">🔗 Weboldal</a>
16
+ <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
17
+ <a href="#-getting-started">🤝 Hozzájárulás</a>
18
+ <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
19
+ <a href="https://twitter.com/asimdotshrestha/status/1644883727707959296">🐦 Twitter</a>
20
+ <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
21
+ <a href="https://discord.gg/gcmNyAAFfV">📢 Discord</a>
22
+ </p>
23
+
24
+ ---
25
+
26
+ <h2 align="center">
27
+ 💝 Támogassa az AgentGPT fejlesztését!! 💝
28
+ </h2>
29
+
30
+ <p align="center">
31
+ Csatlakozzon hozzánk, az AgentGPT fejlesztéséhez, egy nyílt forráskódú projekthez, amely az AI automatizálás határait feszegeti! Kihívásokkal nézünk szembe a működési költségek fedezése 💸, beleértve a házon belüli API-t és egyéb infrastrukturális költségeket, amelyek az előrejelzések szerint körülbelül napi 150 USD-ra nőnek. 💳🤕 Az Ön szponzorálása elősegítené a fejlődést azáltal, hogy segít nekünk az erőforrások bővítésében, a funkciók és a funkcionalitás bővítésében, valamint az izgalmas projekt folytatásában! 🚀
32
+ </p>
33
+
34
+ <p align="center">
35
+ Ennek az ingyenes, nyílt forráskódú projektnek a szponzorálásával nem csak az avatarod/logódat láthatod alább, hanem exkluzív lehetőséget kapsz az alapítókkal való beszélgetésre is!🗣️
36
+ </p>
37
+
38
+ <p align="center">
39
+ <a href="https://github.com/sponsors/reworkd-admin">👉 Kattint ide</a> ha szeretnéd támogatni a projektet
40
+ </p>
41
+
42
+ <h3 align="center">
43
+ 🙌🏻 Szponzoraink 🙌🏻
44
+ </h3>
45
+
46
+ <div align="center" dir="auto">
47
+ <!-- sponsors --><a href="https://github.com/arthurbnhm"><img src="https://github.com/arthurbnhm.png" width="60px" alt="Arthur" /></a><a href="https://github.com/mrayonnaise"><img src="https://github.com/mrayonnaise.png" width="60px" alt="Matt Ray" /></a><a href="https://github.com/iv-ann"><img src="https://github.com/iv-ann.png" width="60px" alt="Ivan" /></a><a href="https://github.com/alex-shortt"><img src="https://github.com/alex-shortt.png" width="60px" alt="Alex Shortt" /></a><a href="https://github.com/echallenge"><img src="https://github.com/echallenge.png" width="60px" alt="eDad" /></a><a href="https://github.com/jd3655"><img src="https://github.com/jd3655.png" width="60px" alt="Vector Ventures" /></a><a href="https://github.com/PersonMan65"><img src="https://github.com/PersonMan65.png" width="60px" alt="" /></a><a href="https://github.com/peth-yursick"><img src="https://github.com/peth-yursick.png" width="60px" alt="" /></a><a href="https://github.com/durairajasivam"><img src="https://github.com/durairajasivam.png" width="60px" alt="" /></a><a href="https://github.com/floriank"><img src="https://github.com/floriank.png" width="60px" alt="Florian Kraft" /></a><a href="https://github.com/SicilianaTrevino"><img src="https://github.com/SicilianaTrevino.png" width="60px" alt="" /></a><a href="https://github.com/andrewpeluso"><img src="https://github.com/andrewpeluso.png" width="60px" alt="" /></a><a href="https://github.com/localecho"><img src="https://github.com/localecho.png" width="60px" alt="" /></a><a href="https://github.com/fireheat135"><img src="https://github.com/fireheat135.png" width="60px" alt="" /></a><a href="https://github.com/ashventure"><img src="https://github.com/ashventure.png" width="60px" alt="" /></a><a href="https://github.com/biolippi"><img src="https://github.com/biolippi.png" width="60px" alt="" /></a><a href="https://github.com/orkunisitmak"><img src="https://github.com/orkunisitmak.png" width="60px" alt="" /></a><a href="https://github.com/zoelidity"><img src="https://github.com/zoelidity.png" width="60px" alt="Zoe" /></a><a href="https://github.com/busseyl"><img src="https://github.com/busseyl.png" width="60px" alt="Lucas Bussey" /></a><a href="https://github.com/DuanChaori"><img src="https://github.com/DuanChaori.png" width="60px" alt="" /></a><a href="https://github.com/Faitltd"><img src="https://github.com/Faitltd.png" width="60px" alt="fAIt" /></a><a href="https://github.com/jukwaphil1"><img src="https://github.com/jukwaphil1.png" width="60px" alt="" /></a><a href="https://github.com/lisa-ee"><img src="https://github.com/lisa-ee.png" width="60px" alt="Lisa" /></a><a href="https://github.com/VulcanT"><img src="https://github.com/VulcanT.png" width="60px" alt="" /></a><a href="https://github.com/kman62"><img src="https://github.com/kman62.png" width="60px" alt="kmotte" /></a><a href="https://github.com/Haithamhaj"><img src="https://github.com/Haithamhaj.png" width="60px" alt="" /></a><a href="https://github.com/SwftCoins"><img src="https://github.com/SwftCoins.png" width="60px" alt="SWFT Blockchain" /></a><a href="https://github.com/ChevalierzA"><img src="https://github.com/ChevalierzA.png" width="60px" alt="" /></a><a href="https://github.com/research-developer"><img src="https://github.com/research-developer.png" width="60px" alt="" /></a><a href="https://github.com/Wetradetogether"><img src="https://github.com/Wetradetogether.png" width="60px" alt="Wetradetogether Corporation" /></a><a href="https://github.com/keanuhsieh"><img src="https://github.com/keanuhsieh.png" width="60px" alt="" /></a><a href="https://github.com/sorrynothing"><img src="https://github.com/sorrynothing.png" width="60px" alt="" /></a><a href="https://github.com/FelixAI2023"><img src="https://github.com/FelixAI2023.png" width="60px" alt="" /></a><a href="https://github.com/Mitchell-Coder-New"><img src="https://github.com/Mitchell-Coder-New.png" width="60px" alt="" /></a><a href="https://github.com/Xiaofeixiao0309"><img src="https://github.com/Xiaofeixiao0309.png" width="60px" alt="XIAO FEI" /></a><a href="https://github.com/jondwillis"><img src="https://github.com/jondwillis.png" width="60px" alt="jon" /></a><a href="https://github.com/mojosolo"><img src="https://github.com/mojosolo.png" width="60px" alt="MojoSolo" /></a><a href="https://github.com/Trecares"><img src="https://github.com/Trecares.png" width="60px" alt="" /></a><a href="https://github.com/nnkostov"><img src="https://github.com/nnkostov.png" width="60px" alt="Nikolay Kostov" /></a><a href="https://github.com/mfcolbrie"><img src="https://github.com/mfcolbrie.png" width="60px" alt="" /></a><a href="https://github.com/oryanmoshe"><img src="https://github.com/oryanmoshe.png" width="60px" alt="Oryan Moshe" /></a><a href="https://github.com/newjxmaster"><img src="https://github.com/newjxmaster.png" width="60px" alt="Napole" /></a><a href="https://github.com/jofe03"><img src="https://github.com/jofe03.png" width="60px" alt="" /></a><a href="https://github.com/DanielRobertKelly"><img src="https://github.com/DanielRobertKelly.png" width="60px" alt="" /></a><a href="https://github.com/genetrader"><img src="https://github.com/genetrader.png" width="60px" alt="Gene Waxman" /></a><a href="https://github.com/NerdDeWallStreet"><img src="https://github.com/NerdDeWallStreet.png" width="60px" alt="Nerd de Wall Street" /></a><a href="https://github.com/qwe777897"><img src="https://github.com/qwe777897.png" width="60px" alt="" /></a><a href="https://github.com/tudorw"><img src="https://github.com/tudorw.png" width="60px" alt="Tudor Watson" /></a><a href="https://github.com/ClayNelson"><img src="https://github.com/ClayNelson.png" width="60px" alt="Clay Nelson" /></a><a href="https://github.com/johnopaluwa"><img src="https://github.com/johnopaluwa.png" width="60px" alt="Opaluwa John" /></a><a href="https://github.com/Mamadouff"><img src="https://github.com/Mamadouff.png" width="60px" alt="" /></a><a href="https://github.com/xuxizhen"><img src="https://github.com/xuxizhen.png" width="60px" alt="xizhen" /></a><a href="https://github.com/ShamrockYuma"><img src="https://github.com/ShamrockYuma.png" width="60px" alt="Elizabeth" /></a><a href="https://github.com/thecatfix"><img src="https://github.com/thecatfix.png" width="60px" alt="John Shelburne" /></a><a href="https://github.com/18900775855"><img src="https://github.com/18900775855.png" width="60px" alt="bin" /></a><a href="https://github.com/destro225"><img src="https://github.com/destro225.png" width="60px" alt="" /></a><a href="https://github.com/0xmatchmaker"><img src="https://github.com/0xmatchmaker.png" width="60px" alt="0xmatchmaker" /></a><a href="https://github.com/dray3310"><img src="https://github.com/dray3310.png" width="60px" alt="" /></a><a href="https://github.com/mgesteban"><img src="https://github.com/mgesteban.png" width="60px" alt="Grace Esteban" /></a><a href="https://github.com/fegodi"><img src="https://github.com/fegodi.png" width="60px" alt="" /></a><a href="https://github.com/kylburns89"><img src="https://github.com/kylburns89.png" width="60px" alt="" /></a><a href="https://github.com/Ademrobert"><img src="https://github.com/Ademrobert.png" width="60px" alt="Adem Ottoman" /></a><a href="https://github.com/mouhaxp"><img src="https://github.com/mouhaxp.png" width="60px" alt="" /></a><a href="https://github.com/carlosbartolomeu"><img src="https://github.com/carlosbartolomeu.png" width="60px" alt="" /></a><a href="https://github.com/Zoffra1984"><img src="https://github.com/Zoffra1984.png" width="60px" alt="" /></a><a href="https://github.com/Agronobeetles"><img src="https://github.com/Agronobeetles.png" width="60px" alt="" /></a><a href="https://github.com/CloudyGuyThompson"><img src="https://github.com/CloudyGuyThompson.png" width="60px" alt="Guy Thompson" /></a><a href="https://github.com/rocogirl-jp"><img src="https://github.com/rocogirl-jp.png" width="60px" alt="" /></a><a href="https://github.com/Jhonvolt17"><img src="https://github.com/Jhonvolt17.png" width="60px" alt="" /></a><a href="https://github.com/koltziver"><img src="https://github.com/koltziver.png" width="60px" alt="" /></a><a href="https://github.com/meeuwsstefaan"><img src="https://github.com/meeuwsstefaan.png" width="60px" alt="Stefaan Meeuws" /></a><a href="https://github.com/sirswali"><img src="https://github.com/sirswali.png" width="60px" alt="Vusi Dube" /></a><a href="https://github.com/Tweezamiza"><img src="https://github.com/Tweezamiza.png" width="60px" alt="" /></a><a href="https://github.com/Kenono2000"><img src="https://github.com/Kenono2000.png" width="60px" alt="Ken Wong" /></a><a href="https://github.com/QuickBenx"><img src="https://github.com/QuickBenx.png" width="60px" alt="" /></a><a href="https://github.com/ouguajian"><img src="https://github.com/ouguajian.png" width="60px" alt="" /></a><a href="https://github.com/DixonFyre"><img src="https://github.com/DixonFyre.png" width="60px" alt="" /></a><a href="https://github.com/ospl99"><img src="https://github.com/ospl99.png" width="60px" alt="" /></a><a href="https://github.com/bbookser"><img src="https://github.com/bbookser.png" width="60px" alt="Bradford Bookser" /></a><a href="https://github.com/abhirichster"><img src="https://github.com/abhirichster.png" width="60px" alt="" /></a><a href="https://github.com/SwingPoint"><img src="https://github.com/SwingPoint.png" width="60px" alt="" /></a><a href="https://github.com/jenius-eagle"><img src="https://github.com/jenius-eagle.png" width="60px" alt="" /></a><a href="https://github.com/CubanCongaMan"><img src="https://github.com/CubanCongaMan.png" width="60px" alt="Roberto Luis Sanchez, P.E., P.G.; D,GE; F.ASCE" /></a><a href="https://github.com/cskrobec"><img src="https://github.com/cskrobec.png" width="60px" alt="" /></a><a href="https://github.com/Jahmazon"><img src="https://github.com/Jahmazon.png" width="60px" alt="" /></a><a href="https://github.com/jackPan010203"><img src="https://github.com/jackPan010203.png" width="60px" alt="" /></a><a href="https://github.com/pmespresso"><img src="https://github.com/pmespresso.png" width="60px" alt="πisk0mate" /></a><a href="https://github.com/itbc2004"><img src="https://github.com/itbc2004.png" width="60px" alt="" /></a><a href="https://github.com/ISDAworld"><img src="https://github.com/ISDAworld.png" width="60px" alt="David Gammond" /></a><a href="https://github.com/mattlwaters"><img src="https://github.com/mattlwaters.png" width="60px" alt="" /></a><a href="https://github.com/Stargard"><img src="https://github.com/Stargard.png" width="60px" alt="" /></a><a href="https://github.com/lazzacapital"><img src="https://github.com/lazzacapital.png" width="60px" alt="Lazza Capital" /></a><a href="https://github.com/MichaelRDionne"><img src="https://github.com/MichaelRDionne.png" width="60px" alt="Michael R Dionne" /></a><a href="https://github.com/nilotpalc"><img src="https://github.com/nilotpalc.png" width="60px" alt="Nilotpal Choudhury" /></a><a href="https://github.com/FrankyPete"><img src="https://github.com/FrankyPete.png" width="60px" alt="" /></a><a href="https://github.com/TylerrDurden1979"><img src="https://github.com/TylerrDurden1979.png" width="60px" alt="" /></a><a href="https://github.com/OptionalJoystick"><img src="https://github.com/OptionalJoystick.png" width="60px" alt="" /></a><a href="https://github.com/PaulV27"><img src="https://github.com/PaulV27.png" width="60px" alt="" /></a><a href="https://github.com/rodolfoguzzi"><img src="https://github.com/rodolfoguzzi.png" width="60px" alt="" /></a><a href="https://github.com/bluecat2210"><img src="https://github.com/bluecat2210.png" width="60px" alt="" /></a><!-- sponsors -->
48
+
49
+ </div>
50
+
51
+ ---
52
+
53
+ Az AgentGPT lehetővé teszi az automatizált AI-ügynökök konfigurálását és üzembe helyezését.
54
+ Nevezze el saját egyéni mesterséges intelligenciáját, és tegye lehetővé, hogy bármilyen célt elérjen.
55
+ Megkísérli elérni a célt az elvégzendő feladatok átgondolásával, végrehajtásával és az eredményekből való tanulással 🚀.
56
+
57
+ ## 🎉 Útiterv
58
+
59
+ Ez a platform jelenleg béta állapotban van és a következőkön dolgozunk:
60
+
61
+ - Hosszú távú memória vektoros DB-n keresztül 🧠
62
+ - Webböngészési lehetőségek a LangChain-en keresztül 🌐
63
+ - Interakció webhelyekkel és emberekkel 👨‍👩‍👦
64
+ - Írási lehetőségek egy dokumentum API-n keresztül 📄
65
+ - Az AI-ügynökök mentése 💾
66
+ - Felhasználók és hitelesítés 🔐
67
+ - Stripe integráció egy alsó limites fizetős verzióhoz (hogy ne aggódjunk az infra költségek miatt) 💵
68
+
69
+ Hamarosan még több jön...
70
+
71
+ ## 🚀 Tech Stack
72
+
73
+ - ✅ **Bootstrapping**: [create-t3-app](https://create.t3.gg).
74
+ - ✅ **Framework**: [Nextjs 13 + Typescript](https://nextjs.org/).
75
+ - ✅ **Auth**: [Next-Auth.js](https://next-auth.js.org)
76
+ - ✅ **ORM**: [Prisma](https://prisma.io).
77
+ - ✅ **Database**: [Supabase](https://supabase.com/).
78
+ - ✅ **Styling**: [TailwindCSS + HeadlessUI](https://tailwindcss.com).
79
+ - ✅ **Typescript Schema Validation**: [Zod](https://github.com/colinhacks/zod).
80
+ - ✅ **End-to-end typesafe API**: [tRPC](https://trpc.io/).
81
+
82
+ ## 👨‍🚀 Első lépések
83
+
84
+ ### 🐳 Docker beállítása
85
+
86
+ Az AgentGPT helyi futtatásának legegyszerűbb módja a Docker használata.
87
+ Egy kényelmes beállítási szkriptet biztosítunk az induláshoz.
88
+
89
+ ```bash
90
+ ./setup.sh --docker
91
+ ```
92
+
93
+ ### 👷 Helyi fejlesztési beállítások
94
+
95
+ Ha helyben szeretné fejleszteni az Agent GPT-t, a legegyszerűbb módja a mellékelt telepítőszkript használata.
96
+
97
+ ```bash
98
+ ./setup.sh --local
99
+ ```
100
+
101
+ ### 🛠️ Manuális beállítás
102
+
103
+ > 🚧 Szüksége lesz a [Nodejs +18 (LTS recommended)](https://nodejs.org/en/) telepítésre.
104
+
105
+ 1. Elágaztatni a tárat
106
+
107
+ - [Elágaztatás](https://github.com/reworkd/AgentGPT/fork).
108
+
109
+ 2. Klónozni a tárolót:
110
+
111
+ ```bash
112
+ git clone [email protected]:YOU_USER/AgentGPT.git
113
+ ```
114
+
115
+ 3. Függőségek telepítése:
116
+
117
+ ```bash
118
+ cd AgentGPT
119
+ npm install
120
+ ```
121
+
122
+ 4. Hozzon létre egy **.env** fájlt a következő tartalommal:
123
+
124
+ > 🚧 A környezeti változóknak meg kell egyeznie a következő [sémával](https://github.com/reworkd/AgentGPT/blob/main/src/env/schema.mjs).
125
+
126
+ ```bash
127
+ # Telepítési környezet:
128
+ NODE_ENV=development
129
+
130
+ # Következő hitelesítési konfiguráció:
131
+ # Hozzon létre egy titkos kulcsot az `openssl rand -base64 32` paranccsal
132
+ NEXTAUTH_SECRET=VÁLTOZTASS_MEG
133
+ NEXTAUTH_URL=http://localhost:3000
134
+ DATABASE_URL=file:./db.sqlite
135
+
136
+ # OpenAI API kulcs
137
+ OPENAI_API_KEY=VÁLTOZTASS_MEG
138
+ ```
139
+
140
+ 5. Módosítsa a prisma sémát az sqlite használatához:
141
+
142
+ ```bash
143
+ ./prisma/useSqlite.sh
144
+ ```
145
+
146
+ **Megjegyzés:** Ezt csak akkor kell megtenni, ha sqlite-ot szeretne használni.
147
+
148
+ 6. Kész 🥳, következő a futtatás:
149
+
150
+ ```bash
151
+ # Adatbázis-migrálások létrehozása
152
+ npx prisma db push
153
+ npm run dev
154
+ ```
155
+
156
+ ### 🚀 GitHub Codespaces
157
+
158
+ Állítsa be azonnal az AgentGPT-t a felhőben a [GitHub Codespaces](https://github.com/features/codespaces) használatával.
159
+
160
+ 1. A GitHub-tárhelyen kattintson a zöld "Kód" gombra, és válassza a "Kódterek" lehetőséget.
161
+ 2. Hozzon létre egy új kódteret, vagy válasszon egy előzőt, amelyet már létrehozott.
162
+ 3. A kódtér külön lapon nyílik meg a böngészőben.
163
+ 4. A terminálban futtassa a `bash ./setup.sh --local` parancsot
164
+ 5. Amikor a terminál kéri, adja hozzá OpenAI API-kulcsát.
165
+ 6. Kattintson a "Megnyitás böngészőben" gombra, amikor az összeállítási folyamat befejeződött.
166
+
167
+ - Az AgentGPT leállításához írja be a Ctrl+C billentyűkombinációt a terminálba.
168
+ - Az AgentGPT újraindításához futtassa az "npm run dev" parancsot a terminálban.
169
+
170
+ Futtassa a projektet 🥳
171
+
172
+ ```
173
+ npm run dev
174
+ ```
175
+
176
+ ---
177
+
178
+ <h3 align="center">
179
+ 🙌🏻 További szponzoraink 🙌🏻
180
+ </h3>
181
+
182
+ <div align="center" dir="auto">
183
+ <a href="https://github.com/Trecares" style="display: inline-block; margin-right: 20px;">
184
+ <img src="https://github.com/Trecares.png" width="50px" alt="Trecares" style="max-width:100%;">
185
+ </a>
186
+ <a href="https://github.com/oryanmoshe" style="display: inline-block; margin-right: 20px;">
187
+ <img src="https://github.com/oryanmoshe.png" width="50px" alt="oryanmoshe" style="max-width:100%;">
188
+ </a>
189
+ <a href="https://github.com/rekimcn" style="display: inline-block; margin-right: 20px;">
190
+ <img src="https://github.com/rekimcn.png" width="50px" alt="rekimcn" style="max-width:100%;">
191
+ </a>
192
+ <a href="https://github.com/qwe777897" style="display: inline-block; margin-right: 20px;">
193
+ <img src="https://github.com/qwe777897.png" width="50px" alt="qwe777897" style="max-width:100%;">
194
+ </a>
195
+ <a href="https://github.com/ClayNelson" style="display: inline-block; margin-right: 20px;">
196
+ <img src="https://github.com/ClayNelson.png" width="50px" alt="ClayNelson" style="max-width:100%;">
197
+ </a>
198
+ <a href="https://github.com/xuxizhen" style="display: inline-block; margin-right: 20px;">
199
+ <img src="https://github.com/xuxizhen.png" width="50px" alt="xuxizhen" style="max-width:100%;">
200
+ </a>
201
+ <a href="https://github.com/destro225" style="display: inline-block; margin-right: 20px;">
202
+ <img src="https://github.com/destro225.png" width="50px" alt="destro225" style="max-width:100%;">
203
+ </a>
204
+ <a href="https://github.com/mouhaxp" style="display: inline-block; margin-right: 20px;">
205
+ <img src="https://github.com/mouhaxp.png" width="50px" alt="mouhaxp" style="max-width:100%;">
206
+ </a>
207
+ <a href="https://github.com/carlosbartolomeu" style="display: inline-block; margin-right: 20px;">
208
+ <img src="https://github.com/carlosbartolomeu.png" width="50px" alt="carlosbartolomeu" style="max-width:100%;">
209
+ </a>
210
+ <a href="https://github.com/Agronobeetles" style="display: inline-block; margin-right: 20px;">
211
+ <img src="https://github.com/Agronobeetles.png" width="50px" alt="Agronobeetles " style="max-width:100%;">
212
+ </a>
213
+ <a href="https://github.com/CloudyGuyThompson" style="display: inline-block; margin-right: 20px;">
214
+ <img src="https://github.com/CloudyGuyThompson.png" width="50px" alt="CloudyGuyThompson" style="max-width:100%;">
215
+ </a>
216
+ <a href="https://github.com/xinghz" style="display: inline-block; margin-right: 20px;">
217
+ <img src="https://github.com/xinghz.png" width="50px" alt="xinghz" style="max-width:100%;">
218
+ </a>
219
+ <a href="https://github.com/Jaimbart" style="display: inline-block; margin-right: 20px;">
220
+ <img src="https://github.com/Jaimbart.png" width="50px" alt="Jaimbart" style="max-width:100%;">
221
+ </a>
222
+ <a href="https://github.com/Jhonvolt17" style="display: inline-block; margin-right: 20px;">
223
+ <img src="https://github.com/Jhonvolt17.png" width="50px" alt="Jhonvolt17" style="max-width:100%;">
224
+ </a>
225
+ <a href="https://github.com/koltziver" style="display: inline-block; margin-right: 20px;">
226
+ <img src="https://github.com/koltziver.png" width="50px" alt="koltziver" style="max-width:100%;">
227
+ </a>
228
+ <a href="https://github.com/sirswali" style="display: inline-block; margin-right: 20px;">
229
+ <img src="https://github.com/sirswali.png" width="50px" alt="sirswali" style="max-width:100%;">
230
+ </a>
231
+ <a href="https://github.com/DixonFyre" style="display: inline-block; margin-right: 20px;">
232
+ <img src="https://github.com/DixonFyre.png" width="50px" alt="DixonFyre" style="max-width:100%;">
233
+ </a>
234
+
235
+ </div>
docs/README.md ADDED
File without changes
docs/README.zh-HANS.md ADDED
@@ -0,0 +1,127 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ <p align="center">
2
+ <img src="https://raw.githubusercontent.com/reworkd/AgentGPT/main/next/public/banner.png" height="300" alt="AgentGPT Logo"/>
3
+ </p>
4
+ <p align="center">
5
+ <em>🤖 组装,配置和部署自主的 AI 代理(只需浏览器) 🤖 </em>
6
+ </p>
7
+ <p align="center">
8
+ <img alt="Node version" src="https://img.shields.io/static/v1?label=node&message=%20%3E=18&logo=node.js&color=2334D058" />
9
+ <a href="https://github.com/reworkd/AgentGPT/blob/master/README.md"><img src="https://img.shields.io/badge/lang-English-blue.svg" alt="English"></a>
10
+ <a href="https://github.com/reworkd/AgentGPT/blob/master/docs/README.zh-HANS.md"><img src="https://img.shields.io/badge/lang-简体中文-red.svg" alt="简体中文"></a>
11
+ <a href="https://github.com/reworkd/AgentGPT/blob/master/docs/README.hu-Cs4K1Sr4C.md"><img src="https://img.shields.io/badge/lang-Hungarian-red.svg" alt="Hungarian"></a>
12
+ </p>
13
+
14
+ <p align="center">
15
+ <a href="https://agentgpt.reworkd.ai">🔗 短链接</a>
16
+ <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
17
+ <a href="https://docs.reworkd.ai/">📚 文档</a>
18
+ <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
19
+ <a href="https://docs.reworkd.ai/essentials/contributing">🤝 参与贡献</a>
20
+ <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
21
+ <a href="https://twitter.com/reworkdai">🐦 推特</a>
22
+ <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
23
+ <a href="https://discord.gg/gcmNyAAFfV">📢 Discord</a>
24
+ </p>
25
+
26
+ AgentGPT允许您配置和部署自主AI代理。
27
+ 为您自己的定制AI命名,并使其追求任何可以想象到的目标。
28
+ 它将通过思考要执行的任务、执行这些任务并从结果中学习来尝试实现目标🚀。
29
+
30
+ ---
31
+
32
+ ## ✨ 演示
33
+ 为了获得最佳的演示体验,请直接访问 [our site](https://agentgpt.reworkd.ai) :)
34
+
35
+ [Demo Video](https://github.com/reworkd/AgentGPT/assets/50181239/5348e44a-29a5-4280-a06b-fe1429a8d99e)
36
+
37
+
38
+ ## 👨‍🚀 开始使用
39
+
40
+ 使用AgentGPT的最简单方法是自动设置CLI,该CLI与项目捆绑在一起。
41
+ cli为AgentGPT设置了以下内容:
42
+ - 🔐 [Environment variables](https://github.com/reworkd/AgentGPT/blob/main/.env.example) (和 API 密钥)
43
+ - 🗂️ [Database](https://github.com/reworkd/AgentGPT/tree/main/db) (Mysql)
44
+ - 🤖 [Backend](https://github.com/reworkd/AgentGPT/tree/main/platform) (FastAPI)
45
+ - 🎨 [Frontend](https://github.com/reworkd/AgentGPT/tree/main/next) (Nextjs)
46
+
47
+ ## 先决条件👆
48
+
49
+ 开始之前,请确保您已安装了以下内容:
50
+
51
+ - 选择你的编辑器,例如[Visual Studio Code (VS Code)](https://code.visualstudio.com/download)
52
+ - [Node.js](https://nodejs.org/en/download)
53
+ - [Git](https://git-scm.com/downloads)
54
+ - [Docker](https://www.docker.com/products/docker-desktop). 安装完成后,请创建一个账号,打开 Docker 应用程序,并登录。
55
+ - 一个 [OpenAI API key](https://platform.openai.com/signup)
56
+ - 一个 [Serper API Key](https://serper.dev/signup) (可选)
57
+ - 一个 [Replicate API Token](https://replicate.com/signin) (可选)
58
+
59
+ ## 入门指南🚀
60
+ 1. **打开你的编辑器**
61
+
62
+ 2. **打开终端** - 通常,你可以在'Terminal'标签页中执行此操作,或者使用快捷键
63
+ (例如,在 VS Code 中,对于 Windows 可以使用 `Ctrl + ~`,对于 Mac 可以使用 `Control + ~`)。
64
+
65
+ 3. **克隆存储库并进入目录** - 一旦您的终端打开,您可以通过运行下面的命令克隆存储库并进入目录。
66
+
67
+ **For Mac/Linux users** 🍎 🐧
68
+ ```bash
69
+ git clone https://github.com/reworkd/AgentGPT.git
70
+ cd AgentGPT
71
+ ./setup.sh
72
+ ```
73
+ **For Windows users** :windows:
74
+ ```bash
75
+ git clone https://github.com/reworkd/AgentGPT.git
76
+ cd AgentGPT
77
+ ./setup.bat
78
+ ```
79
+ 4. **按照脚本中的设置说明进行操作。** - 在添加适当的 API 密钥之后,确保所有服务都已经运行起来,然后在您的网页浏览器中访问 [http://localhost:3000](http://localhost:3000)。
80
+
81
+ 黑客快乐! 🎉
82
+
83
+ ## 🎉 路线图
84
+
85
+ 该平台目前处于测试阶段(beta),已完成和计划中的功能的完整列表可在我们的
86
+ [public roadmap](https://docs.reworkd.ai/essentials/roadmap)中找到。
87
+
88
+
89
+ ## 🚀 技术栈
90
+
91
+ - ✅ **Bootstrapping**: [create-t3-app](https://create.t3.gg) + [FastAPI-template](https://github.com/s3rius/FastAPI-template).
92
+ - ✅ **Framework**: [Nextjs 13 + Typescript](https://nextjs.org/) + [FastAPI](https://fastapi.tiangolo.com/)
93
+ - ✅ **Auth**: [Next-Auth.js](https://next-auth.js.org)
94
+ - ✅ **ORM**: [Prisma](https://prisma.io) & [SQLModel](https://sqlmodel.tiangolo.com/).
95
+ - ✅ **Database**: [Planetscale](https://planetscale.com/).
96
+ - ✅ **Styling**: [TailwindCSS + HeadlessUI](https://tailwindcss.com).
97
+ - ✅ **Schema Validation**: [Zod](https://github.com/colinhacks/zod) + [Pydantic](https://docs.pydantic.dev/).
98
+ - ✅ **LLM Tooling**: [Langchain](https://github.com/hwchase17/langchain).
99
+
100
+
101
+ <h2 align="center">
102
+ 💝 支持 AgentGPT 的发展!! 💝
103
+ </h2>
104
+
105
+ <p align="center">
106
+ 加入我们,共同推动AgentGPT的发展,这是一个突破人工智能代理边界的开源项目!您的赞助将通过帮助我们扩大资源、增强功能和继续迭代这个令人兴奋的项目来推动进步!🚀
107
+ </p>
108
+
109
+ <p align="center">
110
+ <!-- sponsors --><a href="https://github.com/arthurbnhm"><img src="https://github.com/arthurbnhm.png" width="60px" alt="Arthur" /></a><a href="https://github.com/mrayonnaise"><img src="https://github.com/mrayonnaise.png" width="60px" alt="Matt Ray" /></a><a href="https://github.com/jd3655"><img src="https://github.com/jd3655.png" width="60px" alt="Vector Ventures" /></a><a href="https://github.com/durairajasivam"><img src="https://github.com/durairajasivam.png" width="60px" alt="" /></a><a href="https://github.com/floriank"><img src="https://github.com/floriank.png" width="60px" alt="Florian Kraft" /></a><a href="https://github.com/localecho"><img src="https://github.com/localecho.png" width="60px" alt="" /></a><a href="https://github.com/fireheat135"><img src="https://github.com/fireheat135.png" width="60px" alt="" /></a><a href="https://github.com/zoelidity"><img src="https://github.com/zoelidity.png" width="60px" alt="Zoe" /></a><a href="https://github.com/busseyl"><img src="https://github.com/busseyl.png" width="60px" alt="Lucas Bussey" /></a><a href="https://github.com/DuanChaori"><img src="https://github.com/DuanChaori.png" width="60px" alt="" /></a><a href="https://github.com/jukwaphil1"><img src="https://github.com/jukwaphil1.png" width="60px" alt="" /></a><a href="https://github.com/lisa-ee"><img src="https://github.com/lisa-ee.png" width="60px" alt="Lisa" /></a><a href="https://github.com/VulcanT"><img src="https://github.com/VulcanT.png" width="60px" alt="" /></a><a href="https://github.com/kman62"><img src="https://github.com/kman62.png" width="60px" alt="kmotte" /></a><a href="https://github.com/Haithamhaj"><img src="https://github.com/Haithamhaj.png" width="60px" alt="" /></a><a href="https://github.com/SwftCoins"><img src="https://github.com/SwftCoins.png" width="60px" alt="SWFT Blockchain" /></a><a href="https://github.com/ChevalierzA"><img src="https://github.com/ChevalierzA.png" width="60px" alt="" /></a><a href="https://github.com/research-developer"><img src="https://github.com/research-developer.png" width="60px" alt="" /></a><a href="https://github.com/Mitchell-Coder-New"><img src="https://github.com/Mitchell-Coder-New.png" width="60px" alt="" /></a><a href="https://github.com/Trecares"><img src="https://github.com/Trecares.png" width="60px" alt="" /></a><a href="https://github.com/nnkostov"><img src="https://github.com/nnkostov.png" width="60px" alt="Nikolay Kostov" /></a><a href="https://github.com/oryanmoshe"><img src="https://github.com/oryanmoshe.png" width="60px" alt="Oryan Moshe" /></a><a href="https://github.com/ClayNelson"><img src="https://github.com/ClayNelson.png" width="60px" alt="Clay Nelson" /></a><a href="https://github.com/0xmatchmaker"><img src="https://github.com/0xmatchmaker.png" width="60px" alt="0xmatchmaker" /></a><a href="https://github.com/carlosbartolomeu"><img src="https://github.com/carlosbartolomeu.png" width="60px" alt="" /></a><a href="https://github.com/Agronobeetles"><img src="https://github.com/Agronobeetles.png" width="60px" alt="" /></a><a href="https://github.com/CloudyGuyThompson"><img src="https://github.com/CloudyGuyThompson.png" width="60px" alt="Guy Thompson" /></a><a href="https://github.com/Jhonvolt17"><img src="https://github.com/Jhonvolt17.png" width="60px" alt="" /></a><a href="https://github.com/sirswali"><img src="https://github.com/sirswali.png" width="60px" alt="Vusi Dube" /></a><a href="https://github.com/Tweezamiza"><img src="https://github.com/Tweezamiza.png" width="60px" alt="" /></a><a href="https://github.com/DixonFyre"><img src="https://github.com/DixonFyre.png" width="60px" alt="" /></a><a href="https://github.com/jenius-eagle"><img src="https://github.com/jenius-eagle.png" width="60px" alt="" /></a><a href="https://github.com/CubanCongaMan"><img src="https://github.com/CubanCongaMan.png" width="60px" alt="Roberto Luis Sanchez, P.E., P.G.; D,GE; F.ASCE" /></a><a href="https://github.com/cskrobec"><img src="https://github.com/cskrobec.png" width="60px" alt="" /></a><a href="https://github.com/Jahmazon"><img src="https://github.com/Jahmazon.png" width="60px" alt="" /></a><a href="https://github.com/ISDAworld"><img src="https://github.com/ISDAworld.png" width="60px" alt="David Gammond" /></a><a href="https://github.com/lazzacapital"><img src="https://github.com/lazzacapital.png" width="60px" alt="Lazza Capital" /></a><a href="https://github.com/OptionalJoystick"><img src="https://github.com/OptionalJoystick.png" width="60px" alt="" /></a><a href="https://github.com/rodolfoguzzi"><img src="https://github.com/rodolfoguzzi.png" width="60px" alt="" /></a><a href="https://github.com/bluecat2210"><img src="https://github.com/bluecat2210.png" width="60px" alt="" /></a><a href="https://github.com/dactylogram9"><img src="https://github.com/dactylogram9.png" width="60px" alt="" /></a><a href="https://github.com/RUFreeJAC63"><img src="https://github.com/RUFreeJAC63.png" width="60px" alt="" /></a><a href="https://github.com/cecilmiles"><img src="https://github.com/cecilmiles.png" width="60px" alt="" /></a><a href="https://github.com/Djarielm007"><img src="https://github.com/Djarielm007.png" width="60px" alt="" /></a><a href="https://github.com/mikenj07"><img src="https://github.com/mikenj07.png" width="60px" alt="" /></a><a href="https://github.com/SvetaMolusk"><img src="https://github.com/SvetaMolusk.png" width="60px" alt="" /></a><a href="https://github.com/wuminkung"><img src="https://github.com/wuminkung.png" width="60px" alt="" /></a><a href="https://github.com/zhoumo1221"><img src="https://github.com/zhoumo1221.png" width="60px" alt="" /></a><a href="https://github.com/Stefan6666XXX"><img src="https://github.com/Stefan6666XXX.png" width="60px" alt="Stephane DeGuire" /></a><a href="https://github.com/lyska"><img src="https://github.com/lyska.png" width="60px" alt="Lyska" /></a><a href="https://github.com/KurganKolde"><img src="https://github.com/KurganKolde.png" width="60px" alt="" /></a><a href="https://github.com/sclappccsu"><img src="https://github.com/sclappccsu.png" width="60px" alt="Sharon Clapp at CCSU" /></a><a href="https://github.com/Rooba-Finance"><img src="https://github.com/Rooba-Finance.png" width="60px" alt="Rooba.Finance" /></a><a href="https://github.com/ferienhausmiete"><img src="https://github.com/ferienhausmiete.png" width="60px" alt="" /></a><a href="https://github.com/benjaminbales"><img src="https://github.com/benjaminbales.png" width="60px" alt="Benjamin Bales" /></a><a href="https://github.com/pimentel233"><img src="https://github.com/pimentel233.png" width="60px" alt="" /></a><a href="https://github.com/PinkyWobbles"><img src="https://github.com/PinkyWobbles.png" width="60px" alt="" /></a><a href="https://github.com/jconroy11"><img src="https://github.com/jconroy11.png" width="60px" alt="" /></a><a href="https://github.com/DavidJamesRotenberg"><img src="https://github.com/DavidJamesRotenberg.png" width="60px" alt="" /></a><a href="https://github.com/antecochat"><img src="https://github.com/antecochat.png" width="60px" alt="" /></a><a href="https://github.com/RealBonOfaSitch"><img src="https://github.com/RealBonOfaSitch.png" width="60px" alt="" /></a><!-- sponsors -->
111
+ </p>
112
+
113
+ <h2 align="center">
114
+ 💪 贡献者 💪
115
+ </h2>
116
+
117
+ <p align="center">
118
+ 我们的贡献者使这个项目成为可能。谢谢!🙏
119
+ </p>
120
+
121
+ <a href="https://github.com/reworkd/agentgpt/graphs/contributors">
122
+ <img src="https://contrib.rocks/image?repo=reworkd/agentgpt" />
123
+ </a>
124
+
125
+ <div align="center">
126
+ <sub>使用 <a href="https://contrib.rocks">contrib.rocks</a>制作。</sub>
127
+ </div>
docs/development/auth.mdx ADDED
@@ -0,0 +1,63 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ title: Authentication
3
+ description: Learn how AgentGPT handles authentication in different development modes and with various providers.
4
+ icon: "lock"
5
+ ---
6
+
7
+ # Authentication in Development Mode
8
+
9
+ In development mode, your application uses a simplified version of authentication for ease of testing and debugging. This is usually not secure and should not be used in a production environment.
10
+
11
+ In your `.env` file, you can switch between development and production environments using the `NODE_ENV` variable. When it's set to "development", the application runs in development mode.
12
+
13
+ To make the application use the insecure, simple version of authentication, set the `NEXTAUTH_SECRET` variable in your `.env` file to a simple, insecure value (e.g., "changeme").
14
+
15
+ ## Accessing Provider Secret Keys
16
+
17
+ To enable different types of OAuth authentication, you will need to acquire secret keys from the respective providers. Below are the general instructions for getting these secret keys:
18
+
19
+ <Tabs>
20
+ <Tab title="Google">
21
+
22
+ Create a project in the Google Cloud Console.
23
+ Go to "Credentials", click on "Create Credentials" and choose "OAuth client ID".
24
+ Configure your OAuth consent screen and application type, then click "Create".
25
+ Your client ID and secret will be displayed.
26
+ For more detailed instructions, visit Google's official [OAuth 2.0 setup guide](https://developers.google.com/identity/protocols/oauth2).
27
+
28
+ </Tab>
29
+
30
+ <Tab title="GitHub">
31
+
32
+ Go to your GitHub settings.
33
+ Click on "Developer settings".
34
+ Click on "OAuth Apps" and then "New OAuth App".
35
+ Fill in the required information and click "Register Application".
36
+ The client ID and secret will be displayed on the next page.
37
+ You can find more detailed instructions in the [GitHub OAuth documentation](https://docs.github.com/en/developers/apps/building-oauth-apps).
38
+
39
+ </Tab>
40
+
41
+ <Tab title="Discord">
42
+
43
+ Go to the Discord Developer Portal.
44
+ Click on "New Application".
45
+ Give your application a name and click "Create".
46
+ Go to the "OAuth2" page in your application settings.
47
+ Under "Redirects", add your redirect URIs.
48
+ Click on "Save Changes".
49
+ The client ID can be found on the "General Information" page, and the secret can be found on the "OAuth2" page.
50
+ For more detailed instructions, visit the [Discord OAuth2 documentation](https://discord.com/developers/docs/topics/oauth2).
51
+
52
+ </Tab>
53
+ </Tabs>
54
+
55
+ ## Enabling Non-Local Authentication
56
+
57
+ The `.env` file includes several placeholders for provider client IDs and secrets. Replace these placeholders with the keys obtained from the respective providers:
58
+
59
+ - For Google, replace the "\*\*\*" placeholders for `GOOGLE_CLIENT_ID` and `GOOGLE_CLIENT_SECRET` with the client ID and secret obtained from Google.
60
+ - For GitHub, replace the "\*\*\*" placeholders for `GITHUB_CLIENT_ID` and `GITHUB_CLIENT_SECRET` with the client ID and secret obtained from GitHub.
61
+ - For Discord, replace the "\*\*\*" placeholders for `DISCORD_CLIENT_ID` and `DISCORD_CLIENT_SECRET` with the client ID and secret obtained from Discord.
62
+
63
+ Once these changes are made, your application will be set up to use OAuth authentication with these providers. To switch from local authentication to OAuth authentication, change the `NEXTAUTH_URL` variable in your `.env` file to the URL where your application is hosted. This cannot be localhost.
docs/development/memory.mdx ADDED
@@ -0,0 +1,35 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ title: Memory
3
+ description: Understanding how AgentGPT manages memory with the help of vector databases.
4
+ icon: "brain"
5
+ ---
6
+
7
+ # Memory Management in AgentGPT
8
+
9
+ In the quest to accomplish set goals, AI agents perform a plethora of tasks, considering their execution history. When agents operate for extended periods, memory management becomes challenging since their memory is typically as large as their context length. This stands at approximately 8k tokens for GPT-3.5 and GPT-4.
10
+
11
+ ## AgentGPT's Memory Dilemma
12
+
13
+ Once your agents have run a few loops, they tend to forget their prior actions. Our solution? Vector Databases. Here, we save the agent memory externally, making it accessible when needed.
14
+
15
+ ## What is a Vector Database?
16
+
17
+ This external documentation - [Weaviate docs](https://weaviate.io/developers/weaviate), provides a detailed explanation. In a nutshell, vector databases enable us to store task execution history externally. This way, agents can access memory from many loops before via a text similarity search. Essentially, the way humans retrieve memory is comparable to the Vector DB's operation.
18
+
19
+ ## Why Weaviate?
20
+
21
+ Weaviate is our go-to Vector Database for the following reasons:
22
+
23
+ 1. Weaviate is open-source and conveniently accessible via docker-compose, eliminating the need for an API key for local AgentGPT runs.
24
+ 2. Its cloud offering can scale according to our workload, saving us from managing additional infrastructure.
25
+ 3. Weaviate integrates seamlessly with tools like LangChain.
26
+
27
+ However, if you have suggestions for other databases, we encourage you to create a ticket or a pull request.
28
+
29
+ ## Memory in AgentGPT
30
+
31
+ Using long-term memory is still a work in progress. Here are some of its applications so far:
32
+
33
+ - Filtering similar tasks utilized in a given run.
34
+
35
+ We are actively developing more applications. If you have interesting ideas for memory management or wish to contribute to its development, please feel free to reach out.
docs/development/prompts.mdx ADDED
@@ -0,0 +1,34 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ title: Prompts
3
+ description: Learn how we use prompts to guide the behavior of our AI agents.
4
+ icon: "page"
5
+ ---
6
+
7
+ Prompts play a pivotal role in shaping the behavior of our AI agents as they guide the language models towards accomplishing specific tasks or goals. We predominantly utilize two models `gpt-3.5-turbo` and `gpt-4`. All these models are highly sensitive to the minutest details in their prompts, making the prompt design an essential aspect of our system.
8
+
9
+ ## Prompt Templates
10
+
11
+ Along with these powerful models, we also provide an assortment of pre-made prompt templates. These templates can serve as a valuable resource when getting started, providing excellent examples of well-structured prompts. However, these templates aren't always perfect and should be fine-tuned to best suit your specific use case. Each situation is unique, and the best results often come from iterative testing and refinement of prompts based on your unique requirements and objectives.
12
+
13
+ ## Getting Started with Prompting
14
+
15
+ If you are interested in learning more about the art of prompting, we recommend the following resources:
16
+
17
+ 1. [Learn prompting docs](https://learnprompting.org/)
18
+ 2. [Prompt engineering guide](https://www.promptingguide.ai/techniques/consistency)
19
+ 3. [Prompt engineering for developers](https://www.deeplearning.ai/short-courses/chatgpt-prompt-engineering-for-developers/)
20
+
21
+ ## Key Terms
22
+
23
+ 1. **One shot / Two shot / N shot**: You provide 1, 2, or N examples along with your prompt to improve model accuracy.
24
+ 2. **Zero shot**: You provide a prompt to a model directly, without any examples.
25
+
26
+ ## Prompting Techniques in AgentGPT
27
+
28
+ ### Plan and Solve
29
+
30
+ Plan and Solve (PS) is a technique that enhances the chain of thought prompting approach. In PS, the model is asked to understand the problem, extract relevant variables and values, and devise a step-by-step plan. We primarily use this zero-shot approach to increase reasoning accuracy about abstract goals. Find out more about Plan and Solve through its [GitHub repo](https://github.com/AGI-Edgerunners/Plan-and-Solve-Prompting).
31
+
32
+ ### ReAct
33
+
34
+ Reasoning + Action, abbreviated as ReAct, is a prompting technique that combines both reasoning and action generation into one output. This allows the model to better synchronize thoughts with actions.
docs/development/setup.mdx ADDED
@@ -0,0 +1,87 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ title: Setup
3
+ description: Guidelines for setting up a local installation of AgentGPT.
4
+ icon: "gear"
5
+ ---
6
+
7
+ This document aims to guide you through the process of setting up a local installation of AgentGPT. It's important to note that we recommend using Docker for this installation. Docker simplifies the process and ensures that all dependencies are correctly handled, making the installation process more straightforward and less error-prone.
8
+
9
+ ## Prerequisites
10
+
11
+ Before you get started, please make sure you have the following installed:
12
+
13
+ 1. [Git](https://git-scm.com/downloads)
14
+ 2. [Node.js](https://nodejs.org/en/download)
15
+ 3. An [OpenAI API key](https://beta.openai.com/signup/)
16
+ 4. A code editor of your choice, such as [Visual Studio Code (VS Code)](https://code.visualstudio.com/download)
17
+
18
+ ### Docker Installation (Recommended)
19
+
20
+ In addition to the prerequisites listed above, Docker is also necessary for this setup. Follow the steps below for Docker installation:
21
+
22
+ 1. Download and install [Docker](https://www.docker.com/products/docker-desktop)
23
+ 2. After installation, create a Docker account if you don't have one
24
+ 3. Open the Docker Desktop application and sign in
25
+
26
+ ## Installation with Docker
27
+
28
+ 1. **Open your editor**
29
+
30
+ 2. **Open the Terminal** - Typically, you can do this from a 'Terminal' tab or by using a shortcut
31
+ (e.g., `Ctrl + ~` for Windows or `Control + ~` for Mac in VS Code).
32
+
33
+ 3. **Clone the Repository and Navigate into the Directory** - Once your terminal is open, you can clone the repository and move into the directory by running the commands below.
34
+
35
+ **For Mac/Linux users**
36
+
37
+ ```bash
38
+ git clone https://github.com/reworkd/AgentGPT.git
39
+ cd AgentGPT
40
+ ./setup.sh
41
+ ```
42
+
43
+ **For Windows users**
44
+
45
+ ```bash
46
+ git clone https://github.com/reworkd/AgentGPT.git
47
+ cd AgentGPT
48
+ ./setup.bat
49
+ ```
50
+
51
+ 4. **Follow the setup instructions from the script** - add the appropriate API keys, and once all of the services are running, travel to [http://localhost:3000](http://localhost:3000) on your web-browser.
52
+
53
+ ## Installation without Docker
54
+
55
+ Outside of docker, you'll need to just configure your ENV. Additionally, you can use `setup.sh` to walkthrough ENV
56
+ configuration and also update your Prisma configuration to point to a local SQLite
57
+ instance.
58
+
59
+ After this, you can run the following to set up your Next.js project.
60
+
61
+ ```bash
62
+ // Frontend
63
+ cd ./next
64
+ npm install
65
+ npm run dev
66
+ ```
67
+
68
+ In a different window, you can run the following to start the backend:
69
+
70
+ ```bash
71
+ // Backend. Make sure you are at the root of the project
72
+ cd ./platform
73
+ poetry install
74
+ poetry run python -m reworkd_platform
75
+ ```
76
+
77
+ ## Running the site
78
+
79
+ Congratulations on successfully setting up AgentGPT on your local machine! To see the fruit of your work, open your preferred web browser and visit [http://localhost:3000/](http://localhost:3000/). There, you'll find the AgentGPT user interface ready for you to explore and interact with.
80
+
81
+ ## Issues / Additional help
82
+
83
+ Despite the detailed instructions, you might still encounter some hiccups along the way. If that happens, don't worry! We've got your back. Consider following this comprehensive legacy guide that walks you through the process: [How to install AgentGPT locally](https://snapdragon-writer-867.notion.site/How-to-Install-AgentGPT-Locally-9b96b2314c9b491397976249fd121023).
84
+
85
+ If the issues persist, we invite you to submit an [issue on GitHub](https://github.com/reworkd/AgentGPT/issues). By doing so, you'll not only get help, but also assist us in identifying any problematic areas to improve on. Alternatively, you can reach out to our dedicated team on [Discord](https://discord.gg/jdSBAnmdnY). We're a community of learners and enthusiasts, and we're always ready to lend a hand.
86
+
87
+ Happy hacking and enjoy your journey with AgentGPT!
docs/development/translations.mdx ADDED
@@ -0,0 +1,90 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ title: "Translations"
3
+ description: Guide to translating the language.
4
+ icon: "globe"
5
+ ---
6
+
7
+ AgentGPT has translations across a variety of languages thanks to the help of many contributors such as @Cs4K1Sr4C.
8
+ languages. We're always looking to improve our translations however, if you notice something is off or missing, please
9
+ feel free to make the necessary updates or submit a ticket on GitHub!
10
+
11
+ ## Translating the Frontend
12
+
13
+ We use i18next to handle our frontend translations. How it works is we have a folder for each language
14
+ in [next/public/locales](https://github.com/reworkd/AgentGPT/tree/main/next/public/locales).
15
+
16
+ ```bash title="next/public/locales"
17
+ > en
18
+ > fr
19
+ > hu
20
+ ...
21
+ > zh
22
+ ```
23
+
24
+ For each component within the app, we namespace their translations. For example, our ChatWindow uses the `chat` name
25
+ space and its translations will be found in the `chat.json` under each folder. Translations are key value pairs where
26
+ the key represents the
27
+ desired text and the value represents the translation for a given langauge.
28
+
29
+ An example from the `chat` namespace:
30
+
31
+ - English: `"EMBARKING_ON_NEW_GOAL": "Embarking on a new goal:"`
32
+ - Spanish:`"EMBARKING_ON_NEW_GOAL": "Embarcándose en un nuevo objetivo:"`
33
+
34
+ #### Adding a new langauge
35
+
36
+ To add a new language, go into our i18 config and add a new locale
37
+
38
+ ```bash title="next/next-i18next.config.js"
39
+ i18n: {
40
+ defaultLocale: "en",
41
+ locales:
42
+ [
43
+ "en",
44
+ "hu",
45
+ ...,
46
+ "sk",
47
+ "hr",
48
+ "tr",
49
+ // Insert new language code here
50
+ ],
51
+ ...
52
+ ```
53
+
54
+ Then head over to our languages definition and add a section to the available languages list
55
+
56
+ ```tsx title="next/src/utils/languages.ts"
57
+ export const availableLanguages: Language[] = [
58
+ ENGLISH,
59
+ { code: "fr", name: "Français", flag: "🇫🇷" },
60
+ // ...
61
+ { code: "tr", name: "Türkçe", flag: "🇹🇷" },
62
+ // Insert new language here
63
+ ];
64
+ ```
65
+
66
+ After this, you must create a new folder with your langauge code
67
+ in [next/public/locales](https://github.com/reworkd/AgentGPT/tree/main/next/public/locales) and add translations for all
68
+ namespaces of our app. Note these values may not hot reload, so you must manually restart your next server.
69
+
70
+ ## Translating the Backend
71
+
72
+ The backend translations are handled via the model itself.
73
+ We simply prompt it to provide the answer in the user selected langauge.
74
+ This means that whenever a new frontend language is added, the language is immediately supported on the backend!
75
+ This does however mean that we don't currently have much room to actually edit the translations provided by the model.
76
+
77
+ ## Translating the Readme
78
+
79
+ We have a few README translations that live in [main/docs](https://github.com/reworkd/AgentGPT/tree/main/docs) such
80
+ as `README.zh-HANS.md`. If you'd like to translate the README to your language, make a similar file.
81
+
82
+ After doing this, add a link badge to our main english README alongside the other badges. Example:
83
+
84
+ <a href="https://github.com/reworkd/AgentGPT/blob/master/README.md">
85
+ <img src="https://img.shields.io/badge/lang-English-blue.svg" alt="English" />
86
+ </a>
87
+
88
+ ## Translating our Documentation
89
+
90
+ This documentation is very experimental. Because of this, we have no plans to support translation just yet.
docs/development/workflow-input.mdx ADDED
@@ -0,0 +1,28 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ title: "Input Templating"
3
+ description: The workflow automation system within AgentGPT.
4
+ icon: "wave-sine"
5
+ ---
6
+
7
+ Any given workflow node will outfield a set of fields that can be used in the input of descendent nodes.
8
+ Because these outputs are only generated at runtime, we use a templating system to keep track of what values a node
9
+ will receive once these values are actually calculated.
10
+ This document goes over how this process works in both the frontend and backend.
11
+
12
+ ## Model
13
+ All `block` definitions will specify both the inputs it takes in and the output values it provides
14
+
15
+
16
+ ## Frontend
17
+ The workflow hierarchy follows a graph-like structure.
18
+ For a given node, we calculate what output fields are available to it by doing a BFS on its ascendant nodes.
19
+ Once we have a list of all ascendant nodes, we can generate the available output field values along with its underlying key.
20
+ When placed inside the input of another node, it will take its template form which has the following shape:
21
+
22
+ ```
23
+ {{node_id-value}}
24
+ ```
25
+
26
+ ## Backend
27
+ A workflow task in kafka will keep track of the mapping of template key to value pairs as they are generated.
28
+ When a new node is being executed, its input fields will first have actual values replace the string templates before type validation is run.
docs/development/workflows.mdx ADDED
@@ -0,0 +1,43 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ title: "Workflows"
3
+ description: The workflow automation system within AgentGPT.
4
+ icon: "wave-sine"
5
+ ---
6
+
7
+ A core function of Reworkd is AI powered workflow automation. This documentation covers key concepts within our workflow platform.
8
+
9
+ ## Frontend models
10
+ The workflow hierarchy follows a graph-like structure. The frontend models only prescribe the front-end view of the workflow.
11
+
12
+ - A workflow is the graph itself. It represents the workflow in its entirety
13
+ - A node is a single element within a workflow. It has a position
14
+ - An edge represents a connection between two nodes of a workflow
15
+
16
+ ## Backend models
17
+ The backend models represent the mechanisms to actually perform work for a given node.
18
+ Each frontend `Node` will have an associated `Block`.
19
+ `Node` represents the frontend view / position while the `Block` represents what will actually happen when that `Node` is run.
20
+ For example, a "SlackMessageBlock" is a `Block` that, when executed, would send a user a message on "Slack".
21
+
22
+ ## Adding a new block
23
+ To add a new block, start by updating the frontend:
24
+ - open next/src/services/workflow/node-block-definitions.ts
25
+ - figure it out
26
+ - (soon block definitions on frontend will be set from backend and edits won't be needed here)
27
+
28
+ Then update the backend:
29
+ - open platform/reworkd_platform/schemas/workflow/blocks
30
+ - add a new file for your block
31
+ - define the block's input and output types as classes
32
+ - add a class for the block with
33
+ - attributes: type, description, image_url, and input
34
+ - async method: `run`
35
+ - install dependencies for your block with `poetry add`
36
+ - open platform/reworkd_platform/web/api/workflow/blocks/web/__init__.py
37
+ - import your block
38
+ - add an if branch to get_block_runner
39
+ - `docker compose down; docker compose up --build`
40
+
41
+ ## Node types
42
+ - Triggers: Designate how workflows are run
43
+ - Actions: Performs a concrete piece of "work"
docs/essentials/FAQ.mdx ADDED
@@ -0,0 +1,94 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ title: FAQ
3
+ description: Get answers to the most frequently asked questions about AgentGPT
4
+ icon: "question"
5
+ ---
6
+
7
+ Discover answers to the most frequently asked questions about AgentGPT. If your question isn't covered here, feel free to connect with our team on [Discord](https://discord.gg/jdSBAnmdnY) or [GitHub](https://github.com/reworkd/AgentGPT).
8
+
9
+ ## Agent issues
10
+
11
+ <AccordionGroup>
12
+
13
+ <Accordion title="AgentGPT said it made a file / database / script, where can I find it?">
14
+ At present, AgentGPT does not have the capability to generate outputs in this
15
+ way. However, this is a feature we're actively developing. To keep updated on
16
+ this, check out our [roadmap](/essentials/roadmap).
17
+ </Accordion>
18
+
19
+ <Accordion title="Did AgentGPT really email 100 people?">
20
+ Not yet! We're looking into implementing this functionality. To see when this
21
+ might be available, take a look at our [roadmap](/essentials/roadmap). We guarantee that
22
+ actions such as "sending an email" will only occur with your explicit
23
+ permission.
24
+ </Accordion>
25
+
26
+ <Accordion title="My agent keeps running out of loops!">
27
+ Due to limitations on API usage and infrastructure costs, there's a cap on how
28
+ much the Agent can run. To circumvent this, consider hosting AgentGPT locally
29
+ using your own API key. Alternatively, subscribing to our pro plan will allow
30
+ for increased limits. More details can be found in our [setup
31
+ documentation](/essentials/roadmap).
32
+ </Accordion>
33
+
34
+ <Accordion title="My Agent was running smoothly, but then it stopped! Can I resume from where it left off?">
35
+ Currently, each Agent run is independent, so resuming isn't possible. However,
36
+ you can initiate another AgentGPT run using information from the previous run.
37
+ We plan on adding this feature in the future. Stay updated via our
38
+ [roadmap](/essentials/roadmap).
39
+ </Accordion>
40
+
41
+ <Accordion title="Can AgentGPT use GPT-4?">
42
+ Currently, free-tier users of AgentGPT utilize GPT-3.5, while PRO users have
43
+ access to GPT-4. If you have API access to GPT-4, you can run AgentGPT locally
44
+ using your API key.
45
+ </Accordion>
46
+
47
+ <Accordion title="Why does the output keep getting cut off?">
48
+ The output length is limited to manage generation costs on our end. If you're
49
+ using your own API key, you can adjust the output length within the advanced
50
+ settings by increasing the token count. If you're a Pro user or are a running
51
+ AgentGPT locally, you can adjust the output length winthin the advanced
52
+ settings
53
+ </Accordion>
54
+
55
+ </AccordionGroup>
56
+
57
+ ## Misc
58
+
59
+ <AccordionGroup>
60
+
61
+ <Accordion title="How is AgentGPT different from ChatGPT?">
62
+ While ChatGPT is designed to answer specific questions and maintain a
63
+ conversation, AgentGPT is a platform where you can configure an AI agent to
64
+ achieve a broad goal.
65
+ </Accordion>
66
+
67
+ <Accordion title="How is AgentGPT different from AutoGPT?">
68
+ Both AgentGPT and AutoGPT are autonomous AI agent projects. However, while
69
+ AutoGPT runs locally, AgentGPT is a web-based platform.
70
+ </Accordion>
71
+
72
+ <Accordion title="What can AgentGPT do?">
73
+ AgentGPT boasts a wide array of capabilities and we're always working to
74
+ expand them. To see some of its applications, visit our [usecases](/essentials/usecases)
75
+ page.
76
+ </Accordion>
77
+
78
+ <Accordion title="Can AgentGPT access the internet?">
79
+ Yes, AgentGPT does have internet access.
80
+ </Accordion>
81
+
82
+ </AccordionGroup>
83
+
84
+ ## Local contribution issues
85
+
86
+ <AccordionGroup>
87
+
88
+ <Accordion title="I'm experiencing issues setting up AgentGPT locally!">
89
+ For troubleshooting, refer to our [setup guide](/development/setup). If your
90
+ issue persists, you're welcome to submit an [issue on
91
+ GitHub](https://github.com/reworkd/AgentGPT/issues).
92
+ </Accordion>
93
+
94
+ </AccordionGroup>
docs/essentials/contributing.mdx ADDED
@@ -0,0 +1,47 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ title: Contributing
3
+ description: Learn how to contribute to AgentGPT and join our thriving open-source community.
4
+ icon: "hands"
5
+ ---
6
+
7
+ # Contributing to AgentGPT
8
+
9
+ AgentGPT is an open-source project that has grown and thrived thanks to the collective efforts of our vibrant community of contributors. We are thrilled to have you here and appreciate your interest in contributing to this exciting project!
10
+
11
+ ## Ways to Contribute
12
+
13
+ There are numerous ways you can contribute to AgentGPT:
14
+
15
+ ### Development
16
+
17
+ If you're a developer, your skills can be put to great use in improving AgentGPT's codebase. You can contribute by addressing open issues listed on our [GitHub](https://github.com/reworkd/AgentGPT), or even by suggesting new features.
18
+
19
+ ### Design
20
+
21
+ Are you gifted with design skills? AgentGPT could use your expertise to make it even more user-friendly and visually appealing.
22
+
23
+ ### Documentation
24
+
25
+ If you're adept at explaining things clearly, you can help us maintain and enhance the documentation. Clear and comprehensive documentation is invaluable, as it makes it easier for people to get started with AgentGPT and contribute to its development.
26
+
27
+ ### Testing
28
+
29
+ If you've found a bug or issue, report it! Or better yet, help us fix it. Testing is a vital part of software development and helps ensure the quality and reliability of AgentGPT.
30
+
31
+ ### Share Your Ideas
32
+
33
+ Do you have an innovative idea for improving AgentGPT? We're all ears! Our community is a hub for creativity and innovation, and we welcome fresh thoughts and perspectives.
34
+
35
+ ### Spread the Word
36
+
37
+ If you're passionate about AgentGPT, consider sharing that passion with others. Write about us, speak about us, and help more people discover and contribute to AgentGPT.
38
+
39
+ ## How to Start Contributing
40
+
41
+ This section will soon be updated with detailed instructions on how to contribute to AgentGPT.
42
+
43
+ In the meantime, know that we welcome all individuals, regardless of expertise or background. Feel free to reach out to us on [GitHub](https://github.com/reworkd/AgentGPT) or [Discord](https://discord.gg/jdSBAnmdnY).
44
+
45
+ ## A Big Thank You!
46
+
47
+ We sincerely appreciate your interest and contribution to AgentGPT. Together, we can take this project to new heights. Welcome to our community!
docs/essentials/roadmap.mdx ADDED
@@ -0,0 +1,65 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ title: "Roadmap"
3
+ description: "See whats coming to AgentGPT in the future"
4
+ icon: "road"
5
+ ---
6
+
7
+ AgentGPT is currently in beta, and we're excited to share what we have in store! This roadmap provides an overview of the features we're currently working on, as well as the ones we've already completed.
8
+
9
+ <Card title="Features in Development">
10
+ Our developers are working tirelessly on these features. Typically, it might
11
+ take a few days to 2 weeks to roll out these updates. To stay updated with our
12
+ progress, check out our [roadmap board on
13
+ GitHub](https://github.com/orgs/reworkd/projects/3).
14
+ </Card>
15
+
16
+ ## Completed Features
17
+
18
+ <CardGroup cols={1}>
19
+ <Card title="Users and authentication"></Card>
20
+ <Card title="Saving and sharing agent runs">
21
+ Sign in to save your agent runs in our database.
22
+ </Card>
23
+ <Card title="Dynamic translations for multiple languages">
24
+ We strive to make AgentGPT accessible to everyone. We're always looking to
25
+ expand our language offerings, so your contributions are welcome!
26
+ </Card>
27
+ <Card title="AI Model customization">
28
+ Use your own OpenAI API key to customize everything from the model to the
29
+ temperature, loops, and more. All of this happens within your browser!
30
+ </Card>
31
+ <Card title="Documentation overhaul">
32
+ We're always updating our documentation to help new users and contributors
33
+ familiarize themselves with AgentGPT.
34
+ </Card>
35
+ <Card title="Web browsing capabilities">
36
+ Our basic version performs and summarizes Google searches via
37
+ [Serper.dev](https://serper.dev). We're planning to support other SERP APIs
38
+ and visit and parse websites in the future.
39
+ </Card>
40
+ <Card title="Backend migration to Python">
41
+ We believe this migration will help us leverage the Python ecosystem's
42
+ language model tools.
43
+ </Card>
44
+ <Card title="Stripe integration for a lower limit paid version">
45
+ This will help us cover infrastructure costs.
46
+ </Card>
47
+ </CardGroup>
48
+
49
+ ## Planned Features
50
+
51
+ <CardGroup cols={1}>
52
+ <Card title="Interaction with websites and people"></Card>
53
+ <Card title="Writing capabilities via a document API"></Card>
54
+ <Card title="Cross agent communication"></Card>
55
+ </CardGroup>
56
+
57
+ ## Notes
58
+
59
+ <Card>
60
+ We continually update our roadmap and add new features, so stay tuned for
61
+ updates! Feel free to check out our GitHub for the latest. As a small team, we
62
+ greatly appreciate the community's support in developing AgentGPT. If you're
63
+ interested in contributing, please visit our [contributing
64
+ page](/contributing).
65
+ </Card>
docs/essentials/usecases.mdx ADDED
@@ -0,0 +1,58 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ title: Use Cases
3
+ description: Discover a variety of exciting use cases for AgentGPT.
4
+ icon: "lightbulb"
5
+ ---
6
+
7
+ The versatile and dynamic nature of AgentGPT allows it to be applied in a plethora of scenarios. This page will introduce you to the different use cases of AgentGPT and illustrate how it can be a game-changing tool in various fields.
8
+
9
+ <Info>
10
+ The potential use cases for AgentGPT are almost limitless. From education to
11
+ healthcare, business to entertainment, AgentGPT can bring a new level of
12
+ efficiency and automation.
13
+ </Info>
14
+
15
+ ## Code Assistance
16
+
17
+ AgentGPT can serve as a programming assistant, helping to debug code, generate code snippets, or even provide coding tutorials.
18
+
19
+ ## Research and Content Generation
20
+
21
+ From crafting blog posts and writing articles, to compiling study guides and summaries, AgentGPT can streamline content creation across numerous domains.
22
+
23
+ ## Email and Communication
24
+
25
+ Writing an email or crafting a perfect message can be time-consuming. With AgentGPT, you can automate this process. It can help generate emails, draft messages, and assist with other forms of communication.
26
+
27
+ ## Marketing and Advertising
28
+
29
+ AgentGPT can be used to generate innovative marketing ideas, create compelling ad copy, and help with SEO strategies.
30
+
31
+ ## Budgeting and Financial Planning
32
+
33
+ AgentGPT can provide budgeting advice, financial management tips, and even create personal financial plans based on user-defined criteria.
34
+
35
+ <CardGroup cols={2}>
36
+ <Card
37
+ title="Contribute on Discord"
38
+ icon="discord"
39
+ href="https://discord.gg/jdSBAnmdnY"
40
+ >
41
+ If you have an interesting use case in mind, or if you'd like to contribute
42
+ to the development of these features, we'd love to hear from you! Reach out
43
+ to us on Discord.
44
+ </Card>
45
+ <Card
46
+ title="Contribute on GitHub"
47
+ icon="github"
48
+ href="https://github.com/reworkd/AgentGPT"
49
+ >
50
+ We welcome contributions on GitHub. Your innovative ideas and contributions
51
+ can help shape the future of AgentGPT.
52
+ </Card>
53
+ </CardGroup>
54
+
55
+ <Note>
56
+ For detailed guidelines on how to contribute to these usecases, check out our
57
+ [Contributing](./contributing) page.
58
+ </Note>
docs/favicon.png ADDED
docs/images/background.png ADDED