Skip to main content
Announcements
Marching toward a simplified navigation! READ ON

How to install and start using Qlik-CLI for SaaS editions of Qlik Sense

67% helpful (2/3)
cancel
Showing results for 
Search instead for 
Did you mean: 
Andre_Sostizzo
Digital Support
Digital Support

How to install and start using Qlik-CLI for SaaS editions of Qlik Sense

Last Update:

Jan 17, 2024 4:22:39 AM

Updated By:

Sonja_Bauernfeind

Created date:

Mar 31, 2021 1:46:31 PM

This video will demonstrate how to install and configure Qlik-CLI for SaaS editions of Qlik Sense.

Content:

 

 

Requirements

  • The user has access to a Qlik Cloud tenant
  • The user has a professional license assigned in the tenant
  • The user has the developer role assigned (required for API access)
  • An API key can be obtained

 

Installation method One

  1. Download Qlik-CLI from GitHub
  2. Copy the executable to a local directory
  3. Add the Qlik-CLI as an Environment Variable Path
    1. Open your Windows Control Panel
    2. Navigate to System 
    3. Open Advanced system settings in the leftmost menu
    4. Click Environment Variables 
    5. Locate Path in the System variables 
    6. Click Edit
    7. Click New
    8. Add the path to Qlik-CLI for example C:\Tools\Qlik-QLI\
    9. Confirm with OK until all windows are closed
  4. Confirm the Qlik-CLI location path to verify it the installation completed successfully 
    1. Open PowerShell
    2. Execute:
      get-command qlik​
    3. Closer PowerShell

 

Installation Method Two

  1. Download and install Chocolatey as documented on chocolatey.org.
  2. Open PowerShell
  3. Execute:
    choco install qlik-cli
  4. This completes the installation.

 

Enable the Completion Feature (optional, but useful)

  1. Verify if a PowerShell profile exists or create a new one
    1. Open PowerShell
    2. Execute:
      if ( -not (Test-Path $PROFILE) ) {
         echo "" > $PROFILE
      }​
  2. Open the profile with the command notepad $PROFILE:
    qlik completion ps > "./qlik_completion.ps1" # Create a file containing the powershell completion.
    . ./qlik_completion.ps1                      # Source the completion.​
  3. Save it. 
  4. Restart PowerShell

 

Use Qlik-CLI

Advanced and additional instructions as seen in the video can be found at Qlik-CLI on Qlik.Dev. Begin with Get Started.

 
 
Labels (1)
Comments
josemanzod
Contributor III
Contributor III

josemanzod_0-1675811608844.png

Please help. I can't copy or write the api key, it seems to be disabled

Sonja_Bauernfeind
Digital Support
Digital Support

Hello @josemanzod Can you clarify your query? Are you unable to obtain an API key from Qlik Cloud? In which case, have you verified that it is enabled and that you have the correct role (developer)? See Managing API keys.

Or are you experiencing a different issue?

All the best,
Sonja 

josemanzod
Contributor III
Contributor III

Hi Sonja.

Yes, I do have the key, but I can't write it in the cmd.

Sonja_Bauernfeind
Digital Support
Digital Support

Hello @josemanzod 

The API key will not be written out. In my example, I reached the "API-key" section, right-clicked into PowerShell (default paste operation), and then hit return.

The API key was correctly recorded in the context.yml file.

Sonja_Bauernfeind_1-1676024956378.png

All the best,
Sonja 

 

josemanzod
Contributor III
Contributor III

Hi Sonja.

It was waiting for the api key to be written to the screen.

Thank you.

josemanzod_0-1676068054748.png

 

Bhaskarkumar
Partner - Contributor III
Partner - Contributor III

Get the following error while running any commands but at the same time we are getting the output as well after this error .. i am not sure why I am getting the following error 

Bhaskarkumar_0-1682082732196.png

any help would be much appreciated 

Regards,

Bhaskar

Sonja_Bauernfeind
Digital Support
Digital Support

Hello @Bhaskarkumar 

I cannot reproduce this, so I recommend posting about this directly in our Integration and API forum to see if our active community and support agents can help you get to the bottom of this.

My output (using the command you showed):

apps listed.png

All the best,
Sonja 

Bhaskarkumar
Partner - Contributor III
Partner - Contributor III

Sure, thanks for the response!

 

It's happening when I am using Powershell ISE

regards,

Bhaskar

Version history
Last update:
‎2024-01-17 04:22 AM
Updated by: