Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions docs/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -222,14 +222,17 @@ Interactive prompts from deploy code (e.g. `input(...)`) will still block, so av

## Shell Autocompletion

Add the following to your `~/.bash_profile` or `~/.profile` files:
pyinfra can install shell completion for you:

+ **bash** `source scripts/pyinfra-complete.sh`.
+ **zsh** `source scripts/pyinfra-complete.zsh`.
```
pyinfra --install-completion
```

This auto-detects your current shell (`bash`, `zsh` and `fish` are supported), then generates and installs the completion script to the shell-specific default location. After installation you may need to restart your shell or source your shell configuration file.

These files were generated using these commands:
You can also target a specific shell or output path:

```
env _PYINFRA_COMPLETE=bash_source pyinfra > pyinfra-complete.sh
env _PYINFRA_COMPLETE=zsh_source pyinfra > pyinfra-complete.zsh
pyinfra --install-completion --shell zsh
pyinfra --install-completion --shell bash --output ~/.pyinfra-complete.bash
```
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ dependencies = [
"gevent>=1.5",
"paramiko>=2.11,<5", # 2.11 (2022) adds Transport.open_channel(timeout=...) for ProxyJump timeout (#971)
"click>2",
"cyclopts>=4,<5",
"jinja2>3,<4",
"python-dateutil>2,<3",
"typeguard>=4,<5",
Expand Down
21 changes: 0 additions & 21 deletions scripts/pyinfra-complete.sh

This file was deleted.

28 changes: 0 additions & 28 deletions scripts/pyinfra-complete.zsh

This file was deleted.

Loading
Loading