dearwolf/aider
1
0
Fork 0
mirror of https://github.com/Aider-AI/aider.git synced 2025-05-30 17:24:59 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

copy

Browse source
This commit is contained in:
Paul Gauthier 2024-01-24 09:52:56 -08:00
parent 065bc63e33
commit f6075605c6
1 changed files with 48 additions and 33 deletions
Download patch file Download diff file Expand all files Collapse all files

81
docs/install.md
View file

@ -1,33 +1,55 @@
# Installing aider
- [pip install aider-chat](#pip-install-aider-chat)
- [Provide your OpenAI API key](#provide-your-openai-api-key)
- [Install git](#install-git)
- [Get your OpenAI API key](#get-your-openai-api-key)
- [Windows install](#windows-install)
- [MacOS or Linux install](#macos-or-linux-install)
Optional steps:
- [Store your API key](#store-your-api-key-optional)
- [Add aider to your editor (optional)](#add-aider-to-your-editor-optional)
- [Install PortAudio (optional)](#install-portaudio-optional)
## pip install aider-chat
## Install git
Install the “aider-chat” package with pip from one of these sources, using python 3.9-3.12:
Make sure you have git installed.
Here are
[instructions for installing git in various environments](https://github.com/git-guides/install-git).
* PyPI hosts the released and most stable version:
* `python -m pip install aider-chat`
* GitHub hosts the latest version, which is under active development:
* `python -m pip install git+https://github.com/paul-gauthier/aider.git`
* If you've git cloned the aider repository already, you can install "live" from your local copy. This is mostly useful if you are developing aider and want your current modifications to take effect immediately.
* `python -m pip install -e .`
## Get your OpenAI API key
On Windows, you may need to run `py -m pip install ...` to install python packages.
You need a paid
[OpenAI API key](https://help.openai.com/en/articles/4936850-where-do-i-find-my-secret-api-key).
Note that this is different than being a "ChatGPT Plus" subscriber.
## Provide your OpenAI API key
## Windows install
You need a
[paid API key from OpenAI](https://help.openai.com/en/articles/4936850-where-do-i-find-my-secret-api-key)
to use aider. Note that this is different than being a "ChatGPT Plus" subscriber.
```
py -m pip install aider-chat
aider --openai-api-key sk-xxxxxxxxxxxxxxx
```
## MacOS or Linux install
```
python -m pip install aider-chat
aider --openai-api-key sk-xxxxxxxxxxxxxxx
```
## You are done!
See the [usage instructions](/#usage) to start coding with aider.
---
# Optional steps
The steps below are completely optional.
## Store your api key (optional)
You can place your api key in an environment variable:
@ -41,25 +63,7 @@ Put a line in it like this to specify your api key:
openai-api-key: sk-...
```
Or you can provide your key as a command line argument:
```
aider --openai-api-key sk-...
```
## Install git
Make sure you have git installed and available on your shell path.
Here are
[instructions for installing git in various environments](https://github.com/git-guides/install-git).
## You are done!
See the [usage instructions](/#usage) to start coding with aider.
The rest of the install steps are completely optional.
---
## Install PortAudio (optional)
@ -96,3 +100,14 @@ since the VSCode terminal doesn't seem to support it well.
If you are interested in creating an aider plugin for your favorite editor,
please let me know by opening a
[GitHub issue](https://github.com/paul-gauthier/aider/issues).
## Install development versions of aider (optional)
If you want to install the very latest development version of aider:
* GitHub hosts the latest version, which is under active development:
* `python -m pip install git+https://github.com/paul-gauthier/aider.git`
* If you've git cloned the aider repository already, you can install "live" from your local copy. This is mostly useful if you are developing aider and want your current modifications to take effect immediately.
* `python -m pip install -e .`