vws-cli¶

Installation¶

With `pip`¶

Requires Python 3.13+.

$ pip install VWS-CLI

With Homebrew (macOS, Linux, WSL)¶

Requires Homebrew.

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

With Nix¶

Requires Nix.

$ nix --extra-experimental-features 'nix-command flakes' develop "github:VWS-Python/vws-cli"

To avoid passing --extra-experimental-features every time, enable flakes permanently.

Or add to your flake inputs:

{
  inputs.vws-cli.url = "github:VWS-Python/vws-cli";
}

With Docker¶

$ docker run --rm "ghcr.io/vws-python/vws-cli" --help

To use vuforia-cloud-reco:

$ docker run --rm --entrypoint vuforia-cloud-reco "ghcr.io/vws-python/vws-cli" --help

With winget (Windows)¶

Requires winget.

$ winget install --id VWSPython.vws-cli --source winget --exact
$ winget install --id VWSPython.vuforia-cloud-reco --source winget --exact

Pre-built Linux (x86) binaries¶

$ curl --fail -L "https://github.com/VWS-Python/vws-cli/releases/download/2026.02.15.2/vws-linux" -o /usr/local/bin/vws &&
    chmod +x /usr/local/bin/vws
$ curl --fail -L "https://github.com/VWS-Python/vws-cli/releases/download/2026.02.15.2/vuforia-cloud-reco-linux" -o /usr/local/bin/vuforia-cloud-reco &&
    chmod +x /usr/local/bin/vuforia-cloud-reco

Pre-built Windows binaries¶

Download the Windows executables from the latest release and place them in a directory on your PATH.

Pre-built macOS (ARM) binaries¶

$ curl --fail -L "https://github.com/VWS-Python/vws-cli/releases/download/2026.02.15.2/vws-macos" -o /usr/local/bin/vws &&
    chmod +x /usr/local/bin/vws
$ curl --fail -L "https://github.com/VWS-Python/vws-cli/releases/download/2026.02.15.2/vuforia-cloud-reco-macos" -o /usr/local/bin/vuforia-cloud-reco &&
    chmod +x /usr/local/bin/vuforia-cloud-reco

You may need to remove the quarantine attribute to allow the binaries to run:

$ xattr -d com.apple.quarantine /usr/local/bin/vws
$ xattr -d com.apple.quarantine /usr/local/bin/vuforia-cloud-reco

Shell completion¶

Use <TAB> 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.)

Bash

Add this to ~/.bashrc:

$ eval "$(_VWS_COMPLETE=bash_source vws)"

Zsh

Add this to ~/.zshrc:

$ eval "$(_VWS_COMPLETE=zsh_source vws)"

Fish

Run the following command:

$ _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.

Usage example¶

$ vws add-target \
    --server-access-key "$SERVER_ACCESS_KEY" \
    --server-secret-key "$SERVER_SECRET_KEY" \
    --name my_image_name \
    --width 2 \
    --image ~/Documents/my_image.png \
    --application-metadata "$(echo 'my_metadata' | base64)" \
    --active-flag true
03b99df0-78cf-4b01-b929-f1860d4f8ed1
$ vws --help
...
$ vuforia-cloud-reco my_image.jpg \
    --max-num-results 5 \
    --include-target-data none
- target_id: b60f60121d37418eb1de123c381b2af9
- target_id: e3a6e1a216ad4df3aaae1f6dd309c800
$