Skip to content

install.rst

Latest commit

 

History

History
76 lines (46 loc) · 1.78 KB

install.rst

File metadata and controls

76 lines (46 loc) · 1.78 KB
Raw

Installation

With pip

Requires Python |minimum-python-version|+.

pip install VWS-CLI

With Homebrew (macOS, Linux, WSL)

Requires Homebrew.

brew tap VWS-Python/vws
brew install vws-cli

Pre-built Linux binaries

$ curl --fail -L "https://github.com/|github-owner|/|github-repository|/releases/download/|release|/vws" -o /usr/local/bin/vws &&
    chmod +x /usr/local/bin/vws
$ curl --fail -L "https://github.com/|github-owner|/|github-repository|/releases/download/|release|/vuforia-cloud-reco" -o /usr/local/bin/vuforia-cloud-reco &&
    chmod +x /usr/local/bin/vuforia-cloud-reco

Shell completion

Use to complete commands and options.

$ vws get-`TAB`
get-database-summary-report        (Get a database summary report.)
get-duplicate-targets  (Get a list of potential duplicate targets.)
get-target-record                            (Get a target record.)
get-target-summary-report            (Get a target summary report.)
.. tab:: Bash

   Add this to :file:`~/.bashrc`:

   .. code-block:: shell

      eval "$(_VWS_COMPLETE=bash_source vws)"


.. tab:: Zsh

   Add this to :file:`~/.zshrc`:

   .. code-block:: shell

      eval "$(_VWS_COMPLETE=zsh_source vws)"


.. tab:: Fish

   Run the following command:

   .. code-block:: shell

      _VWS_COMPLETE=fish_source vws > ~/.config/fish/completions/vws.fish

After modifying the shell configuration files, you need to start a new shell in order for the changes to be loaded.