Corectl is a command line tool to perform reloads, fetch metadata and evaluate expressions in Qlik Core apps.

If you want to install corectl using brew you have to first tap our homebrew repo with the following:

brew tap qlik-oss/taps

after which you can install corectl by running:

brew install qlik-corectl

Note that the binary is still installed as corectl.

If you prefer, you can install using curl instead. Simply run:

 curl --silent --location "https://github.com/qlik-oss/corectl/releases/latest/download/corectl-Darwin-x86_64.tar.gz" | tar xz -C /tmp && mv /tmp/corectl /usr/local/bin/corectl

If you want to install corectl using snap you can run:

sudo snap install qlik-corectl

This installs qlik-corectl with the alias corectl, so you can still use it as normal (without the qlik- prefix).

If you prefer, you can install using curl instead. Simply run:

 curl --silent --location "https://github.com/qlik-oss/corectl/releases/latest/download/corectl-Linux-x86_64.tar.gz" | tar xz -C /tmp && mv /tmp/corectl /usr/local/bin/corectl

Using the git-bash shell you can install corectl with curl by running:

curl --silent --location "https://github.com/qlik-oss/corectl/releases/latest/download/corectl-windows-x86_64.zip" > corectl.zip && unzip ./corectl.zip -d "$HOME/bin/" && rm ./corectl.zip

You can also download the binary manually from releases.

This sections describes some commands and configuration that can be used with the corectl tool.

To simplify usage of corectl, basic configurations such as: engine connection details, app and objects, can be described in a configuration file. We have added an example configuration file to this repo here.

corectl will automatically check for a corectl.yml | corectl.yaml file in your current directory, removing the need to pass the config file using flags for each command.

Example configuration:

engine: localhost:9076 # URL and port to running Qlik Associative Engine instance
app: corectl-example.qvf # App name that the tool should open a session against.
script: ./script.qvs # Path to a script that should be set in the app
connections: # Connections that should be created in the app
  testdata: # Name of the connection
    connectionstring: /data # Connectionstring (qConnectionString) of the connection. For a folder connector this is an absolute or relative path inside of the engine docker container.
    type: folder # Type of connection
objects:
  - ./object-*.json # Path to objects that should be created from a json file. Accepts wildcards.

For more information regarding which additional options that are configurable are further described here.

Also check out the blog post about utilizing corectl and catwalk to build your data model here.

Usage documentation can be found here.

corectl provides auto completion of commands and flags for bash and zsh. To load completion in your shell add the following to your ~/.bashrc or ~/.zshrc file depending on shell.

if [ $(which corectl) ]; then
  . <(corectl completion <shell>)
fi

(Substitute <shell> with bash or zsh.) Auto completion requires bash-completion to be installed.

If you want add an alias for corectl, you can add the following snippet into your rc file aswell

alias <myalias>=corectl
complete -o default -F __start_corectl <myalias>

where <myalias> should be substituted for whatever you wish to call corectl.

corectl has some basic auto completion for PowerShell. It can be used by doing the following.

First generate the PowerShell script by running:

corectl completion ps > <file-path.ps1>

followed by adding the following to your PowerShell profile

. <file-path.ps1>

• golang >= 1.13

Fast and easy - corectl will be built into the $GOPATH/bin and executable directly from bash using corectl

make install

If you want to keep the previous installed version you can use make build and get the binary to the current working directory

make build

You can also build/install using go as previously:

go build
go install

but this will not include additional build information into corectl (version, branch and commit).

The unit tests are run with the go test command:

go test ./...

The integration tests depend on external components. Before they can run, you must accept the Qlik Core EULA by setting the ACCEPT_EULA environment variable, you start the services by using the docker-compose.yml file. The tests are run with the test script:

ACCEPT_EULA=<yes/no> docker-compose up -d
go test corectl_integration_test.go

The tests are by default trying to connect to the engines running on localhost as defined in the docker-compose.yml file. By setting a series of command line parameters you can run the engines on different hosts and ports:

go test corectl_integration_test.go --engineStd HOST:PORT --engineJwt HOST:PORT --engineAbac HOST:PORT --engineBadLicenseServer HOST:PORT

If the reference output files need to be updated, run the test with --update flag.

go test corectl_integration_test.go --update

The full test-suite can also easily be run with make.

ACCEPT_EULA=<yes/no> make test

For more granular control however the separate commands, mentioned above, should still be used.

You create a release by pushing a commit and a tag with semantic versioning. CircleCi will then run a release build that uses goreleaser to release corectl with the version set as the git tag.

To create a release for e.g. version v1.0.0:

RELEASE_VERSION=v1.0.0 ./release.sh

The script will update the API specification with the new version, create a commit with a tag and push to origin.

The usage documentation is generated using cobra/doc. To regenerate the documentation and the API specification run:

make docs

We welcome and encourage contributions! Please read Open Source at Qlik R&D for more info on how to get involved.