Skip to content

Commands Overview

Butler Sheet Icons provides commands for Qlik Sense Cloud, Qlik Sense Enterprise on Windows (QSEoW), and browser management utilities.

Command Structure

bash
butler-sheet-icons <platform> <command> [options]
  • <platform>: qscloud, qseow, or browser
  • <command>: Specific action to perform
  • [options]: Command-specific parameters

Quick Reference

PlatformCommandPurposeAlias
qscloudcreate-sheet-thumbnailsCreate thumbnails for QS Cloud appscreate-sheet-icons
qscloudremove-sheet-iconsRemove thumbnails from QS Cloud appsremove-sheet-thumbnails
qscloudlist-collectionsList available collections
qseowcreate-sheet-thumbnailsCreate thumbnails for QSEoW appscreate-sheet-icons
browserinstallInstall browser for BSI
browserlist-installedShow installed browsers
browserlist-availableShow available browsers for download
browseruninstallRemove specific browser
browseruninstall-allRemove all browsers

No remove-sheet-icons on QSEoW

Removing sheet icons is available for Qlik Sense Cloud only. There is no qseow remove-sheet-icons command — create-sheet-thumbnails is the only qseow command.

Global Options

These options are available for most commands:

OptionDescriptionDefault
--loglevelLogging verbosityinfo
--helpShow command help-
--versionShow version information-

Log Levels

  • error - Only errors
  • warn - Warnings and errors
  • info - General information (default)
  • verbose - Detailed operation info
  • debug - Debug information
  • silly - Everything including websocket traffic

Exit codes

Requires BSI 4.0.0 or later

Earlier versions always exited with 0, whatever happened during the run.

Every command reports its outcome in the process exit code:

Exit codeMeaning
0The command completed, and everything it was asked to do succeeded.
1The command failed, or finished with one or more apps it could not process.

What counts as a failure

  • An app that could not be processed. Other apps in the same run are still attempted — one bad app does not stop the rest — but the run reports failure at the end.
  • A connection that could not be established to the Qlik Sense server or Qlik Sense Cloud tenant.
  • A selection that matched no apps at all, for example a --collectionid that exists but contains no apps, or a --qliksensetag that no app carries. Work was requested and none happened, so this is a failure rather than a silent no-op.
  • A sheet that could not be updated, or whose icon could not be removed. The remaining sheets in that app are still attempted; the app is reported as failed at the end.
  • A Qlik Sense Cloud connection test that returns a response containing no user.

If you run Butler Sheet Icons from a scheduled task, CI pipeline or shell script, read Exit codes and job status before upgrading — a job that always reported success may start reporting failure.

For the log messages that accompany a non-zero exit code, see Run failures and exit codes in Troubleshooting.

Detailed command references

Use these pages for complete, per-platform command details:

For browser cache locations, troubleshooting, and full browser command docs, see the dedicated Browser Commands page.

For environment variables, see Environment variables. For security and platform signing details, see Security.

Getting Help

For any command, use --help to see detailed options:

bash
butler-sheet-icons --help
butler-sheet-icons qscloud --help
butler-sheet-icons qscloud create-sheet-icons --help
butler-sheet-icons qseow create-sheet-thumbnails --help
butler-sheet-icons browser --help

Released under the MIT License.