VWS-CLI¶
A CLI for Vuforia Web Services.
Installation¶
With pip
¶
Requires Python 3.12+.
pip install VWS-CLI
With Homebrew (macOS, Linux, WSL)¶
Requires Homebrew.
brew tap VWS-Python/vws
brew install vws-cli
Pre-built Linux binaries¶
curl --fail -L https://github.com/VWS-Python/vws-cli/releases/download/0.1.dev119+geba2d60/vws -o /usr/local/bin/vws && \
chmod +x /usr/local/bin/vws
curl --fail -L https://github.com/VWS-Python/vws-cli/releases/download/0.1.dev119+geba2d60/vuforia-cloud-reco -o /usr/local/bin/vuforia-cloud-reco && \
chmod +x /usr/local/bin/vuforia-cloud-reco
Shell completion¶
~/Documents ~> vws get-<TAB>
get-database-summary-report (Get a database summary report.)
get-duplicate-targets (Get a list of potential duplicate targets.)
get-target-record (Get a target record.)
get-target-summary-report (Get a target summary report.)
Add this to ~/.bashrc
:
eval "$(_VWS_COMPLETE=bash_source vws)"
Add this to ~/.zshrc
:
eval "$(_VWS_COMPLETE=zsh_source vws)"
Run the following command:
_VWS_COMPLETE=fish_source vws > ~/.config/fish/completions/vws.fish
After modifying the shell configuration files, you need to start a new shell in order for the changes to be loaded.
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
$
Reference¶
- Installation
- Usage example
- Commands
- Contributing to VWS-CLI
- Release process
- Changelog
- Next
- 2024.02.21.4
- 2024.02.21.3
- 2024.02.21.2
- 2024.02.21.1
- 2024.02.21
- 2024.01.31.1
- 2024.01.30.2
- 2024.01.30.1
- 2024.01.30
- 2024.01.29.2
- 2024.01.29.1
- 2024.01.29
- 2023.09.09
- 2023.02.21.7
- 2023.02.21.6
- 2023.02.21.5
- 2023.02.21.4
- 2023.02.21.3
- 2023.02.21.2
- 2023.02.21.1
- 2023.02.21
- 2021.12.15.5
- 2021.12.15.4
- 2021.12.15.3
- 2021.12.15.2
- 2021.12.15.1
- 2021.12.15
- 2021.10.08.0