Skip to main content

CLI Installation

Sylk CLI can be installed locally on a computer or on a remote server. The following installation guide provides step-by-step instructions on how to install and create a new sylk project on your local machine.

👀 Prerequisites

You will need to install Python 3.7 or higher

💡 Windows Users

It is recommended to install and use sylk CLI in WSL2 to have a "linux" ready development environement for maximum compatibility (Most production use cases of servers are in linux environment after all...)

Setup Virtual Environment

Since Sylk CLI is written in Python it is recommended to create a custom and unique virtual environment when working locally with sylk's projects. This environment will hold all dependencies that needed to create a sylk project without interffering with your other projects on you working station.

First make sure you have installed Virtualenv is a tool to set up your Python environments

pip install virtualenv

Create a Sylk virtual environment

python -m venv sylk-env

Then activate your environment

source sylk-env/bin/activate

Install Sylk CLI

To install Sylk CLI and all it's dependencies you can simply run:

pip install sylk

After short installation process of Sylk core modules and dependencies you should be able to run Sylk commands

sylk --version