Import project
Info
This is an experimental feature.
Our interface does not currently directly support importing a project from GitHub, but you can still do it by pushing a project to a repo created by gptengineer.app
, by following these steps:
- Create a new project with
gptengineer.app
.- To get a descriptive project ID, we suggest using a simple prompt describing the project you want to import.
- Move the project to your GitHub user or organization.
- Clone the project to your local machine.
- Copy the
gpt-engineer.toml
configuration file from the project created in step 1 to the repo you want to import. - In the git repo you want to import, add a remote gpt-engineer with the URL of the project you created in step 1:
git remote add gpt-engineer $URL
. - Force push the project you want to import to the gpt-engineer remote:
git push gpt-engineer main --force
.- Note: This will overwrite the project created in step 1.
- You should now see the project in
gptengineer.app
. - To pull changes, you can use the
git pull gpt-engineer main
command.
Note
This is only one suggested workflow in the meantime while we work on making this a first-class feature. You might find that another approach than using a gpt-engineer
remote works better for you.
For some projects, you might need to manually adjust the configuration file to make it work with gptengineer.app
. Such as setting base
, src
, and dist
paths, or specifying the build command.
Requirements
We try to support as many projects as possible, but there are some requirements for it to work with gptengineer.app. Here are some of them:
- The project must be built with npm.
- The project must be built to a static set of files.
- This means that the project must not require a server to run (unlike Next.js App Router, in many cases).
- Probably more things we haven't learned yet. Let us know!