Getting started
Publishing & Sharing
Search and Discovery
COLLABORATION
Settings & Administration
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:
1
npm install -g kyso
2
​
3
or
4
​
5
yarn global add kyso
Copied!
Depending on your local configuration, you might need to use sudo or launch the windows terminal with administrative rights. If that's the case, it's preferrable to review your configuration, but if you are in a hurry you can use sudo 😉
Once installed, check that it's available executing this command:
1
kyso
2
Kyso Client
3
​
4
VERSION
5
@kyso-io/kyso-cli/1.3.1 darwin-arm64 node-v16.14.2
6
​
7
USAGE
8
$ kyso-cli [COMMAND]
9
​
10
TOPICS
11
plugins List installed plugins.
12
​
13
COMMANDS
14
help Display help for kyso-cli.
15
import-repository Import repository to Kyso
16
kyso-command
17
login Login into Kyso
18
open Open a report in the browser
19
plugins List installed plugins.
20
pull Pull repository from Kyso
21
push Upload local repository to Kyso
Copied!
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:
1
npx @kyso-io/kyso-cli
2
Need to install the following packages:
3
@kyso-io/kyso-cli
4
Ok to proceed? (y) y
5
Kyso Client
6
​
7
VERSION
8
@kyso-io/kyso-cli/1.1.2 darwin-arm64 node-v16.14.2
9
​
10
USAGE
11
$ kyso-cli [COMMAND]
12
​
13
TOPICS
14
plugins List installed plugins.
15
​
16
COMMANDS
17
help Display help for kyso-cli.
18
import-repository Import repository to Kyso
19
kyso-command
20
login Login into Kyso
21
open Open a report in the browser
22
plugins List installed plugins.
23
pull Pull repository from Kyso
24
push Upload local repository to Kyso
Copied!
Windows Installers
Kyso CLI release page
Download the installer that fits with your architecture and execute it.
Keep all the options selected for a better experience
Installer components selection
Select the destination folder and press Install
Installer location selection
Installer installing ;)
Once the installation is completed, click on the Close button, open your terminal and write the following command
1
kyso
Copied!
kyso command running
Tarballs
Kyso CLI release page
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
System settings window
Click on Environment Variables...
Environment variables window
Select the Path variable of your user, and click Edit...
Edit path environment variable
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
Added path
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/bin1
export PATH="/home/user/kyso-v1.3.1-9b24ecb-linux-x64/bin:$PATH"
Copied!
Check that it's effectively added by executing:
1
cat ~/.zshrc
2
export PATH="/home/user/kyso-v1.3.1-9b24ecb-linux-x64/bin:$PATH"
Copied!
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/bin1
export PATH="/home/user/kyso-v1.3.1-9b24ecb-linux-x64/bin:$PATH"
Copied!
Check that it's effectively added by executing:
1
cat ~/.bashrc
2
export PATH="/home/user/kyso-v1.3.1-9b24ecb-linux-x64/bin:$PATH"
Copied!
Open a terminal and type the command kyso to check that the installation was completed succesfully
Last modified 1mo ago
Copy link