File size: 2,081 Bytes
e7c3249 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 |
==========
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
|