diff --git a/docs/faq.md b/docs/faq.md index a99a13dfe..289df639a 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -11,6 +11,7 @@ - [How can I run aider locally from source code?](#how-can-i-run-aider-locally-from-source-code) - [Can I script aider?](#can-i-script-aider) - [What code languages does aider support?](#what-code-languages-does-aider-support) +- [How to use pipx to avoid python package conflicts?](#how-to-use-pipx-to-avoid-python-package-conflicts) ## How does aider use git? @@ -331,3 +332,31 @@ But aider should work quite well for other languages, even without repo map supp - Ruby - Rust - Typescript + +## How to use pipx to avoid python package conflicts? + +If you are using aider to work on a python project, sometimes your project will require +specific versions of python packages which conflict with the versions that aider +requires. +If this happens, the `pip install` command may return errors like these: + +``` +aider-chat 0.23.0 requires somepackage==X.Y.Z, but you have somepackage U.W.V which is incompatible. +``` + +You can avoid this problem by installing aider using `pipx`, +which will install it globally on your system +within its own python environment. +This way you can use aider to work on any python project, +even if that project has conflicting dependencies. + +See the pipx docs for how to install pipx: + +https://pipx.pypa.io/stable/ + +Then just do: + +``` +pipx install aider +``` +