vws-cli
A CLI for Vuforia Web Services.
Installation
With pip
Requires Python 3.14+.
$ 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 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.
Metadata
Release files for vws-cli 2026.10.9
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| vws_cli-2026.10.9.tar.gz | 161.0 kB | With provenance | Details for vws_cli-2026.10.9.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| vws_cli-2026.10.9-py3-none-any.whl | Python 3 | none | any | Details for vws_cli-2026.10.9-py3-none-any.whl |
Total release size: 184.4 kB
Release files / vws_cli-2026.10.9.tar.gz
| Download URL | vws_cli-2026.10.9.tar.gz |
|---|---|
| Size | 161.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
653ff0d72a47aaa556b5d778366b94013c6ce4b03a3d531221313b92e431ce40
|
|
BLAKE2b-256 checksum How to use checksums |
7d240a6fa7ec2aa4ea8d9beae250c4abed4decb97b739c17a6dea63aefdbe0a7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 9, 2026.
Transparency logRelease files / vws_cli-2026.10.9-py3-none-any.whl
| Download URL | vws_cli-2026.10.9-py3-none-any.whl |
|---|---|
| Size | 23.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c4ef20e8e25be7a5af8e2d81b48e0beb46e5053147bd5bb38d8687797e974228
|
|
BLAKE2b-256 checksum How to use checksums |
859977798471d6cdb7a1955bdbe892626b2df51f91a28cdecd0ff4eebac082d9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 9, 2026.
Transparency logSecurity for vws-cli 2026.10.9
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for vws_cli-2026.10.9.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 9, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.