If you would like to avoid the dependencies hassle, give a try to the vss-cli on Run the vss-cli in Docker approach.
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 pip:
pip install vss-cli
If you are planning to interact with vskey-stor
execute the following command:
pip install vss-cli[stor]
The command will install minio
package from PyPI.
Windows users, please install windows-curses
and vss-cli
as follows pip install --user vss-cli windows-curses
.
Linux operating systems require python3-dev
and python3-setuptools
.
Use Homebrew to install the vss-cli
on macOS:
macOS requires python 3.10 or higher: brew install python@3.10
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
Troubleshooting
How to fix the following error in macOS?
➜ ~ brew install vss-cli ==> Fetching vss/vss-cli/vss-cli ==> Downloading https://files.pythonhosted.org/packages/34/d8/f74022313a212e7aac0e2e5df046dd33c89127ce515263a2b428d00ccfbb/vss_cli-2024.7.2-py2.py3-none-any.whl Already downloaded: /Users/orlando/Library/Caches/Homebrew/downloads/42e058bc4044fb1da37823d9bca5f805cedc1bacd23838c98851fca9150a558f--vss_cli-2024.7.2-py2.py3-none-any.whl ==> Installing vss-cli from vss/vss-cli ==> pipx install ./*.whl Last 15 lines from /Users/orlando/Library/Logs/Homebrew/vss-cli/01.*.whl: File "/opt/homebrew/opt/pipx/bin/pipx", line 5, in <module> from pipx.main import cli File "/opt/homebrew/Cellar/pipx/1.6.0/libexec/lib/python3.12/site-packages/pipx/main.py", line 22, in <module> from pipx import commands, constants, paths File "/opt/homebrew/Cellar/pipx/1.6.0/libexec/lib/python3.12/site-packages/pipx/commands/__init__.py", line 2, in <module> from pipx.commands.environment import environment File "/opt/homebrew/Cellar/pipx/1.6.0/libexec/lib/python3.12/site-packages/pipx/commands/environment.py", line 6, in <module> from pipx.interpreter import DEFAULT_PYTHON File "/opt/homebrew/Cellar/pipx/1.6.0/libexec/lib/python3.12/site-packages/pipx/interpreter.py", line 183, in <module> DEFAULT_PYTHON = _get_absolute_python_interpreter(env_default_python) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ File "/opt/homebrew/Cellar/pipx/1.6.0/libexec/lib/python3.12/site-packages/pipx/interpreter.py", line 174, in _get_absolute_python_interpreter raise PipxError(f"Default python interpreter '{env_python}' is invalid.") pipx.util.PipxError: Default python interpreter '/opt/homebrew/opt/python@3.10/bin/python3.10' is invalid. If reporting this issue please do so to (not Homebrew/brew or Homebrew/homebrew-core): vss/vss-cli Warning: Unable to query GitHub for recent issues on the tap Validation Failed: [{"message"=>"The listed users and repositories cannot be searched either because the resources do not exist or you do not have permission to view them.", "resource"=>"Search", "field"=>"q", "code"=>"invalid"}]
Solution
Install Python 3.10
brew install python@3.10