Skip to content
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

Jump to bottom

docs: Add autocompletion instructions for ZSH #47

Merged
merged 1 commit into from
Apr 20, 2022
Merged

docs: Add autocompletion instructions for ZSH #47

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
12 changes: 11 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Welcome to the VirusTotal CLI, a tool designed for those who love both VirusTota
* [Manage your LiveHunt YARA rules](doc/vt_hunting_ruleset.md).
* [Launch Retrohunt jobs](doc/vt_retrohunt_start.md) and [get their results](doc/vt_retrohunt_matches.md).

And much [more](doc/vt.md)...
And much [more](doc/vt.md)...

## See it in action

Expand Down Expand Up @@ -87,6 +87,16 @@ If you are going to use this tool frequently you may want to have command auto-c

:heavy_exclamation_mark: You may need to restart your shell in order for autocompletion to start working.

### Setup ZSH completion

The output script from `vt completion zsh` needs to be put somewhere under the `$fpath` directory. For example, `.oh-my-zsh/completions` directory:
```shellsession
$ mkdir /Users/$USERNAME/.oh-my-zsh/completions
$ vt completion zsh > /Users/$USERNAME/.oh-my-zsh/completions/_vt
```

Restart the shell.

## Usage examples

* Get information about a file:
Expand Down