Advanced configuration

This page explains how you can configure your environment to start publishing research to Kyso using our CLI package.

Kyso runs on premise with its own domain, hosted on your company's own servers.

For that reason, the Kyso CLI can point to multiple instances of Kyso, and before starting to use the Kyso CLI you need to define to which instance you want to point.

Linux and MacOS

Using zsh terminal

Open a ZSH terminal and edit the file ~/.zshrc to add the following environment variable:

export KYSO_API=https://kyso.io/api/v1

Check that it's effectively added by executing:

cat ~/.zshrc
export PATH="/usr/local/opt/openjdk/bin:$PATH"
export KYSO_API=https://kyso.io/api/v1

Close your terminal and open it again (as your current instance of the terminal is not updated until you restart it), and then execute the following command to check that the result is the same:

echo $KYSO_API
https://kyso.io/api/v1

Now all the operations of Kyso CLI will point to the defined instance.

Remember that you can change the value of KYSO_API to your company's on premise instance of Kyso!

Using bash terminal

Open a BASH terminal and edit the file ~/.bashrc to add the NEXT environment variable:

export KYSO_API=https://kyso.io/api/v1

Check that it's effectively added by executing:

cat ~/.bashrc
export PATH="/usr/local/opt/openjdk/bin:$PATH"
export KYSO_API=https://kyso.io/api/v1

Close your terminal and open it again (as your current instance of the terminal is not updated until you restart it), and then execute the following command to check that the result is the same:

echo $KYSO_API
https://kyso.io/api/v1

Now all the operations of Kyso CLI will point to the defined instance.

Remember that you can change the value of KYSO_API to your company's on premise instance of Kyso!

Windows

In order to use and set environment variables in Windows, follow the next steps:

  • Select Windows+R to open Run dialog

  • Type sysdm.cpl and press OK to open a System Properties dialog

  • Go to Advanced > Environment Variables

  • Click the "New" button in System variables section, and fill in the text-boxes with the following contents:

    • Variable name: KYSO_API

    • Variable value: https://kyso.io/api/v1

Remember that you can change the value of KYSO_API to your company's on premise instance of Kyso!

Last updated