From 8bac324b0f180e83c8b6c5d98f9c50207194d23e Mon Sep 17 00:00:00 2001 From: Farhan Ahmad Date: Sat, 16 Sep 2023 15:40:05 -0400 Subject: [PATCH 1/5] aider: Add instructions for running the project locally. # Aider chat conversation: USER: Update the readme to include instruction for running the project locally after closing the repo or creating your fork. Make sure to mention how you will go about running the local version aider by using the following command: python -m aider.main ASSISTANT: To add instructions for running the project locally, we need to modify the README.md file. Here are the changes: markdown README.md <<<<<<< HEAD ## Installation See the [installation instructions](https://aider.chat/docs/install.html). ======= ## Installation See the [installation instructions](https://aider.chat/docs/install.html). ## Running Locally After cloning the repository or creating your fork, you can run the local version of Aider using the following command: ``` python -m aider.main ``` >>>>>>> updated --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6dd7b5f53..14b385d26 100644 --- a/README.md +++ b/README.md @@ -154,6 +154,14 @@ For a discussion of using other non-OpenAI models, see the See the [installation instructions](https://aider.chat/docs/install.html). +## Running Locally + +After cloning the repository or creating your fork, you can run the local version of Aider using the following command: + +``` +python -m aider.main +``` + ## FAQ For more information, see the [FAQ](https://aider.chat/docs/faq.html). @@ -170,4 +178,4 @@ For more information, see the [FAQ](https://aider.chat/docs/faq.html). * *This project is stellar.* -- [funkytaco](https://github.com/paul-gauthier/aider/issues/112#issuecomment-1637429008) * *Amazing project, definitely the best AI coding assistant I've used.* -- [joshuavial](https://github.com/paul-gauthier/aider/issues/84) * *I am an aider addict. I'm getting so much more work done, but in less time.* -- [dandandan](https://discord.com/channels/1131200896827654144/1131200896827654149/1135913253483069470) -* *Best agent for actual dev work in existing codebases.* -- [Nick Dobos](https://twitter.com/NickADobos/status/1690408967963652097?s=20) \ No newline at end of file +* *Best agent for actual dev work in existing codebases.* -- [Nick Dobos](https://twitter.com/NickADobos/status/1690408967963652097?s=20) From 53c467ae882091e028a658b99ad2c3f577cbc4a7 Mon Sep 17 00:00:00 2001 From: Farhan Ahmad Date: Sat, 16 Sep 2023 15:41:42 -0400 Subject: [PATCH 2/5] Updated gitignore --- .gitignore | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 000000000..8ba023496 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +.aider* +*__pycache__* \ No newline at end of file From b7e3911afce860796656732f94afad741c83fdef Mon Sep 17 00:00:00 2001 From: Farhan Ahmad Date: Sat, 16 Sep 2023 15:45:46 -0400 Subject: [PATCH 3/5] aider: Updated the instructions for running the project locally. # Aider chat conversation: USER: update the instruction for running locally to include step by step instructions like cloning the repo / creating a fork. Switch to the correct directly. Install all the dependencies inside `requirements.txt` file using pip install -r. and finally running the program using python -m aider.main ASSISTANT: To update the instructions for running the project locally, we need to modify the README.md file. Here are the changes: markdown README.md <<<<<<< HEAD ## Running Locally After cloning the repository or creating your fork, you can run the local version of Aider using the following command: ``` python -m aider.main ``` ======= ## Running Locally To run the project locally, follow these steps: 1. Clone the repository or create your fork: ``` git clone https://github.com/your-username/aider.git ``` 2. Navigate to the project directory: ``` cd aider ``` 3. Install the dependencies listed in the `requirements.txt` file: ``` pip install -r requirements.txt ``` 4. Run the local version of Aider: ``` python -m aider.main ``` >>>>>>> updated --- README.md | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 14b385d26..36bf7628b 100644 --- a/README.md +++ b/README.md @@ -156,7 +156,27 @@ See the [installation instructions](https://aider.chat/docs/install.html). ## Running Locally -After cloning the repository or creating your fork, you can run the local version of Aider using the following command: +To run the project locally, follow these steps: + +1. Clone the repository or create your fork: + +``` +git clone https://github.com/your-username/aider.git +``` + +2. Navigate to the project directory: + +``` +cd aider +``` + +3. Install the dependencies listed in the `requirements.txt` file: + +``` +pip install -r requirements.txt +``` + +4. Run the local version of Aider: ``` python -m aider.main From e255b2f50065d3d49b6714aa9fc9f1e15901fd85 Mon Sep 17 00:00:00 2001 From: Farhan Ahmad Date: Mon, 18 Sep 2023 14:41:46 -0400 Subject: [PATCH 4/5] Removed .gitignore from repo --- .gitignore | 2 -- 1 file changed, 2 deletions(-) delete mode 100644 .gitignore diff --git a/.gitignore b/.gitignore deleted file mode 100644 index 8ba023496..000000000 --- a/.gitignore +++ /dev/null @@ -1,2 +0,0 @@ -.aider* -*__pycache__* \ No newline at end of file From 7137b2974453cee2afc263eadebbd7661119af52 Mon Sep 17 00:00:00 2001 From: Farhan Ahmad Date: Mon, 18 Sep 2023 15:04:00 -0400 Subject: [PATCH 5/5] Moved instructions from README.md into FAQs section. --- README.md | 28 ---------------------------- docs/faq.md | 29 +++++++++++++++++++++++++++++ 2 files changed, 29 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 36bf7628b..becb7dbac 100644 --- a/README.md +++ b/README.md @@ -154,34 +154,6 @@ For a discussion of using other non-OpenAI models, see the See the [installation instructions](https://aider.chat/docs/install.html). -## Running Locally - -To run the project locally, follow these steps: - -1. Clone the repository or create your fork: - -``` -git clone https://github.com/your-username/aider.git -``` - -2. Navigate to the project directory: - -``` -cd aider -``` - -3. Install the dependencies listed in the `requirements.txt` file: - -``` -pip install -r requirements.txt -``` - -4. Run the local version of Aider: - -``` -python -m aider.main -``` - ## FAQ For more information, see the [FAQ](https://aider.chat/docs/faq.html). diff --git a/docs/faq.md b/docs/faq.md index bd71fe4bf..77657671d 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -8,6 +8,7 @@ - [Can I use aider with other LLMs, local LLMs, etc?](#can-i-use-aider-with-other-llms-local-llms-etc) - [Can I change the system prompts that aider uses?](#can-i-change-the-system-prompts-that-aider-uses) - [Can I run aider in Google Colab?](#can-i-run-aider-in-google-colab) +- [How can I run aider locally from source code?](#how-can-i-run-aider-locally-from-source-code) ## How does aider use git? @@ -224,3 +225,31 @@ all the raw information being sent to/from GPT in the conversation. User [imabutahersiddik](https://github.com/imabutahersiddik) has provided this [Colab notebook](https://colab.research.google.com/drive/1J9XynhrCqekPL5PR6olHP6eE--rnnjS9?usp=sharing). + +## How can I run aider locally from source code? + +To run the project locally, follow these steps: + +1. Clone the repository or create your fork: + +``` +git clone https://github.com/your-username/aider.git +``` + +2. Navigate to the project directory: + +``` +cd aider +``` + +3. Install the dependencies listed in the `requirements.txt` file: + +``` +pip install -r requirements.txt +``` + +4. Run the local version of Aider: + +``` +python -m aider.main +``` \ No newline at end of file