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

copy

Browse source
This commit is contained in:
Paul Gauthier 2023-07-11 12:52:20 -07:00
parent ceb84b2cdd
commit e0fdf6ce24
2 changed files with 12 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -11,11 +11,11 @@ It also has features that [help GPT-4 understand and modify larger codebases](ht
- [Getting started](#getting-started)
- [Example chat transcripts](#example-chat-transcripts)
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [In-chat commands](#in-chat-commands)
- [Tips](#tips)
- [GPT-4 vs GPT-3.5](#gpt-4-vs-gpt-35)
- [Installation](https://aider.chat/docs/install.html)
- [FAQ](https://aider.chat/docs/faq.html)
## Getting started
@ -166,6 +166,10 @@ This minimizes your use of the context window, as well as costs.
* "It was WAY faster than I would be getting off the ground and making the first few working versions." -- [Daniel Feldman](https://twitter.com/d_feldman/status/1662295077387923456)
* "Amazing project, definitely the best AI coding assistant I've used." -- [joshuavial](https://github.com/paul-gauthier/aider/issues/84)
## Installation
See the [installation instructions](https://aider.chat/docs/install.html).
## FAQ
For more information, see the [FAQ](https://aider.chat/docs/faq.html).

14
docs/install.md
View file

@ -1,7 +1,7 @@
# Installing aider
## Install the `aider-chat` package with pip from one of these sources:
## Install the "aider-chat" package with pip from one of these sources:
* PyPI hosts the released and most stable version:
* `python -m pip install aider-chat`
@ -16,21 +16,21 @@ On Windows, you may need to run `py -m pip install ...` to install python packag
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 "ChatGPT Plus".
to use aider. Note that this is different than being a "ChatGPT Plus" subscriber.
You can place your api key in an environment variable:
* `export OPENAI_API_KEY=sk-...` on Linux or Mac
* `setx OPENAI_API_KEY sk-...` in Windows PowerShell
Or you can create a `.aider.conf.yml` file in your home directory or at the root of your git repo,
alongside the `.git` dir. Put a line in it like this to specify your api key:
Or you can create a `.aider.conf.yml` file in your home directory.
Put a line in it like this to specify your api key:
```
openai-api-key: sk-...
```
Finally, you could also just provide your key as a command line argument:
Finally, you can also just provide your key as a command line argument:
```
aider --openai-api-key sk-...
@ -73,9 +73,9 @@ Some things to be aware of:
## Add aider to your editor
(joshuavial)[https://github.com/joshuavial) has provided a NeoVim plugin for aider:
[joshuavial](https://github.com/joshuavial) has provided a NeoVim plugin for aider:
* https://github.com/joshuavial/aider.nvim
* [https://github.com/joshuavial/aider.nvim](https://github.com/joshuavial/aider.nvim)
If you are interested in creating an aider plugin for your favorite editor,
please let me know by opening a