Installation
How to install the kyso-cli on your machine
There are several ways to use Kyso CLI in your machine, depending on your operating system, your needs and your preferences.
NPM & YARN
The easiest way to use kyso cli is throught NPM or YARN
The Kyso CLI can be installed as a NPM or YARN global package easily, by just launching one of the commands below:
Once installed, check that it's available executing this command:
NPX
Since npm version 5.2.0 you can use npx instead of an npm global install. The difference between npm and npx is that npx doesn't install anything globally on your computer, but just downloads the dependency, executes it and then deletes it, keeping your local node_modules smaller.
To use NPX just execute this command:
Windows Installers
Keep all the options selected for a better experience!
Select the destination folder and select 'Install':
Once the installation is completed, select the 'Close' button, open your terminal and write the following command:
Tarballs
Download the tarball that fits with your operating system and your architecture, extract it in your preferred destination and add it to the PATH of your system.
Add the destination folder, plus bin, into the PATH of your system. For example, if your destination folder is C:\Users\your_user\kyso, then add C:\Users\your_user\kyso\bin to the PATH of your system
Adding kyso to the system path in Windows
Type into the search bar edit environment variables and choose the suggested result. That should open the following window:
Click on Environment Variables
Select the Path variable of your user, and click Edit.
Click on New and type the full path in which kyso was unzipped, pointing to the bin directory. For example, if kyso is located at C:\Users\Usuario\Downloads\kyso-v1.3.1-9b24ecb-win32-x64, then the value you should put is C:\Users\Usuario\Downloads\kyso-v1.3.1-9b24ecb-win32-x64\bin
Open a terminal and type the command kyso to check that the installation was completed succesfully:
Adding kyso to the system path in MacOS and Linux
Using zsh terminal
Open a ZSH terminal and edit the file ~/.zshrc to edit the PATH variable. Type the full path in which kyso was unzipped, pointing to the bin directory. For example, if kyso is located at /home/user/kyso-v1.3.1-9b24ecb-linux-x64, then the value you should put is /home/user/kyso-v1.3.1-9b24ecb-linux-x64/bin
Check that it's effectively added by executing:
Open a terminal and type the command kyso to check that the installation was completed succesfully
Using bash terminal
Open a BASH terminal and edit the file ~/.bashrc to edit the PATH variable. Type the full path in which kyso was unzipped, pointing to the bin directory. For example, if kyso is located at /home/user/kyso-v1.3.1-9b24ecb-linux-x64, then the value you should put is /home/user/kyso-v1.3.1-9b24ecb-linux-x64/bin
Check that it's effectively added by executing:
Open a terminal and type the command kyso to check that the installation was completed succesfully
Docker
If you don't want to install the client you can also run it using a docker container, the image is available as kyso/kyso, to download the latest version of the image execute:
To run the client do the following:
Limitations
The client executed with the previous script works fine as long as the working directory is under the user's
HOMEdirectory when it is executed; if that is not the case the directory is going to be the internal version of thePATHinside the container, not the host.If the
COMMANDcalled needs to launch programs from theHOSTsystem it will fail, as we are running inside a container. Currently the commands that fail areopenand thelogincommand when used with a provider that uses the browser (like Google or GitHub).
Last updated
Was this helpful?
