Skip to main content

Setup CHKware cli

This section describe the installation process for CHKware. The currently supported python version is Python 3.13.x. You need to have this version of python in your OS to continue.

Install dependencies​

Install CHKware cli with pipx​

about pipx

pipx is a standard PyPI python application manager. pipx creates separate virtual environment for given installable package. So, your system have less side effect.

The best way is to setup CHKware with pipx. Follow the steps:

  1. Setup pipx. macOS guide, linux guide, windows guide
  2. Then install CHKware with pipx.
pipx install chk

Install CHKware cli with Pip​

about python version

CHKware require Python 3.13.x version.

pip gets installed with Python. You should use updated pip version.

note

python command should be automatically setup on install. Based on OS it also can be py (windows), python3 or python3.13 (macOS / Linux) based on the package manager that was used to install Python.

about virtual environment

It is RECOMMENDED to use a virtual environment when using via pip.

For windows users, please follow this nice article to create and use virtual environment.

  1. Create python virtual environment.
python3 -m venv ~/.chkware-venv/
  1. Activate virtual environment.
source ~/.chkware-venv/bin/activate
  1. Install CHKware cli in the virtual environment.
pip install -U chk

To upgrade to the next released version, run the same command.

Update CHKware cli​

pipx​

If CHkware was installed with pipx then to upgrade to latest released version.

pipx upgrade chk

pip​

If CHkware was installed with pip then to upgrade to latest released version.

info

Activate the virtual environment from step 2 before running following command.

pip install -U chk

[Advance users] Install edge version of CHKware cli​

You can always install a tagged version directly from git

pipx​

# latest dev release
pipx install git+https://github.com/chkware/cli.git@main

# or a tagged version
pipx install git+https://github.com/chkware/[email protected]

pip​

info

Create and activate the virtual environment before running following command.

# latest dev release
pip install -U git+https://github.com/chkware/cli.git@main

# or a tagged version
pip install -U git+https://github.com/chkware/[email protected]