Skip to content

Latest commit

 

History

History
49 lines (37 loc) · 2.88 KB

14.1._Install_and_setup_CLI.md

File metadata and controls

49 lines (37 loc) · 2.88 KB

14.1. Install and setup CLI

How to install and setup pipe CLI

  1. Go to Settings → CLI tab.
  2. Select Pipe CLI item at the left panel.
  3. Select your Operation System from the list.
  4. Follow the installation instructions for your OS (e.g. Linux). Commands below shall be executed in the Terminal.
    When installation is finished, type pipe in the Terminal to test pipe installation. This command shall produce short description of pipe CLI and pipe CLI commands.
  5. Press the Generate access key button.
  6. Copy CLI configure command
    CP_InstallAndSetupCLI
  7. Paste copied command into the Terminal and run it:
    CP_InstallAndSetupCLI
  8. Now Cloud Pipeline CLI is ready to use. To check it, run any command, e.g. pipe --help:
    CP_InstallAndSetupCLI

Note: when pipe CLI is being configured JWT token is given for one month, if user didn't select another expiration date. The warning about the expiration date of the provided token is printed, if it is less than 7 days left:

  • after pipe configure command executing:
    CP_InstallAndSetupCLI
  • when any other command is running, e.g.:
    CP_InstallAndSetupCLI

Note: If any exceptions occur during installation, follow the instructions in the Terminal.
Notice that Python 2 / Python 3 has to be installed to run CLI. Python can be downloaded here https://www.python.org/downloads/.
Note: pip package manager is required for CLI installation if you selected Operation System → Other on step 2. Modern Python versions come bundled with pip. On top of that, with this type of installation you'll also need internet connection to install dependencies.

pipe configuration for using NTLM Authentication Proxy

CLI pipe can be configured for using NTLM Authentication Proxy, when running in Linux.

For that, use the following options while execute pipe configure command:

  • -nt or --proxy-ntlm - enables NTLM proxy support
  • -nu or --proxy-ntlm-user - sets username for NTLM proxy authorization
  • -np or --proxy-ntlm-pass - sets password for NTLM proxy authorization
  • -nd or --proxy-ntlm-domain - sets domain for NTLM proxy authorization

If pipe configure command is executing with specified --proxy-ntlm option, pipe will try to get the proxy value from the --proxy option or the environment variables (--proxy option has a higher priority).
Example:

pipe configure --proxy-ntlm --proxy "http://myproxy:3128"

CP_InstallAndSetupCLI

As you can see, if some of the configure options are not set directly in command, you will be prompted to specify them in an interactive manner.