Skip to content

Commit d2a179e

Browse files
committed
Add documentation
1 parent bd313b4 commit d2a179e

File tree

2 files changed

+11
-1
lines changed

2 files changed

+11
-1
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -413,7 +413,7 @@ the `call_silent()` method instead.
413413

414414
### Autocompletion
415415

416-
Cleo supports automatic (tab) completion in `bash`, `zsh` and `fish`.
416+
Cleo supports automatic (tab) completion in `bash`, `zsh`, `fish` and `PowerShell`.
417417

418418
By default, your application will have a `completions` command. To register these completions for your application, run one of the following in a terminal (replacing `[program]` with the command you use to run your application):
419419

@@ -434,4 +434,7 @@ echo "fpath+=~/.zfunc" >> ~/.zshrc
434434

435435
# Fish
436436
[program] completions fish > ~/.config/fish/completions/[program].fish
437+
438+
# PowerShell
439+
[program] completions PowerShell > $PROFILE
437440
```

src/cleo/commands/completions_command.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,13 @@ class CompletionsCommand(Command):
106106
107107
For the new completions to take affect.
108108
109+
<option=bold>PowerShell</>:
110+
111+
PowerShell profiles are stored at $PROFILE path, so you can simply \
112+
run command like this:
113+
114+
`<options=bold>{script_name} {command_name} PowerShell > $PROFILE</>`
115+
109116
<options=bold>CUSTOM LOCATIONS</>:
110117
111118
Alternatively, you could save these files to the place of your choosing, \

0 commit comments

Comments
 (0)