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

[Andre_Sostizzo]

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

Content:

• Requirements
• Installation method One
• Installation Method Two
• Enable the Completion Feature (optional, but useful)
• Use Qlik-CLI
• Related Content
• Transcript

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 User's System variables 
   6. Click Edit
   7. Click New
   8. Add the path to Qlik-CLI for example C:\Tools\Qlik-QLI\Modify the User Environment. Add path to Qlik-CLI. ie "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.

Related Content

• How to install Qlik-CLI for Qlik Sense on Windows 
• Qlik CLI support and compatibility 
• Qlik Dev - Qlik-CLI 
• Microsoft PowerSheel Profile 
• Generate your first API key 
• Download Qlik-CLI from NuGet
• Download Qlik-CLI from GitHub
• How to use Qlik-CLI to Migrate Apps to Qlik Sense SaaS 

Transcript

Click here for Video Transcript

[nhoover]

@Saranya_Durairaj Can you successfully browse to this directory? just copy and paste the following into the Run dialog, or do a search on your computer: %userprofile%\.qlik

[nhoover]

@Saranya_Durairaj 
Once you browse to the location mentioned above, open the file contexts.yml in notepad and you can add in your API Key manually. My file looks similar to the following:

current-context: myQlikServer.us.qlikcloud.com
contexts:
myQlikServer.us.qlikcloud.com:
headers:
Authorization: Bearer MySuperLongAPIKeyIsLocatedHere
server: https://myQlikServer.us.qlikcloud.com

[Saranya_Durairaj]

Hi @nhoover,

I can able to navigate the path and update the sane which you mentioned in the previous comment. After that, I'm trying to use some examples but getting the "server URL not specified" error. 

[nhoover]

@Saranya_Durairaj I would validate that you modified the server correctly to match your tenant and try again, I feel you are very close to success! You may need to open a support ticket as I'm unable to help past this point.

current-context: SaranyaServer.us.qlikcloud.com
contexts:
SaranyaServer.us.qlikcloud.com:
headers:
Authorization: Bearer MySuperLongAPIKeyIsLocatedHere
server: https://SaranyaServer.us.qlikcloud.com

[Saranya_Durairaj]

Hi @nhoover ,

I have successfully updated the API key in the context file, and it is functioning properly.. Now, I am trying to create the app, but I am getting an error message saying 'No such host'.

For reference,

Regards,

[nhoover]

@Saranya_Durairaj I'm not familiar with this as I only use CLI for a limited scope. Did you get it functioning, was Qlik Support able to resolve?

[Jared]

I'm using qlik cli to upload qvs files to SaaS inside an Azure DevOps Pipeline.

I can run the command successfully from my local computer, no problem at all, but when I put the command into the Azure Pipeline I get an error:

piped input is not support for this command

The command I'm running is:

qlik data-file create --config context.yml --file test.qvs --name test.qvs

As I say, I can run it locally on my windows box, and I've tried both ubuntu and windows OS for the pipeline and get that same error.

Any ideas?