Skip to content
Logo

CLI reference

Use klack after a release installation. From a source checkout, prefix the same commands with pnpm.

CommandDescription
klack statusPrint the app path, Klack state, and detected Slack version.
klack installInstall or refresh the bootstrap and generated preload.
klack install '#123'Install the latest successful CI build for pull request #123.
klack updateDownload and verify the latest Klack release, then refresh Slack with it.
klack uninstallRemove Klack and restore Slack’s original application resources.

Options

OptionDescription
--app <path>Operate on a Slack app other than /Applications/Slack.app.
--pr <number>Install a pull request build; equivalent to the quoted '#123' selector.
--no-resignSkip macOS ad-hoc signing. The changed app will not launch until it is signed.
-h, --helpPrint command usage.

Test a pull request

PR installation requires an authenticated GitHub CLI and a successful Klack CI run for the PR’s current head commit:

gh auth login
klack install '#123'

Keep the #123 selector quoted because some shells treat an unquoted # as a comment. Klack downloads the CI artifact for your Mac, verifies its checksum, stores it under a PR- and commit-specific version directory, and refreshes Slack with that runtime.

Launch without injection

To start through the installed bootstrap without Klack’s renderer or local plugins, pass --klack-vanilla directly to Slack:

/Applications/Slack.app/Contents/MacOS/Slack --klack-vanilla