Important
This project is archived because PTC is retiring the Vuforia Engine Cloud Image Recognition service on May 2, 2027. Existing customers can continue using the service until that date. After that date, Cloud Image Recognition databases and associated services will no longer be available.
A CLI for Vuforia Web Services.
Requires Python 3.14+.
$ pip install VWS-CLIRequires Homebrew.
$ brew tap VWS-Python/vws $ brew install vws-cli
Requires Nix.
$ nix --extra-experimental-features 'nix-command flakes' run "github:VWS-Python/vws-cli" -- --helpTo 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"; }
$ docker run --rm "ghcr.io/vws-python/vws-cli" --helpTo use vuforia-cloud-reco:
$ docker run --rm --entrypoint vuforia-cloud-reco "ghcr.io/vws-python/vws-cli" --helpTo use vumark:
$ docker run --rm --entrypoint vumark "ghcr.io/vws-python/vws-cli" --helpRequires winget.
$ winget install --id VWSPython.vws-cli --source winget --exact $ winget install --id VWSPython.vuforia-cloud-reco --source winget --exact
See the full documentation for details on how to install pre-built Linux binaries.
Download the Windows executables from the latest release and place them in a directory on your PATH.
The filenames are:
vws-windows.exevuforia-cloud-reco-windows.exevumark-windows.exe
See the full documentation for details on how to install pre-built macOS binaries.
$ 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 $
See the full documentation for information on:
- All available commands.
- Setting up autocompletion.
- How to contribute to this project.
- Release notes.