Getting Started

Install vkube CLI tool using pip3

The installation environment requires Python version 3.7 or higher.

  • To install, find a directory and execute the following command:
pip3 install vkube

Check vkube version:

vkube version

Update to the latest vkube version:

pip3 install --upgrade vkube

How to use vkube-cli

In the root directory ("xxx/vkube-cli"):

  1. Add DockerhubToken or GHCRToken:
vkube config -w DockerhubToken=dckr_pat_xxxx
vkube config -w GHCRToken=ghcr_xxx
  1. Configure VKubefile.yaml

  2. Deploy using the following command:

vkube deploy -f ./VKubefile.yaml # Define VKubefile path

or

vkube deploy # CLI will look for VKubefile.yaml in the command execution directory
Last Updated: 9/16/2025, 7:02:30 AM