article How to install and start using Qlik-CLI for SaaS editions of Qlik Sense in Official Support Articles

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

Andre_Sostizzo — Mon, 26 Aug 2024 22:28:42 GMT

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

Download Qlik-CLI from GitHub
Copy the executable to a local directory
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
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

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

Enable the Completion Feature (optional, but useful)

Verify if a PowerShell profile exists or create a new one
1. Open PowerShell
2. Execute:
  if ( -not (Test-Path $PROFILE) ) { echo "" > $PROFILE }
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.
Save it.
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.

Transcript

Click here for Video Transcript

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

josemanzod — Tue, 07 Feb 2023 23:14:37 GMT

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

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

Sonja_Bauernfeind — Wed, 08 Feb 2023 10:31:46 GMT

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

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

josemanzod — Wed, 08 Feb 2023 14:47:42 GMT

Hi Sonja.

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

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

Sonja_Bauernfeind — Fri, 10 Feb 2023 10:30:05 GMT

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.

All the best,
Sonja

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

josemanzod — Fri, 10 Feb 2023 22:29:58 GMT

Hi Sonja.

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

Thank you.

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

Bhaskarkumar — Fri, 21 Apr 2023 13:15:10 GMT

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

any help would be much appreciated

Regards,

Bhaskar

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

Sonja_Bauernfeind — Tue, 25 Apr 2023 09:40:04 GMT

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):

All the best,
Sonja

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

Bhaskarkumar — Tue, 25 Apr 2023 09:58:55 GMT

Sure, thanks for the response!

It's happening when I am using Powershell ISE

regards,

Bhaskar

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

nhoover — Tue, 05 Mar 2024 15:45:48 GMT

@josemanzod I had the same trouble as you on a few PC's we set this up on. I ended up copying my context.yml file from a working machine to the machine having the issue. You will need to modify the file a little with a text editor, but it works! Here is where the file resides. %userprofile%\.qlik\contexts.yml

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

Saranya_Durairaj — Thu, 27 Jun 2024 12:12:45 GMT

Hi @Sonja_Bauernfeind,

Based on your comment, I'm trying to paste API key in PowerShell. But getting below error.

Please help me to resolve the issue.

Thanks,

Saranya

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

nhoover — Thu, 27 Jun 2024 12:23:02 GMT

@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

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

nhoover — Thu, 27 Jun 2024 12:33:43 GMT

@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

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

Saranya_Durairaj — Thu, 27 Jun 2024 13:35:47 GMT

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.

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

nhoover — Thu, 27 Jun 2024 15:11:13 GMT

@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

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

Saranya_Durairaj — Mon, 05 Aug 2024 12:21:07 GMT

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,

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

nhoover — Fri, 17 Jan 2025 17:34:10 GMT

@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?

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

Jared — Wed, 19 Feb 2025 04:28:13 GMT

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?

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

tres_sdz — Wed, 02 Jul 2025 13:53:10 GMT

Hi @Saranya_Durairaj, hope you are doing well.
Were you able to resolve the issue? Could you please let know - how? We are also facing the same issue, i.e. - 'dial tcp...' error. @Andre_Sostizzo @nhoover - do you have any information on this?

Thank you

article How to install and start using Qlik-CLI for SaaS editions of Qlik Sense in Official Support Articles

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

Requirements

Installation method One

Installation Method Two

Enable the Completion Feature (optional, but useful)

Use Qlik-CLI

Related Content

Transcript

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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