Upload folder using huggingface_hub

.dockerignore

@@ -0,0 +1,60 @@
+# See https://help.github.com/ignore-files/ for more about ignoring files.
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Distribution / packaging
+dist/
+build/
+*.egg-info/
+*.egg
+
+# Virtual environments
+.env
+.env.sh
+venv/
+ENV/
+
+# IDE-specific files
+.vscode/
+.idea/
+
+# Compiled Python modules
+*.pyc
+*.pyo
+*.pyd
+
+# Python testing
+.pytest_cache/
+.ruff_cache/
+.coverage
+.mypy_cache/
+
+# macOS specific files
+.DS_Store
+
+# Windows specific files
+Thumbs.db
+
+# this application's specific files
+archive
+
+# any log file
+*log.txt
+todo
+scratchpad
+
+# Ignore GPT Engineer files
+projects
+!projects/example
+
+# Pyenv
+.python-version
+
+# Benchmark files
+benchmark
+!benchmark/*/prompt
+
+.gpte_consent

.env.template

@@ -0,0 +1,5 @@
+### OpenAI Setup ###
+
+# OPENAI_API_KEY=Your personal OpenAI API key from https://platform.openai.com/account/api-keys
+OPENAI_API_KEY=...
+ANTHROPIC_API_KEY=...

.gitattributes

@@ -33,3 +33,4 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
 *.zip filter=lfs diff=lfs merge=lfs -text
 *.zst filter=lfs diff=lfs merge=lfs -text
 *tfevents* filter=lfs diff=lfs merge=lfs -text
+tests/test_data/mona_lisa.jpg filter=lfs diff=lfs merge=lfs -text

.github/CODEOWNERS

@@ -0,0 +1 @@
+.github/workflows/ @ATheorell

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,131 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity or expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting using an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+<[email protected]>.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of reporters of incidents.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

.github/CONTRIBUTING.md

@@ -0,0 +1,135 @@
+# Contributing to gpt-engineer
+
+The gpt-engineer is a community project and lives from your contributions - they are warmly appreciated. The main contribution avenues are:
+- Pull request: implement code and have it reviewed and potentially merged by the maintainers. Implementations of existing feature requests or fixes to bug reports are likely to be merged.
+- Bug report: report when something in gpt-engineer doesn't work. Do not report errors in programs written _by_ gpt-engineer.
+- Feature request: provide a detailed sketch about something you want to have implemented in gpt-engineer. There is no guarantee that features will be implemented.
+- Discussion: raise awareness of a potential improvement. This is often a good starting point before making a detailed feature request.
+
+By participating in this project, you agree to abide by the [code of conduct](https://github.com/gpt-engineer-org/gpt-engineer/blob/main/.github/CODE_OF_CONDUCT.md).
+
+## Merge Policy for Pull Requests
+Code that is likely to introduce breaking changes, or significantly change the user experience for users and developers, require [board approval](https://github.com/gpt-engineer-org/gpt-engineer/blob/main/GOVERNANCE.md) to be merged. Smaller code changes can be merged directly.
+As a rule, cosmetic pull requests, for example rephrasing the readme or introducing more compact syntax, that do not yield clear practical improvements are not merged. Such pull requests are generally discouraged, both to save time for the maintainers and to establish a lower bar for becoming a contributor.
+
+## Getting Started with Pull Requests to gpt-engineer
+
+To get started with contributing, please follow these steps:
+
+1. Fork the repository and clone it to your local machine.
+2. Install any necessary dependencies.
+3. Create a new branch for your changes: `git checkout -b my-branch-name`.
+4. Make your desired changes or additions.
+5. Run the tests to ensure everything is working as expected.
+6. Commit your changes: `git commit -m "Descriptive commit message"`.
+7. Push to the branch: `git push origin my-branch-name`.
+8. Submit a pull request to the `main` branch of the original repository.
+
+## Code Style
+
+Please make sure to follow the established code style guidelines for this project. Consistent code style helps maintain readability and makes it easier for others to contribute to the project.
+
+To enforce this we use [`pre-commit`](https://pre-commit.com/) to run [`black`](https://black.readthedocs.io/en/stable/index.html) and [`ruff`](https://beta.ruff.rs/docs/) on every commit.
+
+To install gpt-engineer as a developer, clone the repository and install the dependencies with:
+
+```bash
+$ poetry install
+$ poetry shell
+```
+
+And then install the `pre-commit` hooks with:
+
+```bash
+$ pre-commit install
+
+# output:
+pre-commit installed at .git/hooks/pre-commit
+```
+
+If you are not familiar with the concept of [git hooks](https://git-scm.com/docs/githooks) and/or [`pre-commit`](https://pre-commit.com/) please read the documentation to understand how they work.
+
+As an introduction of the actual workflow, here is an example of the process you will encounter when you make a commit:
+
+Let's add a file we have modified with some errors, see how the pre-commit hooks run `black` and fails.
+`black` is set to automatically fix the issues it finds:
+
+```bash
+$ git add chat_to_files.py
+$ git commit -m "commit message"
+black....................................................................Failed
+- hook id: black
+- files were modified by this hook
+
+reformatted chat_to_files.py
+
+All done! ✨ 🍰 ✨
+1 file reformatted.
+```
+
+You can see that `chat_to_files.py` is both staged and not staged for commit. This is because `black` has formatted it and now it is different from the version you have in your working directory. To fix this you can simply run `git add chat_to_files.py` again and now you can commit your changes.
+
+```bash
+$ git status
+On branch pre-commit-setup
+Changes to be committed:
+  (use "git restore --staged <file>..." to unstage)
+    modified:   chat_to_files.py
+
+Changes not staged for commit:
+  (use "git add <file>..." to update what will be committed)
+  (use "git restore <file>..." to discard changes in working directory)
+    modified:   chat_to_files.py
+```
+
+Now let's add the file again to include the latest commits and see how `ruff` fails.
+
+```bash
+$ git add chat_to_files.py
+$ git commit -m "commit message"
+black....................................................................Passed
+ruff.....................................................................Failed
+- hook id: ruff
+- exit code: 1
+- files were modified by this hook
+
+Found 2 errors (2 fixed, 0 remaining).
+```
+
+Same as before, you can see that `chat_to_files.py` is both staged and not staged for commit. This is because `ruff` has formatted it and now it is different from the version you have in your working directory. To fix this you can simply run `git add chat_to_files.py` again and now you can commit your changes.
+
+```bash
+$ git add chat_to_files.py
+$ git commit -m "commit message"
+black....................................................................Passed
+ruff.....................................................................Passed
+fix end of files.........................................................Passed
+[pre-commit-setup f00c0ce] testing
+ 1 file changed, 1 insertion(+), 1 deletion(-)
+```
+
+Now your file has been committed and you can push your changes.
+
+At the beginning this might seem like a tedious process (having to add the file again after `black` and `ruff` have modified it) but it is actually very useful. It allows you to see what changes `black` and `ruff` have made to your files and make sure that they are correct before you commit them.
+
+### Important Note When `pre-commit` Fails in the Build Pipeline
+Sometimes `pre-commit` will seemingly run successfully, as follows:
+
+```bash
+black................................................(no files to check)Skipped
+ruff.................................................(no files to check)Skipped
+check toml...........................................(no files to check)Skipped
+check yaml...........................................(no files to check)Skipped
+detect private key...................................(no files to check)Skipped
+fix end of files.....................................(no files to check)Skipped
+trim trailing whitespace.............................(no files to check)Skipped
+```
+
+However, you may see `pre-commit` fail in the build pipeline upon submitting a PR.  The solution to this is to run `pre-commit run --all-files` to force `pre-commit` to execute these checks, and make any necessary file modifications, to all files.
+
+
+## Licensing
+
+By contributing to gpt-engineer, you agree that your contributions will be licensed under the [LICENSE](https://github.com/gpt-engineer-org/gpt-engineer/blob/main/LICENSE) file of the project.
+
+Thank you for your interest in contributing to gpt-engineer! We appreciate your support and look forward to your contributions.

.github/FUNDING.yml

@@ -0,0 +1,4 @@
+# These are supported funding model platforms
+
+github: [antonosika]
+patreon: gpt_eng

.github/ISSUE_TEMPLATE/bug-report.md

@@ -0,0 +1,32 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug, triage
+assignees: ''
+
+---
+
+## Policy and info
+ - Maintainers will close issues that have been stale for 14 days if they contain relevant answers.
+ - Adding the label "sweep" will automatically turn the issue into a coded pull request. Works best for mechanical tasks. More info/syntax at: https://docs.sweep.dev/
+
+## Expected Behavior
+
+Please describe the behavior you are expecting.
+
+## Current Behavior
+
+What is the current behavior?
+
+## Failure Information
+
+Information about the failure, including environment details, such as LLM used.
+
+### Failure Logs
+
+If your project includes a debug_log_file.txt, kindly upload it from your_project/.gpteng/memory/ directory. This file encompasses all the necessary logs. Should the file prove extensive, consider utilizing GitHub's "add files" functionality.
+
+## System Information
+
+Please copy and paste the output of the `gpte --sysinfo` command as part of your bug report.

.github/ISSUE_TEMPLATE/documentation-clarification.md

@@ -0,0 +1,19 @@
+---
+name: Documentation improvement
+about: Inaccuracies, inadequacies in the docs pages
+title: ''
+labels: documentation, triage
+assignees: ''
+
+---
+
+## Policy and info
+ - Maintainers will close issues that have been stale for 14 days if they contain relevant answers.
+ - Adding the label "sweep" will automatically turn the issue into a coded pull request. Works best for mechanical tasks. More info/syntax at: https://docs.sweep.dev/
+
+
+## Description
+A clear and concise description of how the documentation at https://gpt-engineer.readthedocs.io/en/latest/ is providing wrong/insufficient information.
+
+## Suggestion
+How can it be improved

.github/ISSUE_TEMPLATE/feature-request.md

@@ -0,0 +1,19 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement, triage
+assignees: ''
+
+---
+
+## Policy and info
+ - Maintainers will close issues that have been stale for 14 days if they contain relevant answers.
+ - Adding the label "sweep" will automatically turn the issue into a coded pull request. Works best for mechanical tasks. More info/syntax at: https://docs.sweep.dev/
+ - Consider adding the label "good first issue" for interesting, but easy features.
+
+## Feature description
+A clear and concise description of what you would like to have
+
+## Motivation/Application
+Why is this feature useful?

.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,9 @@
+**YOU MAY DELETE THE ENTIRE TEMPLATE BELOW.**
+
+## How Has This Been Tested?
+
+Please describe if you have either:
+
+- Generated the "example" project
+- Ran the entire benchmark suite
+- Something else

.github/workflows/automation.yml

@@ -0,0 +1,29 @@
+name: Automation Workflow
+
+on:
+  schedule:
+    - cron: '0 0 * * *'
+  issues:
+    types: [opened, edited, reopened]
+  pull_request:
+    types: [opened, edited, reopened]
+
+jobs:
+  mark-stale-issues:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Mark stale issues
+        uses: actions/stale@v4
+        with:
+          stale-issue-message: 'This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.'
+          days-before-stale: 60
+
+  # Add additional jobs as needed
+  # job-name:
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #     - name: Job step name
+  #       uses: action-name@version
+  #       with:
+  #         parameter1: value1
+  #

.github/workflows/ci.yaml

@@ -0,0 +1,49 @@
+name: Tox pytest all python versions
+
+on:
+  push:
+    branches: [ main ]
+    paths:
+      - gpt_engineer/**
+      - tests/**
+  pull_request:
+    branches: [ main ]
+
+concurrency:
+  group: ${{ github.workflow }} - ${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.10', '3.11', '3.12']
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version == '3.12' && '3.12.3' || matrix.python-version }} # Using 3.12.3 to resolve Pydantic ForwardRef issue
+        cache: 'pip'  # Note that pip is for the tox level. Poetry is still used for installing the specific environments (tox.ini)
+
+    - name: Check Python Version
+      run: python --version
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install tox==4.15.0 poetry
+
+    - name: Run tox
+      env:
+        OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
+      run: tox
+
+    # Temporarily disabling codecov until we resolve codecov rate limiting issue
+    # - name: Report coverage
+    #   run: |
+    #     bash <(curl -s https://codecov.io/bash)

.github/workflows/pre-commit.yaml

@@ -0,0 +1,22 @@
+name: pre-commit
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: actions/setup-python@v4
+
+      - uses: pre-commit/[email protected]
+        with:
+          extra_args: --all-files

.github/workflows/release.yaml

@@ -0,0 +1,73 @@
+name: Build and publish Python packages to PyPI
+
+on:
+  workflow_dispatch:
+  release:
+    types:
+      - published
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version:
+          - "3.10"
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+          # Removed the cache line that was here
+
+      # Install Poetry
+      - name: Install Poetry
+        run: |
+          curl -sSL https://install.python-poetry.org | python3 -
+
+      # Add Poetry to PATH
+      - name: Add Poetry to PATH
+        run: echo "$HOME/.local/bin" >> $GITHUB_PATH
+
+      # Cache Poetry's dependencies based on the lock file
+      - name: Set up Poetry cache
+        uses: actions/cache@v3
+        with:
+          path: ~/.cache/pypoetry
+          key: ${{ runner.os }}-poetry-${{ hashFiles('**/poetry.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-poetry-
+
+      # Install dependencies using Poetry (if any)
+      - name: Install dependencies
+        run: poetry install
+
+      # Build package using Poetry
+      - name: Build package
+        run: poetry build --format sdist
+
+      # Upload package as build artifact
+      - uses: actions/upload-artifact@v3
+        with:
+          name: package
+          path: dist/
+
+  publish:
+    runs-on: ubuntu-latest
+    needs: build
+    environment:
+      name: pypi
+      url: https://pypi.org/p/gpt-engineer
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v3
+        with:
+          name: package
+          path: dist/
+
+      - name: Publish packages to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}

