Skip to content

Commit aec4e59

Browse files
authored
Provide context on how to correctly call butler in AGENTS.md (#5286)
## Overview This PR updates `AGENTS.md` to provide clear instructions on how to correctly use `butler.py` with `pipenv`, ensuring agents operate within the virtual environment. Currently, agents always fail when calling butler commands because they don't know(yet) that butler commands fail if out of a pipenv environment, hence you are always correcting it, or waiting for it till it reruns commands in `pipenv` .
1 parent efeb58f commit aec4e59

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,20 @@ Now you are ready to install the project's dependencies. Run the following comma
5454
./local/install_deps.bash
5555
```
5656

57+
## Using Butler
58+
Before each time you use the `butler.py` script, verify that you are inside the virtual environment, if not activate it by running `python -m pipenv shell`, or pre append any `python butler.py` call with
59+
`pipenv run`
60+
61+
For instance:
62+
```bash
63+
pipenv run python butler.py lint
64+
```
65+
Is the same as running
66+
```bash
67+
python butler.py lint
68+
```
69+
if you are inside a virtual environment.
70+
5771
## Testing
5872

5973
To run all unit tests, execute the following commands:

0 commit comments

Comments
 (0)