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

scrub --ctags from docs

Browse source
This commit is contained in:
Paul Gauthier 2023-06-03 18:10:02 -07:00
parent 14289ab44f
commit ca8d13f194
2 changed files with 5 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

5
README.md
View file

@ -72,7 +72,7 @@ which helps it understand and modify large codebases.
2. Set up your OpenAI API key as an environment variable `OPENAI_API_KEY` or by including `openai-api-key: sk-...` in an `.aider.config.yml` file (see `aider --help`). 2. Set up your OpenAI API key as an environment variable `OPENAI_API_KEY` or by including `openai-api-key: sk-...` in an `.aider.config.yml` file (see `aider --help`).
3. Optionally, install [universal ctags](https://github.com/universal-ctags/ctags). This is helpful if you plan to work with repositories with more than a handful of files. This allows `aider --ctags` to build a [map of your entire git repo](https://aider.chat/docs/ctags.html) and share it with GPT to help it better understand and modify large codebases. 3. Optionally, install [universal ctags](https://github.com/universal-ctags/ctags). This is helpful if you plan to work with repositories with more than a handful of files. This allows `aider` to build a [map of your entire git repo](https://aider.chat/docs/ctags.html) and share it with GPT to help it better understand and modify large codebases.
## Usage ## Usage
@ -114,7 +114,8 @@ to set many options:
Specify the OpenAI API key [env var: OPENAI_API_KEY] Specify the OpenAI API key [env var: OPENAI_API_KEY]
--dry-run Perform a dry run without applying changes (default: False) [env var: AIDER_DRY_RUN] --dry-run Perform a dry run without applying changes (default: False) [env var: AIDER_DRY_RUN]
--show-diffs Show diffs when committing changes (default: False) [env var: AIDER_SHOW_DIFFS] --show-diffs Show diffs when committing changes (default: False) [env var: AIDER_SHOW_DIFFS]
--ctags [CTAGS] Add ctags to the chat to help GPT understand the codebase (default: check for ctags executable) [env var: AIDER_CTAGS] --map-tokens MAP_TOKENS
Max number of tokens to use for repo map, use 0 to disable (default: 1024) [env var: AIDER_MAP_TOKENS]
--yes Always say yes to every confirmation [env var: AIDER_YES] --yes Always say yes to every confirmation [env var: AIDER_YES]
-v, --verbose Enable verbose output [env var: AIDER_VERBOSE] -v, --verbose Enable verbose output [env var: AIDER_VERBOSE]
``` ```

4
docs/ctags.md
View file

@ -45,7 +45,7 @@ To code with GPT-4 using the techniques discussed here:
- Install [aider](https://github.com/paul-gauthier/aider#installation). - Install [aider](https://github.com/paul-gauthier/aider#installation).
- Install [universal ctags](https://github.com/universal-ctags/ctags). - Install [universal ctags](https://github.com/universal-ctags/ctags).
- Run `aider --ctags` inside your repo. - Run `aider` inside your repo, and it should say "using ctags".
## The problem: code context ## The problem: code context
@ -230,5 +230,5 @@ To use this experimental repo map feature:
- Install [aider](https://github.com/paul-gauthier/aider#installation). - Install [aider](https://github.com/paul-gauthier/aider#installation).
- Install [universal ctags](https://github.com/universal-ctags/ctags). - Install [universal ctags](https://github.com/universal-ctags/ctags).
- Run `aider --ctags` inside your repo. - Run `aider` inside your repo, and it should say "using ctags".