Skip to content

Installation

Officially Supported Method: Using pipx

We recommend using pipx for the installation of yam as it provides an isolated environment for the package, preventing any dependency conflicts.

To install yam using pipx, run the following command in your terminal:

$ pipx install yamk

Alternative Method: Using pip

As an alternative, you can use pip to install yam. However, this method does not provide an isolated environment for the package, which may lead to dependency conflicts or leave your system in an inconsistent state. Therefore, this method is not recommended or supported.

To install yam using pip, run the following command in your terminal:

$ pip install --user yamk

Python Version Requirement

Please note that yam requires Python 3.9 or higher. Please ensure that your system is using the correct Python version. If not, consider using a tool like pyenv to create a shell with the required Python version.