Getting started
qlik-cli, known on the command line simply as qlik
, is a command line
interface for Qlik Sense SaaS. It provides access to all public APIs
through the command line, making it easier to script and automate new and old
workflows such as:
- Import, export, publish, and republish apps.
- Create, rename, remove, and update spaces and assign user access.
- Build, analyze, and edit apps.
- Administer tenants.
The tool comes with built-in documentation, which is accessed by appending the
--help
flag to any command.
Install
After any installation, don't forget to add the completion as well, it is usually quite helpful when writing commands.
Brew (Mac/Linux)
To install with brew you need to first tap our qlik-oss/taps if you haven't already:
brew tap qlik-oss/taps
After the tap has been tapped you can install the tool with:
brew install qlik-cli
Just like that.
Note: This will work perfectly fine for either Mac or Linux (where you can use linuxbrew
) and even Windows Subsystem Linux (WSL) as a matter of fact.
Chocolatey (Windows)
Want to install using Chocolatey? Then simply type:
choco install qlik-cli
If you need or want to upgrade qlik-cli using chocolatey:
choco upgrade qlik-cli
And you're up to date.
Choco upgrade fail
If you see an error like:
Error retrieving packages from source 'https://www.nuget.org/api/v2':
The combination of parameters provided to this OData endpoint is no longer supported. Please refer to the following URL for more information about this deprecation: https://aka.ms/nuget/odata-deprecation
Then first run:
choco source list
Then remove the one matching nuget.org:
choco source rm --name=nuget.org
Another way to fix a failing upgrade is to uninstall and reinstall.
choco uninstall qlik-cli
choco install qlik-cli
Note: Check out the Completion for Powershell section if you're interested in how to set up Powershell completion.
Executable (Windows)
You can download the Windows executable.
General
Our releases can be found under releases where you can choose a release suitable for your OS.
Get started
Authentication to a Qlik Sense SaaS tenant is done by providing the URL to the
tenant as well as an API key
To quickly get started, you can use the qlik-cli command qlik context init
to
guide you through the process and store the details locally.
$ qlik context init
Acquiring access to Qlik Sense SaaS
To complete the setup you have to have the 'developer' role and have
API-keys enabled. If you're unsure, you can ask your tenant-admin.
Specify your tenant URL, usually in the form: https://<tenant>.<region>.qlikcloud.com
Where <tenant> is the name of the tenant and <region> is eu, us, ap, etc...
Enter tenant url:
If you have multiple users or tenants, you can list and switch between them
through the qlik context ls
and qlik context use <context-name>
.
Most commands return the full API response as json. If you are only
interested in the created or requested resource id, you can add the quiet flag
--quiet
to suppress all but the ID output.
Examples
You can try out the tool with one of the following common use cases. For more examples, refer to the tool documentation.
Import a local app
Import a locally stored app to cloud.
qlik app import -f the_app.qvf
More information about the app resource can be found in qlik app --help
.
Search for an app by name
qlik item ls --resourceType app --name "app name"
More information about the app resource can be found in qlik item --help
.
Create a managed space and assign users
First you create the space and copy the returned ID.
qlik space create --name "Demo Space" --type managed --quiet
Then you assign a user with consumer, contributor, and publisher access by supplying the ID returned by the first call.
qlik space assignment create --spaceId=<ID> --type user --roles consumer,contributor,publisher --assigneeId=<userid> -q
More information about the app resource can be found in qlik space --help
.
List failed reloads
To list all your reloads you enter:
qlik reload ls
Since this list can become very extensive, you probably want to employ
some type of sorting or selection tool. jq is
one such tool and can be used to filter out all failed
reloads from the list.
qlik reload ls | jq '.[] | select(.status == "FAILED")'
More information about the app resource can be found in qlik reload --help
.
Analyze an app
With qlik app meta
, you get an overview of the app with information about its
fields, tables, and associations.
qlik app meta --app <appid/app_name>
You can drill down even further and evaluate dimensions or measures.
qlik app eval --app <appid/app_name> 'Avg(Revenue)' by 'Country'
More information about the app resource can be found in qlik app eval --help
.
Third-party dependencies
The tool uses third-party dependencies listed here .