vws-cli
A CLI for Vuforia Web Services.
Installation
With pip
Requires Python 3.14+.
$ pip install VWS-CLIWith Homebrew (macOS, Linux, WSL)
Requires Homebrew.
$ brew tap VWS-Python/vws
$ brew install vws-cliWith Nix
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";
}With Docker
$ 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" --helpWith winget (Windows)
Requires winget.
$ winget install --id VWSPython.vws-cli --source winget --exact
$ winget install --id VWSPython.vuforia-cloud-reco --source winget --exactPre-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 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
$Full documentation
See the full documentation for information on:
All available commands.
Setting up autocompletion.
How to contribute to this project.
Release notes.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file vws_cli-2026.8.16.1.tar.gz.
File metadata
- Download URL: vws_cli-2026.8.16.1.tar.gz
- Upload date:
- Size: 150.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d867339f0f9cdc0ed06151af8e0a418dfb04ec5040979d6a849506132e85cfb1
|
|
| MD5 |
c25d56d2984205b8024a986709542dbb
|
|
| BLAKE2b-256 |
d7314afbd6ea6d9957d1176197420d57fe6d81d31858ed2325ea0afc94f0460d
|
Provenance
The following attestation bundles were made for vws_cli-2026.8.16.1.tar.gz:
Publisher:
release.yml on VWS-Python/vws-cli
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
vws_cli-2026.8.16.1.tar.gz -
Subject digest:
d867339f0f9cdc0ed06151af8e0a418dfb04ec5040979d6a849506132e85cfb1 - Sigstore transparency entry: 2486674134
- Sigstore integration time:
-
Permalink:
VWS-Python/vws-cli@6d92560ce57fd9378c5769a7f568c669d1420dc1 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/VWS-Python
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@6d92560ce57fd9378c5769a7f568c669d1420dc1 -
Trigger Event:
workflow_dispatch
-
Statement type:
File details
Details for the file vws_cli-2026.8.16.1-py3-none-any.whl.
File metadata
- Download URL: vws_cli-2026.8.16.1-py3-none-any.whl
- Upload date:
- Size: 23.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3287299b2bd4f94a08bf2b2a455dc5b2580eb4235a7be98d0ff48c03f1e46941
|
|
| MD5 |
2632bb2a16219e4a403b3e15250bdb7e
|
|
| BLAKE2b-256 |
cc89270a4239740e4b3b4dc9049c4321d17688e12dc59ac29480154343ebd277
|
Provenance
The following attestation bundles were made for vws_cli-2026.8.16.1-py3-none-any.whl:
Publisher:
release.yml on VWS-Python/vws-cli
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
vws_cli-2026.8.16.1-py3-none-any.whl -
Subject digest:
3287299b2bd4f94a08bf2b2a455dc5b2580eb4235a7be98d0ff48c03f1e46941 - Sigstore transparency entry: 2486674325
- Sigstore integration time:
-
Permalink:
VWS-Python/vws-cli@6d92560ce57fd9378c5769a7f568c669d1420dc1 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/VWS-Python
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@6d92560ce57fd9378c5769a7f568c669d1420dc1 -
Trigger Event:
workflow_dispatch
-
Statement type:
