Skip to content

Add Completion command to ReadMe #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 23, 2021
Merged

Add Completion command to ReadMe #15

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,12 @@ $ swift run swift-dependency-updater

Run `swift-dependency-updater --help` for a full list of supported commands, and `swift-dependency-updater help <subcommand>` for detailed help on a specific command.

### Completion

Thanks to the [swift-argument-parser](https://github.com/apple/swift-argument-parser) you can generate [autocompletion scripts](https://github.com/apple/swift-argument-parser/blob/main/Documentation/07%20Completion%20Scripts.md) via `swift-dependency-updater --generate-completion-script {zsh|bash|fish}`. The exact command for your shell may vary, but for example for zsh with ~/.zfunctions in your fpath you can use:

`swift-dependency-updater --generate-completion-script zsh > ~/.zfunctions/_swift-dependency-updater`

## Limitation

Currently dependencies specified with either `.branch(_ name:)` or `.revision(_ ref:)` are not supported.
Expand Down