vws-cli

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.

Development Status
- 5 - Production/Stable
Environment
- Web Environment
Operating System
- Microsoft :: Windows
- POSIX
Programming Language
- Python :: 3 :: Only
- Python :: 3.14

Metadata

Development Status
- 5 - Production/Stable
Environment
- Web Environment
Operating System
- Microsoft :: Windows
- POSIX
Programming Language
- Python :: 3 :: Only
- Python :: 3.14

Release files for vws-cli 2026.8.30.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for vws-cli 2026.8.30.1
File	Size	Uploaded
vws_cli-2026.8.30.1.tar.gz	154.3 kB	Aug 30, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for vws-cli 2026.8.30.1
File	Interpreter	ABI	Platform	Reset
vws_cli-2026.8.30.1-py3-none-any.whl 23.5 kB Aug 30, 2026	Python 3	none	any	Details

Total release size: 177.8 kB

Release files / vws_cli-2026.8.30.1.tar.gz

Download URL	vws_cli-2026.8.30.1.tar.gz
Size	154.3 kB
Tags	Source
SHA-256 checksum How to use checksums	`61dc25e257f634046d45b72fd2fbf8d6d49be69322e96e8a8a06fcb92a0298d3`
BLAKE2b-256 checksum How to use checksums	`2b8b82543c48ef3006eed659322929cbdf4b065f4f64bf5612a3696fa3bdeddd`
Upload date	Aug 30, 2026
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.

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/VWS-Python/vws-cli
Publishing commit: github.com/VWS-Python/vws-cli/tree/1f17f4082ca51fe55c41e3c1c8b16d91f9fa2ecd

Workflow

Publishing configuration: github.com/VWS-Python/vws-cli/blob/1f17f4082ca51fe55c41e3c1c8b16d91f9fa2ecd/.github/workflows/release.yml
Publishing logs: github.com/VWS-Python/vws-cli/actions/runs/33305199016/attempts/1

Artifact

Subject: vws_cli-2026.8.30.1.tar.gz
SHA-256 checksum: 61dc25e257f634046d45b72fd2fbf8d6d49be69322e96e8a8a06fcb92a0298d3 Verifying attestations

Release files / vws_cli-2026.8.30.1-py3-none-any.whl

Download URL	vws_cli-2026.8.30.1-py3-none-any.whl
Size	23.5 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`a07efae135808116fdfd1a4eed7e0c4829a45aa6343a833954ca39f86b75b01a`
BLAKE2b-256 checksum How to use checksums	`31aa9728591322f187128e831d62d2c6e4a1831d19b0ca09b4fdd3066428c4cf`
Upload date	Aug 30, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/VWS-Python/vws-cli
Publishing commit: github.com/VWS-Python/vws-cli/tree/1f17f4082ca51fe55c41e3c1c8b16d91f9fa2ecd

Workflow

Publishing configuration: github.com/VWS-Python/vws-cli/blob/1f17f4082ca51fe55c41e3c1c8b16d91f9fa2ecd/.github/workflows/release.yml
Publishing logs: github.com/VWS-Python/vws-cli/actions/runs/33305199016/attempts/1

Artifact

Subject: vws_cli-2026.8.30.1-py3-none-any.whl
SHA-256 checksum: a07efae135808116fdfd1a4eed7e0c4829a45aa6343a833954ca39f86b75b01a Verifying attestations