Skip to content

Commit eac56ba

Browse files
committed
docs: add shell auto-completion instructions to CONTRIBUTING.md
Document how to enable tab-completion for just recipes using the built-in `just --completions` command for bash, zsh, and fish.
1 parent 474b4af commit eac56ba

1 file changed

Lines changed: 24 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -197,6 +197,30 @@ just typecheck --warn-unreachable
197197
> export MYPY_CACHE_DIR=~/path/to/execution-specs/.mypy_cache
198198
> ```
199199
200+
### Shell Auto-Completion
201+
202+
`just` provides tab-completion for recipe names and arguments. To enable it for your shell:
203+
204+
**Bash** — add to `~/.bashrc`:
205+
206+
```bash
207+
eval "$(just --completions bash)"
208+
```
209+
210+
**Zsh** — add to `~/.zshrc`:
211+
212+
```bash
213+
eval "$(just --completions zsh)"
214+
```
215+
216+
**Fish** — run once (fish auto-loads completions from this directory):
217+
218+
```bash
219+
just --completions fish > ~/.config/fish/completions/just.fish
220+
```
221+
222+
After restarting your shell (or sourcing the config), `just <Tab>` will complete recipe names.
223+
200224
A trace of the EVM execution for any test case can be obtained by providing the `--evm-trace` argument to pytest.
201225
Note: Make sure to run the EVM trace on a small number of tests at a time. The log might otherwise get very big.
202226
Below is an example.

0 commit comments

Comments
 (0)