.gitignore

@@ -0,0 +1,98 @@
+# See https://help.github.com/ignore-files/ for more about ignoring files.
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+.history/
+
+# Distribution / packaging
+dist/
+build/
+*.egg-info/
+*.egg
+
+# Virtual environments
+.env
+.env.sh
+venv/
+ENV/
+venv_test_installation/
+
+# IDE-specific files
+.vscode/
+.idea/
+
+# Compiled Python modules
+*.pyc
+*.pyo
+*.pyd
+
+# Python testing
+.pytest_cache/
+.ruff_cache/
+.mypy_cache/
+.coverage
+coverage.*
+
+# macOS specific files
+.DS_Store
+
+# Windows specific files
+Thumbs.db
+
+# this application's specific files
+archive
+
+# any log file
+*log.txt
+todo
+scratchpad
+
+# Pyenv
+.python-version
+
+.gpte_consent
+
+# projects folder apart from default prompt
+
+projects/*
+!projects/example/prompt
+!projects/example-improve
+!projects/example-vision
+
+# docs
+
+docs/_build
+docs/applications
+docs/benchmark
+docs/cli
+docs/core
+docs/intro
+docs/tools
+
+# coding assistants
+.aider*
+.gpteng
+
+# webapp specific
+webapp/node_modules
+webapp/package-lock.json
+
+webapp/.next/
+
+.langchain.db
+
+# TODO files
+/!todo*
+
+#ignore tox files
+.tox
+
+# locally saved datasets
+gpt_engineer/benchmark/benchmarks/apps/dataset
+gpt_engineer/benchmark/benchmarks/mbpp/dataset
+
+gpt_engineer/benchmark/minimal_bench_config.toml
+
+test.json

.pre-commit-config.yaml

@@ -0,0 +1,27 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+fail_fast: true
+default_stages: [commit]
+
+repos:
+  - repo: https://github.com/psf/black
+    rev: 23.3.0
+    hooks:
+      - id: black
+        args: [--config, pyproject.toml]
+        types: [python]
+
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: "v0.0.272"
+    hooks:
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+      - id: check-toml
+      - id: check-yaml
+      - id: detect-private-key
+      - id: end-of-file-fixer
+      - id: trailing-whitespace

.readthedocs.yaml

@@ -0,0 +1,39 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+    # You can also specify other tool versions:
+    # nodejs: "19"
+    # rust: "1.64"
+    # golang: "1.19"
+  jobs:
+    post_create_environment:
+      - pip install poetry
+    post_install:
+      - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry install --with docs
+    pre_build:
+      - python docs/create_api_rst.py
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+   configuration: docs/conf.py
+
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#    - pdf
+#    - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+#python:
+#   install:
+#   - requirements: docs/requirements.txt

Acknowledgements.md

@@ -0,0 +1,5 @@
+# We thank the following people for inspiration
+
+| Person | Content | File(s) | Source |
+|----|---|---|---|
+| Paul Gauthier | The prompt for the `improve code` step is strongly based on Paul's prompt in Aider | /preprompts/improve.txt | https://github.com/paul-gauthier/aider/blob/main/aider/coders/editblock_coder.py

DISCLAIMER.md

@@ -0,0 +1,11 @@
+# Disclaimer
+
+gpt-engineer is an experimental application and is provided "as-is" without any warranty, express or implied. By using this software, you agree to assume all risks associated with its use, including but not limited to data loss, system failure, or any other issues that may arise.
+
+The developers and contributors of this project do not accept any responsibility or liability for any losses, damages, or other consequences that may occur as a result of using this software. You are solely responsible for any decisions and actions taken based on the information provided by gpt-engineer.
+
+Please note that the use of the GPT-4 language model can be expensive due to its token usage. By utilizing this project, you acknowledge that you are responsible for monitoring and managing your own token usage and the associated costs. It is highly recommended to check your OpenAI API usage regularly and set up any necessary limits or alerts to prevent unexpected charges.
+
+As an autonomous experiment, gpt-engineer may generate code or take actions that are not in line with real-world business practices or legal requirements. It is your responsibility to ensure that any actions or decisions made by the generated code comply with all applicable laws, regulations, and ethical standards. The developers and contributors of this project shall not be held responsible for any consequences arising from the use of this software.
+
+By using gpt-engineer, you agree to indemnify, defend, and hold harmless the developers, contributors, and any affiliated parties from and against any and all claims, damages, losses, liabilities, costs, and expenses (including reasonable attorneys' fees) arising from your use of this software or your violation of these terms.

GOVERNANCE.md

@@ -0,0 +1,76 @@
+# Governance Model of GPT-Engineer
+
+## I. Project Board Structure
+
+### Project Board
+
+The Project Board is the central decision-making body for the project, overseeing both strategic and technical decisions of the open source project GPT-Engineer.
+
+#### Composition:
+- The Board consists of the project's founder, Anton Osika, and representatives from each significant contributing entity, including individual contributors and commercial partners.
+- The board is restricted to a maximum of 7 seats.
+- New board members are admitted by majority vote.
+- Board members may be expelled by majority vote.
+
+## II. Roles and Responsibilities
+
+### Veto due to Ethical Considerations
+- The founder has veto right over any decisions made by the Board.
+- This veto power is a safeguard to ensure the project's direction remains true to its original vision and ethos.
+
+### Contribution-Conditioned Decision Making
+- Each board member has one vote as long as they qualify as active contributors.
+- To qualify as an active contributor, a board member or the entity they represent, must have made 6 significant contributions on the GPT-Engineer GitHub page over the past 90 days.
+- A significant contribution is:
+  - A merged pull request with at least 3 lines of code.
+  - Engagement in a GitHub/Discord bug report, where the board members' input leads to the confirmed resolution of the bug. If the solution is in terms of a merged pull request, the bug resolution together with the merged pull request counts as one significant contribution.
+  - A non-code, but necessary, community activity agreed on by the board, such as administration, corporate design, workflow design etc, deemed to take more than 1 hour. Participation in meetings or discussions does not count as a significant contribution.
+- A board member may retain its seat on the board without voting right.
+
+## III. Decision-Making Process
+
+### Majority Voting
+- Decisions are made based on a simple majority vote. Majority means more than half of board members with voting rights agree on one decision, regardless of the number of choices.
+- The founder's veto can override the majority decision if exercised.
+
+### Regular Meetings and Reporting
+- The Board will convene regularly, with the frequency of meetings decided by the Board members.
+- Decisions, discussion points, and contributions will be transparently documented and shared within the project community.
+
+## IV. Data Access and Confidentiality
+
+### Board Members' Right to Access Data
+- Any confidential data collected by GPT-Engineer is accessible to the board members after signing a relevant non-disclosure agreement (NDA).
+- A relevant NDA requires a board member to erase any copies of confidential data obtained by the time of leaving the board.
+
+## V. Scope of Voting
+
+### Essential Topics
+- Board voting is restricted to essential topics.
+- Essential topics include essential technical topics and essential community topics.
+- An essential technical topic is a change in the GPT-engineer code base that is likely to introduce breaking changes, or significantly change the user experience for users and developers.
+- Essential community topics are changes to the community's governance or other central policy documents such as the readme or license.
+- Day-to-day tasks such as bug fixes or implementation of new features outside the core module do not require voting.
+
+## VI. Transparency
+
+### Commitment to Transparency
+- The governance process will be transparent, with key decisions, meeting minutes, and voting results publicly available, except for sensitive or confidential matters.
+
+## VII. Amendments
+
+### Changes to Governance Structure
+- The governance model can be revised as the project evolves. Proposals for changes can be made by any Board member and will require a majority vote for adoption.
+
+## VIII. The GPT-Engineer Brand
+
+### Copyright and Stewardship
+- The creator of GPT-engineer (Anton Osika) will be the steward of the GPT-engineer brand to decide when and how it can be used, and is committed to never jeopardizing the interest of the open source community in this stewardship.
+- Anton Osika possesses the exclusive intellectual property rights for the trademark 'GPT-engineer,' encompassing all case variations such as 'gpt-engineer,' 'GPT-engineer,' and 'GPTE.' This ownership extends to the exclusive legal authority to utilize the 'GPT-engineer' trademark in the establishment and branding of both commercial and non-profit entities. It includes, but is not limited to, the use of the trademark in business names, logos, marketing materials, and other forms of corporate identity. Any use of the 'GPT-engineer' trademark, in any of its case variations, by other parties for commercial or non-commercial purposes requires express permission or a license agreement from Anton Osika.
+
+# Current Board Members
+- Anton Osika
+- Axel Theorell
+- Corey Gallon
+- Peter Harrington
+- Theo McCabe

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Anton Osika
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

MANIFEST.in

@@ -0,0 +1 @@
+recursive-include gpt_engineer/preprompts *

Makefile

@@ -0,0 +1,52 @@
+#Sets the default shell for executing commands as /bin/bash and specifies command should be executed in a Bash shell.
+SHELL := /bin/bash
+
+# Color codes for terminal output
+COLOR_RESET=\033[0m
+COLOR_CYAN=\033[1;36m
+COLOR_GREEN=\033[1;32m
+
+# Defines the targets help, install, dev-install, and run as phony targets.
+.PHONY: help install run
+
+#sets the default goal to help when no target is specified on the command line.
+.DEFAULT_GOAL := help
+
+#Disables echoing of commands.
+.SILENT:
+
+#Sets the variable name to the second word from the MAKECMDGOALS.
+name := $(word 2,$(MAKECMDGOALS))
+
+#Defines a target named help.
+help:
+	@echo "Please use 'make <target>' where <target> is one of the following:"
+	@echo "  help           	Return this message with usage instructions."
+	@echo "  install        	Will install the dependencies using Poetry."
+	@echo "  run <folder_name>  Runs GPT Engineer on the folder with the given name."
+
+#Defines a target named install. This target will install the project using Poetry.
+install: poetry-install install-pre-commit farewell
+
+#Defines a target named poetry-install. This target will install the project dependencies using Poetry.
+poetry-install:
+	@echo -e "$(COLOR_CYAN)Installing project with Poetry...$(COLOR_RESET)" && \
+	poetry install
+
+#Defines a target named install-pre-commit. This target will install the pre-commit hooks.
+install-pre-commit:
+	@echo -e "$(COLOR_CYAN)Installing pre-commit hooks...$(COLOR_RESET)" && \
+	poetry run pre-commit install
+
+#Defines a target named farewell. This target will print a farewell message.
+farewell:
+	@echo -e "$(COLOR_GREEN)All done!$(COLOR_RESET)"
+
+#Defines a target named run. This target will run GPT Engineer on the folder with the given name.
+run:
+	@echo -e "$(COLOR_CYAN)Running GPT Engineer on $(COLOR_GREEN)$(name)$(COLOR_CYAN) folder...$(COLOR_RESET)" && \
+	poetry run gpt-engineer projects/$(name)
+
+# Counts the lines of code in the project
+cloc:
+	cloc . --exclude-dir=node_modules,dist,build,.mypy_cache,benchmark --exclude-list-file=.gitignore --fullpath --not-match-d='docs/_build' --by-file

README.md

@@ -1,12 +1,112 @@
----
-title: Gpt Eng
-emoji: 👁
-colorFrom: yellow
-colorTo: green
-sdk: gradio
-sdk_version: 4.38.1
-app_file: app.py
-pinned: false
----
-
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+# gpt-engineer
+
+[![GitHub Repo stars](https://img.shields.io/github/stars/gpt-engineer-org/gpt-engineer?style=social)](https://github.com/gpt-engineer-org/gpt-engineer)
+[![Discord Follow](https://dcbadge.vercel.app/api/server/8tcDQ89Ej2?style=flat)](https://discord.gg/8tcDQ89Ej2)
+[![License](https://img.shields.io/github/license/gpt-engineer-org/gpt-engineer)](https://github.com/gpt-engineer-org/gpt-engineer/blob/main/LICENSE)
+[![GitHub Issues or Pull Requests](https://img.shields.io/github/issues/gpt-engineer-org/gpt-engineer)](https://github.com/gpt-engineer-org/gpt-engineer/issues)
+![GitHub Release](https://img.shields.io/github/v/release/gpt-engineer-org/gpt-engineer)
+[![Twitter Follow](https://img.shields.io/twitter/follow/antonosika?style=social)](https://twitter.com/antonosika)
+
+gpt-engineer lets you:
+- Specify software in natural language
+- Sit back and watch as an AI writes and executes the code
+- Ask the AI to implement improvements
+
+## Getting Started
+
+### Install gpt-engineer
+
+For **stable** release:
+
+- `python -m pip install gpt-engineer`
+
+For **development**:
+- `git clone https://github.com/gpt-engineer-org/gpt-engineer.git`
+- `cd gpt-engineer`
+- `poetry install`
+- `poetry shell` to activate the virtual environment
+
+We actively support Python 3.10 - 3.12. The last version to support Python 3.8 - 3.9 was [0.2.6](https://pypi.org/project/gpt-engineer/0.2.6/).
+
+### Setup API key
+
+Choose **one** of:
+- Export env variable (you can add this to .bashrc so that you don't have to do it each time you start the terminal)
+    - `export OPENAI_API_KEY=[your api key]`
+- .env file:
+    - Create a copy of `.env.template` named `.env`
+    - Add your OPENAI_API_KEY in .env
+- Custom model:
+    - See [docs](https://gpt-engineer.readthedocs.io/en/latest/open_models.html), supports local model, azure, etc.
+
+Check the [Windows README](./WINDOWS_README.md) for Windows usage.
+
+**Other ways to run:**
+- Use Docker ([instructions](docker/README.md))
+- Do everything in your browser:
+[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/gpt-engineer-org/gpt-engineer/codespaces)
+
+### Create new code (default usage)
+- Create an empty folder for your project anywhere on your computer
+- Create a file called `prompt` (no extension) inside your new folder and fill it with instructions
+- Run `gpte <project_dir>` with a relative path to your folder
+  - For example: `gpte projects/my-new-project` from the gpt-engineer directory root with your new folder in `projects/`
+
+### Improve existing code
+- Locate a folder with code which you want to improve anywhere on your computer
+- Create a file called `prompt` (no extension) inside your new folder and fill it with instructions for how you want to improve the code
+- Run `gpte <project_dir> -i` with a relative path to your folder
+  - For example: `gpte projects/my-old-project -i` from the gpt-engineer directory root with your folder in `projects/`
+
+### Benchmark custom agents
+- gpt-engineer installs the binary 'bench', which gives you a simple interface for benchmarking your own agent implementations against popular public datasets.
+- The easiest way to get started with benchmarking is by checking out the [template](https://github.com/gpt-engineer-org/gpte-bench-template) repo, which contains detailed instructions and an agent template.
+- Currently supported benchmark:
+  - [APPS](https://github.com/hendrycks/apps)
+  - [MBPP](https://github.com/google-research/google-research/tree/master/mbpp)
+
+By running gpt-engineer, you agree to our [terms](https://github.com/gpt-engineer-org/gpt-engineer/blob/main/TERMS_OF_USE.md).
+
+
+## Relation to gptengineer.app (GPT Engineer)
+[gptengineer.app](https://gptengineer.app/) is a commercial project for the automatic generation of web apps.
+It features a UI for non-technical users connected to a git-controlled codebase.
+The gptengineer.app team is actively supporting the open source community.
+
+
+## Features
+
+### Pre Prompts
+You can specify the "identity" of the AI agent by overriding the `preprompts` folder with your own version of the `preprompts`. You can do so via the `--use-custom-preprompts` argument.
+
+Editing the `preprompts` is how you make the agent remember things between projects.
+
+### Vision
+
+By default, gpt-engineer expects text input via a `prompt` file. It can also accept image inputs for vision-capable models. This can be useful for adding UX or architecture diagrams as additional context for GPT Engineer. You can do this by specifying an image directory with the `—-image_directory` flag and setting a vision-capable model in the second CLI argument.
+
+E.g. `gpte projects/example-vision gpt-4-vision-preview --prompt_file prompt/text --image_directory prompt/images -i`
+
+### Open source, local and alternative models
+
+By default, gpt-engineer supports OpenAI Models via the OpenAI API or Azure OpenAI API, as well as Anthropic models.
+
+With a little extra setup, you can also run with open source models like WizardCoder. See the [documentation](https://gpt-engineer.readthedocs.io/en/latest/open_models.html) for example instructions.
+
+## Mission
+
+The gpt-engineer community mission is to **maintain tools that coding agent builders can use and facilitate collaboration in the open source community**.
+
+If you are interested in contributing to this, we are interested in having you.
+
+If you want to see our broader ambitions, check out the [roadmap](https://github.com/gpt-engineer-org/gpt-engineer/blob/main/ROADMAP.md), and join
+[discord](https://discord.gg/8tcDQ89Ej2)
+to learn how you can [contribute](.github/CONTRIBUTING.md) to it.
+
+gpt-engineer is [governed](https://github.com/gpt-engineer-org/gpt-engineer/blob/main/GOVERNANCE.md) by a board of long-term contributors. If you contribute routinely and have an interest in shaping the future of gpt-engineer, you will be considered for the board.
+
+## Example
+
+
+
+https://github.com/gpt-engineer-org/gpt-engineer/assets/4467025/40d0a9a8-82d0-4432-9376-136df0d57c99

ROADMAP.md

@@ -0,0 +1,31 @@
+# Roadmap
+
+<img width="800" alt="image" src="https://github.com/gpt-engineer-org/gpt-engineer/assets/48092564/06bce891-00ef-4052-bbbd-77af8b843fff">
+
+
+This document is a general roadmap guide to the gpt-engineer project's strategic direction.
+Our goal is to continually improve by focusing on three main pillars:
+- User Experience,
+- Technical Features, and
+- Performance Tracking/Testing.
+
+Each pillar is supported by a set of epics, reflecting our major goals and initiatives.
+
+
+## Tracking Progress with GitHub Projects
+
+We are using [GitHub Projects](https://github.com/orgs/gpt-engineer-org/projects/3) to track the progress of our roadmap.
+
+Each issue within our project is categorized under one of the main pillars and, in most cases, associated epics. You can check our [Project's README](https://github.com/orgs/gpt-engineer-org/projects/3?pane=info) section to understand better our logic and organization.
+
+
+
+# How you can help out
+
+You can:
+
+- Post a "design" as a Google Doc in our [Discord](https://discord.com/channels/1119885301872070706/1120698764445880350), and ask for feedback to address one of the items in the roadmap
+- Submit PRs to address one of the items in the roadmap
+- Do a review of someone else's PR and propose next steps (further review, merge, close)
+
+🙌 Volunteer work in any of these will get acknowledged.🙌

TERMS_OF_USE.md

@@ -0,0 +1,13 @@
+# Terms of Use
+
+Welcome to gpt-engineer! By utilizing this powerful tool, you acknowledge and agree to the following comprehensive Terms of Use. We also encourage you to review the linked [disclaimer of warranty](https://github.com/gpt-engineer-org/gpt-engineer/blob/main/DISCLAIMER.md) for additional information.
+
+Both OpenAI, L.L.C. and the dedicated creators behind the remarkable gpt-engineer have implemented a data collection process focused on enhancing the product's capabilities. This endeavor is undertaken with utmost care and dedication to safeguarding user privacy. Rest assured that no information that could be directly attributed to any individual is stored.
+
+It's important to be aware that the utilization of natural text inputs, including the 'prompt' and 'feedback' files, may be subject to storage. While it's theoretically possible to establish connections between a person's writing style or content within these files and their real-life identity, please note that the creators of gpt-engineer explicitly assure that such attempts will never be made.
+
+For a deeper understanding of OpenAI's overarching terms of use, we encourage you to explore the details available [here](https://openai.com/policies/terms-of-use).
+
+Optionally, gpt-engineer collects usage data for the purpose of improving gpt-engineer. Data collection only happens when a consent file called .gpte_consent is present in the gpt-engineer directory. Note that gpt-engineer cannot prevent that data streams passing through gpt-engineer to a third party may be stored by that third party (for example OpenAI).
+
+Your engagement with gpt-engineer is an acknowledgment and acceptance of these terms, demonstrating your commitment to using this tool responsibly and within the bounds of ethical conduct. We appreciate your trust and look forward to the exciting possibilities that gpt-engineer can offer in your endeavors.

WINDOWS_README.md

@@ -0,0 +1,68 @@
+# Windows Setup
+## Short version
+
+On Windows, follow the standard [README.md](https://github.com/gpt-engineer-org/gpt-engineer/blob/main/README.md), but to set API key do one of:
+- `set OPENAI_API_KEY=[your api key]` on cmd
+- `$env:OPENAI_API_KEY="[your api key]"` on powershell
+
+## Full setup guide
+
+Choose either **stable** or **development**.
+
+For **stable** release:
+
+Run `pip install gpt-engineer` in the command line as an administrator
+
+Or:
+
+  1. Open your web browser and navigate to the Python Package Index (PyPI) website: <https://pypi.org/project/gpt-engineer/>.
+  2. On the PyPI page for the gpt-engineer package, locate the "Download files" section. Here you'll find a list of available versions and their corresponding download links.
+  3. Identify the version of gpt-engineer you want to install and click on the associated download link. This will download the package file (usually a .tar.gz or .whl file) to your computer.
+  4. Once the package file is downloaded, open your Python development environment or IDE.
+  5. In your Python development environment, look for an option to install packages or manage dependencies. The exact location and terminology may vary depending on your IDE. For example, in PyCharm, you can go to "File" > "Settings" > "Project: \<project-name>" > "Python Interpreter" to manage packages.
+  6. In the package management interface, you should see a list of installed packages. Look for an option to add or install a new package.
+  7. Click on the "Add Package" or "Install Package" button.
+  8. In the package installation dialog, choose the option to install from a file or from a local source.
+  9. Browse and select the downloaded gpt-engineer package file from your computer.
+
+For **development**:
+
+- `git clone [email protected]:gpt-engineer-org/gpt-engineer.git`
+- `cd gpt-engineer`
+- `poetry install`
+- `poetry shell` to activate the virtual environment
+
+### Setup
+
+With an api key from OpenAI:
+
+Run `set OPENAI_API_KEY=[your API key]` in the command line
+
+Or:
+
+  1. In the Start Menu, type to search for "Environment Variables" and click on "Edit the system environment variables".
+  2. In the System Properties window, click on the "Environment Variables" button.
+  3. In the Environment Variables window, you'll see two sections: User variables and System variables.
+  4. To set a user-specific environment variable, select the "New" button under the User variables section.
+  5. To set a system-wide environment variable, select the "New" button under the System variables section.
+  6. Enter the variable name "OPENAI_API_KEY" in the "Variable name" field.
+  7. Enter the variable value (e.g., your API key) in the "Variable value" field.
+  8. Click "OK" to save the changes.
+  9. Close any open command prompt or application windows and reopen them for the changes to take effect.
+
+Now you can use `%OPENAI_API_KEY%` when prompted to input your key.
+
+### Run
+
+- Create an empty folder. If inside the repo, you can:
+  - Run `xcopy /E projects\example projects\my-new-project` in the command line
+  - Or hold CTRL and drag the folder down to create a copy, then rename to fit your project
+- Fill in the `prompt` file in your new folder
+- `gpt-engineer projects/my-new-project`
+  - (Note, `gpt-engineer --help` lets you see all available options. For example `--steps use_feedback` lets you improve/fix code in a project)
+
+By running gpt-engineer you agree to our [ToS](https://github.com/gpt-engineer-org/gpt-engineer/blob/main/TERMS_OF_USE.md).
+
+### Results
+
+- Check the generated files in `projects/my-new-project/workspace`

citation.cff

@@ -0,0 +1,10 @@
+cff-version: 1.0.0
+message: "If you use this software, please cite it as below."
+authors:
+  - family-names: Osika
+    given-names: Anton
+title: gpt-engineer
+version: 0.1.0
+date-released: 2023-04-23
+repository-code: https://github.com/gpt-engineer-org/gpt-engineer
+url: https://gpt-engineer.readthedocs.io

docker-compose.yml

@@ -0,0 +1,16 @@
+services:
+  gpt-engineer:
+    build:
+      context: .
+      dockerfile: docker/Dockerfile
+    stdin_open: true
+    tty: true
+    # Set the API key from the .env file
+    env_file:
+      - .env
+    ##  OR set the API key directly
+    # environment:
+      # - OPENAI_API_KEY=YOUR_API_KEY
+    image: gpt-engineer
+    volumes:
+      - ./projects/example:/project

docker/Dockerfile

@@ -0,0 +1,29 @@
+# Stage 1: Builder stage
+FROM python:3.11-slim AS builder
+
+RUN apt-get update && apt-get install -y --no-install-recommends \
+  tk \
+  tcl \
+  curl \
+  git \
+  && rm -rf /var/lib/apt/lists/*
+
+WORKDIR /app
+
+COPY . .
+
+RUN pip install --no-cache-dir -e .
+
+# Stage 2: Final stage
+FROM python:3.11-slim
+
+WORKDIR /app
+
+COPY --from=builder /usr/local/lib/python3.11/site-packages /usr/local/lib/python3.11/site-packages
+COPY --from=builder /usr/local/bin /usr/local/bin
+COPY --from=builder /usr/bin /usr/bin
+COPY --from=builder /app .
+
+COPY docker/entrypoint.sh .
+
+ENTRYPOINT ["bash", "/app/entrypoint.sh"]

docker/README.md

@@ -0,0 +1,69 @@
+# Getting Started Using Docker
+
+This guide provides step-by-step instructions on how to set up and run the Docker environment for your GPT-Engineer project.
+
+## Prerequisites
+
+- Docker installed on your machine.
+- Git (for cloning the repository).
+
+## Setup Instructions
+
+### Using Docker CLI
+
+1. **Clone the Repository**
+
+    ```bash
+    git clone https://github.com/gpt-engineer-org/gpt-engineer.git
+    cd gpt-engineer
+    ```
+
+2. **Build the Docker Image**
+
+    ```bash
+    docker build --rm -t gpt-engineer -f docker/Dockerfile .
+    ```
+
+3. **Run the Docker Container**
+
+    ```bash
+    docker run -it --rm -e OPENAI_API_KEY="YOUR_OPENAI_KEY" -v ./your-project:/project gpt-engineer
+    ```
+
+    Replace `YOUR_OPENAI_KEY` with your actual OpenAI API key. The `-v` flag mounts your local `your-project` directory inside the container. Replace this with your actual project directory.  Ensure this directory contains all necessary files, including the `prompt` file.
+
+### Using Docker Compose
+
+1. **Clone the Repository** (if not already done)
+
+    ```bash
+    git clone https://github.com/gpt-engineer-org/gpt-engineer.git
+    cd gpt-engineer
+    ```
+
+2. **Build and Run using Docker Compose**
+
+    ```bash
+    docker-compose -f docker-compose.yml build
+    docker-compose run --rm gpt-engineer
+    ```
+
+    Set the `OPENAI_API_KEY` in the `docker/docker-compose.yml` using an `.env` file or as an environment variable. Mount your project directory to the container using volumes, e.g., `"./projects/example:/project"` where `./projects/example` is the path to your project directory.
+
+3. **Another alternative using Docker Compose**
+
+    Since there is only one `docker-compose.yml` file, you could run it without the -f option.
+    - `docker compose up -d --build` - To build and start the containers defined in your `docker-compose.yml` file in detached mode
+    - `docker compose up -d` - To start the containers defined in your `docker-compose.yml` file in detached mode
+    - `docker compose down` - To stop and remove all containers, networks, and volumes associated with the `docker-compose.yml`
+    - `docker compose restart` - To restart the containers defined in the `docker-compose.yml` file
+
+## Debugging
+
+To facilitate debugging, you can run a shell inside the built Docker image:
+
+```bash
+docker run -it --entrypoint /bin/bash gpt-engineer
+```
+
+This opens a shell inside the Docker container, allowing you to execute commands and inspect the environment manually.

docker/entrypoint.sh

@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+# -*- coding: utf-8 -*-
+
+project_dir="/project"
+
+# Run the gpt engineer script
+gpt-engineer $project_dir "$@"
+
+# Patch the permissions of the generated files to be owned by nobody except prompt file
+find "$project_dir" -mindepth 1 -maxdepth 1 ! -path "$project_dir/prompt" -exec chown -R nobody:nogroup {} + -exec chmod -R 777 {} +

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = python -msphinx
+SPHINXPROJ    = gpt_engineer
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/api_reference.rst

@@ -0,0 +1,144 @@
+.. _api_reference:
+
+=============
+API Reference
+=============
+
+:mod:`gpt_engineer.applications`: Applications
+===============================================
+
+.. automodule:: gpt_engineer.applications
+    :no-members:
+    :no-inherited-members:
+
+Classes
+--------------
+.. currentmodule:: gpt_engineer
+
+.. autosummary::
+    :toctree: applications
+    :template: class.rst
+
+    applications.cli.cli_agent.CliAgent
+    applications.cli.file_selector.DisplayablePath
+
+Functions
+--------------
+.. currentmodule:: gpt_engineer
+
+.. autosummary::
+    :toctree: applications
+
+    applications.cli.collect.collect_and_send_human_review
+    applications.cli.collect.collect_learnings
+    applications.cli.collect.send_learning
+    applications.cli.learning.ask_collection_consent
+    applications.cli.learning.ask_for_valid_input
+    applications.cli.learning.check_collection_consent
+    applications.cli.learning.extract_learning
+    applications.cli.learning.get_session
+    applications.cli.learning.human_review_input
+    applications.cli.main.get_preprompts_path
+    applications.cli.main.load_env_if_needed
+    applications.cli.main.load_prompt
+    applications.cli.main.main
+
+:mod:`gpt_engineer.benchmark`: Benchmark
+=========================================
+
+.. automodule:: gpt_engineer.benchmark
+    :no-members:
+    :no-inherited-members:
+
+Functions
+--------------
+.. currentmodule:: gpt_engineer
+
+.. autosummary::
+    :toctree: benchmark
+
+    benchmark.__main__.get_agent
+    benchmark.__main__.main
+    benchmark.benchmarks.gpteng.eval_tools.assert_exists_in_source_code
+    benchmark.benchmarks.gpteng.eval_tools.check_evaluation_component
+    benchmark.benchmarks.gpteng.eval_tools.check_language
+    benchmark.benchmarks.gpteng.eval_tools.run_code_class_has_property
+    benchmark.benchmarks.gpteng.eval_tools.run_code_class_has_property_w_value
+    benchmark.benchmarks.gpteng.eval_tools.run_code_eval_function
+    benchmark.benchmarks.gpteng.load.eval_to_task
+    benchmark.benchmarks.gpteng.load.expect_to_assertion
+    benchmark.benchmarks.gpteng.load.load_gpteng
+    benchmark.benchmarks.gptme.load.load_gptme
+    benchmark.benchmarks.load.get_benchmark
+    benchmark.run.print_results
+    benchmark.run.run
+
+:mod:`gpt_engineer.core`: Core
+===============================
+
+.. automodule:: gpt_engineer.core
+    :no-members:
+    :no-inherited-members:
+
+Classes
+--------------
+.. currentmodule:: gpt_engineer
+
+.. autosummary::
+    :toctree: core
+    :template: class.rst
+
+    core.base_agent.BaseAgent
+    core.base_execution_env.BaseExecutionEnv
+    core.default.disk_execution_env.DiskExecutionEnv
+    core.default.disk_memory.DiskMemory
+    core.default.simple_agent.SimpleAgent
+    core.files_dict.FilesDict
+    core.version_manager.BaseVersionManager
+
+Functions
+--------------
+.. currentmodule:: gpt_engineer
+
+.. autosummary::
+    :toctree: core
+
+    core.ai.serialize_messages
+    core.chat_to_files.apply_diffs
+    core.chat_to_files.chat_to_files_dict
+    core.chat_to_files.parse_diff_block
+    core.chat_to_files.parse_diffs
+    core.chat_to_files.parse_hunk_header
+    core.default.paths.memory_path
+    core.default.paths.metadata_path
+    core.default.simple_agent.default_config_agent
+    core.default.steps.curr_fn
+    core.default.steps.execute_entrypoint
+    core.default.steps.gen_code
+    core.default.steps.gen_entrypoint
+    core.default.steps.improve
+    core.default.steps.salvage_correct_hunks
+    core.default.steps.setup_sys_prompt
+    core.default.steps.setup_sys_prompt_existing_code
+    core.diff.count_ratio
+    core.diff.is_similar
+    core.files_dict.file_to_lines_dict
+
+:mod:`gpt_engineer.tools`: Tools
+=================================
+
+.. automodule:: gpt_engineer.tools
+    :no-members:
+    :no-inherited-members:
+
+Functions
+--------------
+.. currentmodule:: gpt_engineer
+
+.. autosummary::
+    :toctree: tools
+
+    tools.custom_steps.clarified_gen
+    tools.custom_steps.get_platform_info
+    tools.custom_steps.lite_gen
+    tools.custom_steps.self_heal

docs/code_conduct_link.rst

@@ -0,0 +1,2 @@
+.. include:: ../.github/CODE_OF_CONDUCT.md
+   :parser: myst_parser.sphinx_

docs/conf.py

@@ -0,0 +1,204 @@
+#!/usr/bin/env python
+#
+# file_processor documentation build configuration file, created by
+# sphinx-quickstart on Fri Jun  9 13:47:02 2017.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# If extensions (or modules to document with autodoc) are in another
+# directory, add these directories to sys.path here. If the directory is
+# relative to the documentation root, use os.path.abspath to make it
+# absolute, like shown here.
+#
+import os
+import sys
+
+from pathlib import Path
+
+import toml
+
+sys.path.insert(0, os.path.abspath(".."))
+
+ROOT_DIR = Path(__file__).parents[1].absolute()
+
+with open("../pyproject.toml") as f:
+    data = toml.load(f)
+
+
+# The master toctree document.
+master_doc = "index"
+
+# General information about the project.
+project = data["tool"]["poetry"]["name"]
+copyright = "2023 Anton Osika"
+author = " Anton Osika & Contributors"
+
+# The version info for the project you're documenting, acts as replacement
+# for |version| and |release|, also used in various other places throughout
+# the built documents.
+#
+# The short X.Y version.
+version = data["tool"]["poetry"]["version"]
+# The full version, including alpha/beta/rc tags.
+release = data["tool"]["poetry"]["version"]
+
+
+# -- General configuration ---------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autodoc.typehints",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.viewcode",
+    "sphinx_copybutton",
+    "myst_parser",
+    "IPython.sphinxext.ipython_console_highlighting",
+]
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+
+source_suffix = [".rst", ".md"]
+
+autodoc_pydantic_model_show_json = False
+autodoc_pydantic_field_list_validators = False
+autodoc_pydantic_config_members = False
+autodoc_pydantic_model_show_config_summary = False
+autodoc_pydantic_model_show_validator_members = False
+autodoc_pydantic_model_show_validator_summary = False
+autodoc_pydantic_model_signature_prefix = "class"
+autodoc_pydantic_field_signature_prefix = "param"
+autodoc_member_order = "groupwise"
+autoclass_content = "both"
+autodoc_typehints_format = "short"
+
+autodoc_default_options = {
+    "members": True,
+    "show-inheritance": True,
+    "inherited-members": "BaseModel",
+    "undoc-members": False,
+}
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+
+# source_suffix = '.rst'
+
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = "en"
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = "sphinx"
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+
+# -- Options for HTML output -------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+# html_theme = 'alabaster'
+html_theme = "sphinx_rtd_theme"
+
+# Theme options are theme-specific and customize the look and feel of a
+# theme further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+# html_static_path = ["_static"]
+
+
+# -- Options for HTMLHelp output ---------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = "gpt_engineerdoc"
+
+
+# -- Options for LaTeX output ------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass
+# [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, "gpt_engineer.tex", "GPT-ENgineer Documentation", "manual"),
+]
+
+
+# -- Options for manual page output ------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [(master_doc, "gpt_engineer", "GPT-Engineer Documentation", [author], 1)]
+
+
+# -- Options for Texinfo output ----------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (
+        master_doc,
+        "gpt_engineer",
+        "GPT-Engineer Documentation",
+        author,
+        "gpt_engineer",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
+]
+
+# generate autosummary even if no references
+autosummary_generate = True
+
+myst_enable_extensions = [
+    "colon_fence",
+]
+
+myst_all_links_external = True

docs/contributing_link.rst

@@ -0,0 +1,2 @@
+.. include:: ../.github/CONTRIBUTING.md
+   :parser: myst_parser.sphinx_

docs/create_api_rst.py

@@ -0,0 +1,98 @@
+"""Script for auto-generating api_reference.rst"""
+import glob
+import re
+
+from pathlib import Path
+
+ROOT_DIR = Path(__file__).parents[1].absolute()
+print(ROOT_DIR)
+PKG_DIR = ROOT_DIR / "gpt_engineer"
+WRITE_FILE = Path(__file__).parent / "api_reference.rst"
+
+
+def load_members() -> dict:
+    members: dict = {}
+    for py in glob.glob(str(PKG_DIR) + "/**/*.py", recursive=True):
+        module = py[len(str(PKG_DIR)) + 1 :].replace(".py", "").replace("/", ".")
+        top_level = module.split(".")[0]
+        if top_level not in members:
+            members[top_level] = {"classes": [], "functions": []}
+        with open(py, "r") as f:
+            for line in f.readlines():
+                cls = re.findall(r"^class ([^_].*)\(", line)
+                members[top_level]["classes"].extend([module + "." + c for c in cls])
+                func = re.findall(r"^def ([^_].*)\(", line)
+                afunc = re.findall(r"^async def ([^_].*)\(", line)
+                func_strings = [module + "." + f for f in func + afunc]
+                members[top_level]["functions"].extend(func_strings)
+    return members
+
+
+def construct_doc(members: dict) -> str:
+    full_doc = """\
+.. _api_reference:
+
+=============
+API Reference
+=============
+
+"""
+    for module, _members in sorted(members.items(), key=lambda kv: kv[0]):
+        classes = _members["classes"]
+        functions = _members["functions"]
+        if not (classes or functions):
+            continue
+
+        module_title = module.replace("_", " ").title()
+        if module_title == "Llms":
+            module_title = "LLMs"
+        section = f":mod:`gpt_engineer.{module}`: {module_title}"
+        full_doc += f"""\
+{section}
+{'=' * (len(section) + 1)}
+
+.. automodule:: gpt_engineer.{module}
+    :no-members:
+    :no-inherited-members:
+
+"""
+
+        if classes:
+            cstring = "\n    ".join(sorted(classes))
+            full_doc += f"""\
+Classes
+--------------
+.. currentmodule:: gpt_engineer
+
+.. autosummary::
+    :toctree: {module}
+    :template: class.rst
+
+    {cstring}
+
+"""
+        if functions:
+            fstring = "\n    ".join(sorted(functions))
+            full_doc += f"""\
+Functions
+--------------
+.. currentmodule:: gpt_engineer
+
+.. autosummary::
+    :toctree: {module}
+
+    {fstring}
+
+"""
+    return full_doc
+
+
+def main() -> None:
+    members = load_members()
+    full_doc = construct_doc(members)
+    with open(WRITE_FILE, "w") as f:
+        f.write(full_doc)
+
+
+if __name__ == "__main__":
+    main()

