vws-cli

A CLI for Vuforia Web Services.

• Installation
  • With pip
  • With Homebrew (macOS, Linux, WSL)
  • With Nix
  • With Docker
  • With winget (Windows)
  • Pre-built Linux binaries
  • Pre-built Windows binaries
  • Pre-built macOS (ARM) binaries
• Usage example
• Full documentation

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' run "github:VWS-Python/vws-cli" -- --help

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

To use vumark:

$ docker run --rm --entrypoint vumark "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 binaries

See the full documentation for details on how to install pre-built Linux binaries.

Pre-built Windows binaries

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

• vws-windows.exe
• vuforia-cloud-reco-windows.exe
• vumark-windows.exe

Pre-built macOS (ARM) binaries

See the full documentation for details on how to install pre-built macOS binaries.

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 true03b99df0-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
$

Full documentation

See the full documentation for information on:

• All available commands.
• Setting up autocompletion.
• How to contribute to this project.
• Release notes.