Install the vss-cli

Note

If you would like to avoid the dependencies hassle, give a try to the vss-cli on Run the vss-cli in Docker approach.

Note

Windows users, follow the installation instructions Installing Python on Windows and add %USERPROFILE%\AppData\Roaming\Python\Python37\Scripts to PATH environment variable prior running pip.

The fastest way to install VSS CLI is to use uv package manager:

uv venv && source .venv/bin/activate && uv pip install "vss-cli[stor]"

or using uvx:

uvx vss-cli

If you are planning to interact with vskey-stor execute the following command:

uv pip install "vss-cli[stor]"

Or accessing the ITS Private Cloud Model Context Protocol Server (MCP) using the vss-cli command line interface, you need to install the vss-cli[mcp] dependencies:

uv pip install "vss-cli[mcp]"

The command will install minio package from PyPI.

Note

Windows users, please install windows-curses and vss-cli as follows pip install --user vss-cli windows-curses.

Note

Recommended to use uv package manager for Linux users.

Use Homebrew to install the vss-cli on macOS:

brew tap vss/vss-cli https://github.com/EIS-ITS/vss-cli
brew install vss-cli

You can also just download the tarball. Once you have the vss-cli directory structure on your workstation, you can just run:

cd path_to_vss-cli
python setup.py install