docs/disclaimer_link.rst

@@ -0,0 +1,2 @@
+.. include:: ../DISCLAIMER.md
+   :parser: myst_parser.sphinx_

docs/docs_building.md

@@ -0,0 +1,64 @@
+Building Docs with Sphinx
+=========================
+
+This example shows a basic Sphinx docs project with Read the Docs. This project is using `sphinx` with `readthedocs`
+project template.
+
+Some useful links are given below to lear and contribute in the project.
+
+📚 [docs/](https://www.sphinx-doc.org/en/master/usage/quickstart.html)<br>
+A basic Sphinx project lives in `docs/`, it was generated using Sphinx defaults. All the `*.rst` & `*.md` make up sections in the documentation. Both `.rst` and `.md` formats are supported in this project
+
+⚙️ [.readthedocs.yaml](https://docs.readthedocs.io/en/stable/config-file/v2.html)<br>
+Read the Docs Build configuration is stored in `.readthedocs.yaml`.
+
+
+Example Project usage
+---------------------
+
+``Poetry`` is the package manager for ``gpt-engineer``. In order to build documentation, we have to add docs requirements in
+development environment.
+
+This project has a standard readthedocs layout which is built by Read the Docs almost the same way that you would build it
+locally (on your own laptop!).
+
+You can build and view this documentation project locally - we recommend that you activate a ``poetry shell``.
+
+Update ``repository_stats.md`` file under ``docs/intro``
+
+```console
+# Install required Python dependencies (MkDocs etc.)
+poetry install
+cd docs/
+
+# Create the `api_reference.rst`
+python create_api_rst.py
+
+# Build the docs
+make html
+
+## Alternatively, to rebuild the docs on changes with live-reload in the browser
+sphinx-autobuild . _build/html
+```
+
+Project Docs Structure
+----------------------
+If you are new to Read the Docs, you may want to refer to the [Read the Docs User documentation](https://docs.readthedocs.io/).
+
+Below is the rundown of documentation structure for `pandasai`, you need to know:
+
+1. place your `docs/` folder alongside your Python project.
+2. copy `.readthedocs.yaml` and the `docs/` folder into your project root.
+3. `docs/api_reference.rst` contains the API documentation created using `docstring`.  Run the `create_api_rst.py` to update the API reference file.
+4. Project is using standard Google Docstring Style.
+5. Rebuild the documentation locally to see that it works.
+6. Documentation are hosted on [Read the Docs tutorial](https://docs.readthedocs.io/en/stable/tutorial/)
+
+
+Read the Docs tutorial
+----------------------
+
+To get started with Read the Docs, you may also refer to the
+[Read the Docs tutorial](https://docs.readthedocs.io/en/stable/tutorial/). I
+
+With every release, build the documentation manually.

docs/examples/open_llms/README.md

@@ -0,0 +1,56 @@
+# Test that the Open LLM is running
+
+First start the server by using only CPU:
+
+```bash
+export model_path="TheBloke/CodeLlama-13B-GGUF/codellama-13b.Q8_0.gguf"
+python -m llama_cpp.server --model $model_path
+```
+
+Or with GPU support (recommended):
+
+```bash
+python -m llama_cpp.server --model TheBloke/CodeLlama-13B-GGUF/codellama-13b.Q8_0.gguf --n_gpu_layers 1
+```
+
+If you have more `GPU` layers available set `--n_gpu_layers` to the higher number.
+
+To find the amount of available  run the above command and look for `llm_load_tensors: offloaded 1/41 layers to GPU` in the output.
+
+## Test API call
+
+Set the environment variables:
+
+```bash
+export OPENAI_API_BASE="http://localhost:8000/v1"
+export OPENAI_API_KEY="sk-xxx"
+export MODEL_NAME="CodeLlama"
+````
+
+Then ping the model via `python` using `OpenAI` API:
+
+```bash
+python examples/open_llms/openai_api_interface.py
+```
+
+If you're not using `CodeLLama` make sure to change the `MODEL_NAME` parameter.
+
+Or using `curl`:
+
+```bash
+curl --request POST \
+     --url http://localhost:8000/v1/chat/completions \
+     --header "Content-Type: application/json" \
+     --data '{ "model": "CodeLlama", "prompt": "Who are you?", "max_tokens": 60}'
+```
+
+If this works also make sure that `langchain` interface works since that's how `gpte` interacts with LLMs.
+
+## Langchain test
+
+```bash
+export MODEL_NAME="CodeLlama"
+python examples/open_llms/langchain_interface.py
+```
+
+That's it 🤓 time to go back [to](/docs/open_models.md#running-the-example) and give `gpte` a try.

docs/examples/open_llms/langchain_interface.py

@@ -0,0 +1,17 @@
+import os
+
+from langchain.callbacks.streaming_stdout import StreamingStdOutCallbackHandler
+from langchain_openai import ChatOpenAI
+
+model = ChatOpenAI(
+    model=os.getenv("MODEL_NAME"),
+    temperature=0.1,
+    callbacks=[StreamingStdOutCallbackHandler()],
+    streaming=True,
+)
+
+prompt = (
+    "Provide me with only the code for a simple python function that sums two numbers."
+)
+
+model.invoke(prompt)

docs/examples/open_llms/openai_api_interface.py

@@ -0,0 +1,21 @@
+import os
+
+from openai import OpenAI
+
+client = OpenAI(
+    base_url=os.getenv("OPENAI_API_BASE"), api_key=os.getenv("OPENAI_API_KEY")
+)
+
+response = client.chat.completions.create(
+    model=os.getenv("MODEL_NAME"),
+    messages=[
+        {
+            "role": "user",
+            "content": "Provide me with only the code for a simple python function that sums two numbers.",
+        },
+    ],
+    temperature=0.7,
+    max_tokens=200,
+)
+
+print(response.choices[0].message.content)

docs/index.rst

@@ -0,0 +1,41 @@
+Welcome to GPT-ENGINEER's Documentation
+=======================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: GET STARTED:
+
+   introduction.md
+   installation
+   quickstart
+
+.. toctree::
+   :maxdepth: 2
+   :caption: USER GUIDES:
+
+   windows_readme_link
+   open_models.md
+   tracing_debugging.md
+
+.. toctree::
+   :maxdepth: 2
+   :caption: CONTRIBUTE:
+
+   contributing_link
+   roadmap_link
+   code_conduct_link
+   disclaimer_link
+   docs_building.md
+   terms_link
+
+.. toctree::
+   :maxdepth: 2
+   :caption: PACKAGE API:
+
+   api_reference
+
+Indices and tables
+==================
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/installation.rst

@@ -0,0 +1,63 @@
+.. highlight:: shell
+
+============
+Installation
+============
+
+
+Stable release
+--------------
+
+To install ``gpt-engineer``, run this command in your terminal:
+
+.. code-block:: console
+
+    $ python -m pip install gpt-engineer
+
+This is the preferred method to install ``gpt-engineer``, as it will always install the most recent stable release.
+
+If you don't have `pip`_ installed, this `Python installation guide`_ can guide
+you through the process.
+
+.. _pip: https://pip.pypa.io
+.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/
+
+
+From sources
+------------
+
+The sources for ``gpt-engineer`` can be downloaded from the `Github repo`_.
+
+You can either clone the public repository:
+
+.. code-block:: console
+
+    $ git clone https://github.com/gpt-engineer-org/gpt-engineer.git
+
+Once you have a copy of the source, you can install it with:
+
+.. code-block:: console
+
+    $ cd gpt-engineer
+    $ poetry install
+    $ poetry shell
+
+
+.. _Github repo: https://github.com/gpt-engineer-org/gpt-engineer.git
+
+Troubleshooting
+---------------
+
+For mac and linux system, there are sometimes slim python installations that do not include the ``gpt-engineer`` requirement tkinter, which is a standard library and thus not pip installable.
+
+To install tkinter on mac, you can for example use brew:
+
+.. code-block:: console
+
+    $ brew install python-tk
+
+On debian-based linux systems you can use:
+
+.. code-block:: console
+
+    $ sudo apt-get install python3-tk

docs/introduction.md

@@ -0,0 +1,20 @@
+# Introduction
+``gpt-engineer`` is a project that uses LLMs (such as GPT-4) to automate the process of software engineering. It includes several Python scripts that interact with the LLM to generate code, clarify requirements, generate specifications, and more.
+
+<br>
+
+## Get started
+[Here’s](/en/latest/installation.html) how to install ``gpt-engineer``, set up your environment, and start building.
+
+We recommend following our [Quickstart](/en/latest/quickstart.html) guide to familiarize yourself with the framework by building your first application with ``gpt-engineer``.
+
+<br>
+
+## Example
+You can find an example of the project in action here.
+
+<video width="100%" controls>
+  <source src="https://github.com/gpt-engineer-org/gpt-engineer/assets/4467025/6e362e45-4a94-4b0d-973d-393a31d92d9b
+" type="video/mp4">
+  Your browser does not support the video tag.
+</video>

docs/make.bat

@@ -0,0 +1,36 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=python -msphinx
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+set SPHINXPROJ=file_processor
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The Sphinx module was not found. Make sure you have Sphinx installed,
+	echo.then set the SPHINXBUILD environment variable to point to the full
+	echo.path of the 'sphinx-build' executable. Alternatively you may add the
+	echo.Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd

docs/open_models.md

@@ -0,0 +1,148 @@
+Using with open/local models
+============================
+
+**Use `gpte` first with OpenAI models to get a feel for the `gpte` tool.**
+
+**Then go play with experimental Open LLMs 🐉 support and try not to get 🔥!!**
+
+At the moment the best option for coding is still the use of `gpt-4` models provided by OpenAI. But open models are catching up and are a good free and privacy-oriented alternative if you possess the proper hardware.
+
+You can integrate `gpt-engineer` with open-source models by leveraging an OpenAI-compatible API.
+
+We provide the minimal and cleanest solution below. What is described is not the only way to use open/local models, but the one we tested and would recommend to most users.
+
+More details on why the solution below is recommended in [this blog post](https://zigabrencic.com/blog/2024-02-21).
+
+Setup
+-----
+
+For inference engine we recommend for the users to use [llama.cpp](https://github.com/ggerganov/llama.cpp) with its `python` bindings `llama-cpp-python`.
+
+We choose `llama.cpp` because:
+
+- 1.) It supports the largest amount of hardware acceleration backends.
+- 2.) It supports the diverse set of open LLMs.
+- 3.) Is written in `python` and directly on top of `llama.cpp` inference engine.
+- 4.) Supports the `openAI` API and `langchain` interface.
+
+To install `llama-cpp-python` follow the official [installation docs](https://llama-cpp-python.readthedocs.io/en/latest/) and [those docs](https://llama-cpp-python.readthedocs.io/en/latest/install/macos/) for MacOS with Metal support.
+
+If you want to benefit from proper hardware acceleration on your machine make sure to set up the proper compiler flags before installing your package.
+
+- `linux`: `CMAKE_ARGS="-DLLAMA_BLAS=ON -DLLAMA_BLAS_VENDOR=OpenBLAS"`
+- `macos` with Metal support: `CMAKE_ARGS="-DLLAMA_METAL=on"`
+- `windows`: `$env:CMAKE_ARGS = "-DLLAMA_BLAS=ON -DLLAMA_BLAS_VENDOR=OpenBLAS"`
+
+This will enable the `pip` installer to compile the `llama.cpp` with the proper hardware acceleration backend.
+
+Then run:
+
+```bash
+pip install llama-cpp-python
+```
+
+For our use case we also need to set up the web server that `llama-cpp-python` library provides. To install:
+
+```bash
+pip install 'llama-cpp-python[server]'
+```
+
+For detailed use consult the [`llama-cpp-python` docs](https://llama-cpp-python.readthedocs.io/en/latest/server/).
+
+Before we proceed we need to obtain the model weights in the `gguf` format. That should be a single file on your disk.
+
+In case you have weights in other formats check the `llama-cpp-python` docs for conversion to `gguf` format.
+
+Models in other formats `ggml`, `.safetensors`, etc. won't work without prior conversion to `gguf` file format with the solution described below!
+
+Which open model to use?
+==================
+
+Your best choice would be:
+
+- CodeLlama 70B
+- Mixtral 8x7B
+
+We are still testing this part, but the larger the model you can run the better. Sure the responses might be slower in terms of (token/s), but code quality will be higher.
+
+For testing that the open LLM `gpte` setup works we recommend starting with a smaller model. You can download weights of [CodeLlama-13B-GGUF by the `TheBloke`](https://huggingface.co/TheBloke/CodeLlama-13B-GGUF) choose the largest model version you can run (for example `Q6_K`), since quantisation will degrade LLM performance.
+
+Feel free to try out larger models on your hardware and see what happens.
+
+Running the Example
+==================
+
+To see that your setup works check [test open LLM setup](examples/test_open_llm/README.md).
+
+If above tests work proceed 😉
+
+For checking that `gpte` works with the `CodeLLama` we recommend for you to create a project with `prompt` file content:
+
+```
+Write a python script that sums up two numbers. Provide only the `sum_two_numbers` function and nothing else.
+
+Provide two tests:
+
+assert(sum_two_numbers(100, 10) == 110)
+assert(sum_two_numbers(10.1, 10) == 20.1)
+```
+
+Now run the LLM in separate terminal:
+
+```bash
+python -m llama_cpp.server --model $model_path --n_batch 256 --n_gpu_layers 30
+```
+
+Then in another terminal window set the following environment variables:
+
+```bash
+export OPENAI_API_BASE="http://localhost:8000/v1"
+export OPENAI_API_KEY="sk-xxx"
+export MODEL_NAME="CodeLLama"
+export LOCAL_MODEL=true
+```
+
+And run `gpt-engineer` with the following command:
+
+```bash
+gpte <project_dir> $MODEL_NAME --lite --temperature 0.1
+```
+
+The `--lite` mode is needed for now since open models for some reason behave worse with too many instructions at the moment. Temperature is set to `0.1` to get consistent best possible results.
+
+That's it.
+
+*If sth. doesn't work as expected, or you figure out how to improve the open LLM support please let us know.*
+
+Using Open Router models
+==================
+
+In case you don't posses the hardware to run local LLM's yourself you can use the hosting on [Open Router](https://openrouter.ai) and pay as you go for the tokens.
+
+To set it up you need to Sign In and load purchase 💰 the LLM credits. Pricing per token is different for (each model](https://openrouter.ai/models), but mostly cheaper then Open AI.
+
+Then create the API key.
+
+To for example use [Meta: Llama 3 8B Instruct (extended)](https://openrouter.ai/models/meta-llama/llama-3-8b-instruct:extended) with `gpte` we need to set:
+
+```bash
+export OPENAI_API_BASE="https://openrouter.ai/api/v1"
+export OPENAI_API_KEY="sk-key-from-open-router"
+export MODEL_NAME="meta-llama/llama-3-8b-instruct:extended"
+export LOCAL_MODEL=true
+```
+
+```bash
+gpte <project_dir> $MODEL_NAME --lite --temperature 0.1
+```
+
+Using Azure models
+==================
+
+You set your Azure OpenAI key:
+- `export OPENAI_API_KEY=[your api key]`
+
+Then you call `gpt-engineer` with your service endpoint `--azure https://aoi-resource-name.openai.azure.com` and set your deployment name (which you created in the Azure AI Studio) as the model name (last `gpt-engineer` argument).
+
+Example:
+`gpt-engineer --azure https://myairesource.openai.azure.com ./projects/example/ my-gpt4-project-name`

docs/quickstart.rst

@@ -0,0 +1,68 @@
+==========
+Quickstart
+==========
+
+Installation
+============
+
+To install LangChain run:
+
+.. code-block:: console
+
+    $ python -m pip install gpt-engineer
+
+For more details, see our [Installation guide](/instllation.html).
+
+Setup API Key
+=============
+
+Choose one of the following:
+
+- Export env variable (you can add this to ``.bashrc`` so that you don't have to do it each time you start the terminal)
+
+  .. code-block:: console
+
+      $ export OPENAI_API_KEY=[your api key]
+
+- Add it to the ``.env`` file:
+
+  - Create a copy of ``.env.template`` named ``.env``
+  - Add your ``OPENAI_API_KEY`` in .env
+
+- If you want to use a custom model, visit our docs on `using open models and azure models <./open_models.html>`_.
+
+- To set API key on windows check the `Windows README <./windows_readme_link.html>`_.
+
+Building with ``gpt-engineer``
+==============================
+
+Create new code (default usage)
+-------------------------------
+
+- Create an empty folder for your project anywhere on your computer
+- Create a file called ``prompt`` (no extension) inside your new folder and fill it with instructions
+- Run ``gpte <project_dir>`` with a relative path to your folder
+- For example, if you create a new project inside the gpt-engineer ``/projects`` directory:
+
+  .. code-block:: console
+
+    $ gpte projects/my-new-project
+
+Improve Existing Code
+---------------------
+
+- Locate a folder with code which you want to improve anywhere on your computer
+- Create a file called ``prompt`` (no extension) inside your new folder and fill it with instructions for how you want to improve the code
+- Run ``gpte <project_dir> -i`` with a relative path to your folder
+- For example, if you want to run it against an existing project inside the gpt-engineer ``/projects`` directory:
+
+  .. code-block:: console
+
+    $ gpte projects/my-old-project -i
+
+By running ``gpt-engineer`` you agree to our `terms <./terms_link.html>`_.
+
+To **run in the browser** you can simply:
+
+.. image:: https://github.com/codespaces/badge.svg
+   :target: https://github.com/gpt-engineer-org/gpt-engineer/codespaces