Skip to content

Commit

Permalink
Add command completion docs (#410)
Browse files Browse the repository at this point in the history
  • Loading branch information
nimrod-a committed Jan 13, 2025
1 parent 0c73e3e commit 1c78874
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions docs/command_completion.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Command Completion

MVT utilizes the [Click](https://click.palletsprojects.com/en/stable/) library for creating its command line interface.

Click provides tab completion support for Bash (version 4.4 and up), Zsh, and Fish.

To enable it, you need to manually register a special function with your shell, which varies depending on the shell you are using.

The following describes how to generate the command completion scripts and add them to your shell configuration.

`You will need to start a new shell for the changes to take effect.`

### For Bash

```bash
# Generates bash completion scripts
echo "$(_MVT_IOS_COMPLETE=bash_source mvt-ios)" > ~/.mvt-ios-complete.bash &&
echo "$(_MVT_ANDROID_COMPLETE=bash_source mvt-android)" > ~/.mvt-android-complete.bash

# Sources the scripts in ~/.bashrc.
. ~/.mvt-ios-complete.bash && . ~/.mvt-android-complete.bash
```

### For Zsh

```bash
# Generates zsh completion scripts
echo "$(_MVT_IOS_COMPLETE=zsh_source mvt-ios)" > ~/.mvt-ios-complete.zsh &&
echo "$(_MVT_ANDROID_COMPLETE=zsh_source mvt-android)" > ~/.mvt-android-complete.zsh

# Sources the scripts in ~/.zshrc.
. ~/.mvt-ios-complete.zsh && . ~/.mvt-android-complete.zsh
```

For more information, visit the official [Click Docs](https://click.palletsprojects.com/en/stable/shell-completion/#enabling-completion).


0 comments on commit 1c78874

Please sign in to comment.