Skip to main content

# kater admin slack setup

Checks that the Kater server of your target is ready for Slack, then opens its Slack tab, where you install Kater in Slack.

{/* Written by apps/landing-page/scripts/docs/write_cli_reference.py from the kater CLI's own help and scripts/docs/cli-reference.md. Do not edit it by hand: change those, then run the script. */}

Run `kater login` first. You approve the installation in your browser, in Slack.

## Examples

```bash
# Check the server, then open the Slack tab
kater admin slack setup
# Print the address of the Slack tab, and open no browser
kater admin slack setup --no-browser
# Set up Slack for the Kater API of the prod target
kater admin slack setup --target prod
# Print the server setup steps, without a sign-in
kater admin slack setup --guide
```

## Options

<div class="cli-options">

| Option | Description |
| --- | --- |
| `--guide` | Prints the steps that your Kater operator follows to set up the server. It does not sign in or call the API. |
| `--no-browser` | Prints the address of the Slack tab, and opens no browser. |

</div>

It also takes `--help`.

## What it checks

- When the server is missing Slack settings, the command names them, prints the setup steps, and exits with code 1.
- When the server is ready, it opens the Slack tab of Kater's settings. Select **Install Kater in Slack**, select your workspace, then select **Allow** in Slack.
- When Kater is already installed, it names the Slack workspace. When Slack needs new permissions, it asks you to review them on the Slack tab.
- Server secrets stay in the settings of the Kater API and the worker.

It needs the `settings:manage` permission.

## See also

- [`kater admin slack`](https://kater.ai/docs/cli-reference/admin/slack/)
- [All commands](https://kater.ai/docs/cli-reference/kater/)

On this page

Examples
Options
What it checks
See also

Kater CLI Share and administer admin slack

kater admin slack setup

Checks that the Kater server of your target is ready for Slack, then opens its Slack tab, where you install Kater in Slack.

Run kater login first. You approve the installation in your browser, in Slack.

Examples

# Check the server, then open the Slack tab
kater admin slack setup
# Print the address of the Slack tab, and open no browser
kater admin slack setup --no-browser
# Set up Slack for the Kater API of the prod target
kater admin slack setup --target prod
# Print the server setup steps, without a sign-in
kater admin slack setup --guide

Options

Option	Description
`--guide`	Prints the steps that your Kater operator follows to set up the server. It does not sign in or call the API.
`--no-browser`	Prints the address of the Slack tab, and opens no browser.

It also takes --help.

What it checks

When the server is missing Slack settings, the command names them, prints the setup steps, and exits with code 1.
When the server is ready, it opens the Slack tab of Kater’s settings. Select Install Kater in Slack, select your workspace, then select Allow in Slack.
When Kater is already installed, it names the Slack workspace. When Slack needs new permissions, it asks you to review them on the Slack tab.
Server secrets stay in the settings of the Kater API and the worker.

It needs the settings:manage permission.

See also