Skip to content

Getting started

This guide walks through initial setup and your first interaction with the CLI.

The easiest way to get started is to create a Slack app with all required scopes pre-configured:

Terminal window
slackbuzz app create

This creates a Slack app manifest, opens the Slack app creation page, and prompts you to paste the OAuth tokens after installing the app to your workspace.

If you already have bot and user tokens from an existing Slack app:

Terminal window
slackbuzz auth login

You will be prompted to paste a bot token (xoxb-...) and optionally a user token (xoxp-...).

Pipe a token via stdin:

Terminal window
echo "$SLACK_BOT_TOKEN" | slackbuzz auth login --with-token
Terminal window
slackbuzz auth status

Re-authenticating after a slackbuzz upgrade

Section titled “Re-authenticating after a slackbuzz upgrade”

If a slackbuzz release adds new scope requirements (a new command whose Slack method needs a scope your existing app manifest doesn’t grant), push the latest manifest to your existing Slack app and re-auth in one flow:

Terminal window
slackbuzz app update

This calls apps.manifest.update with the canonical manifest, opens the reinstall page so you can approve the new scopes, then prompts for the regenerated bot + user tokens.

The manifest is generated automatically from the slackbuzz source tree (make manifest-gen), so the scope list is always exactly what the commands actually need — never more, never stale.

See what needs your attention — mentions, DMs, and threads:

Terminal window
slackbuzz activity

Filter by type:

Terminal window
slackbuzz activity --dms # Direct messages only
slackbuzz activity --threads # Threads you're mentioned in
slackbuzz activity --all # Everything combined

The activity view auto-detects ClickUp task IDs and GitHub PR URLs in messages and shows actionable hints.

Run the doctor to check that your tokens are valid and have the required scopes:

Terminal window
slackbuzz doctor
Terminal window
slackbuzz send '#general' "Hello from the terminal!"

Reply to a thread:

Terminal window
slackbuzz thread #general 1706000000.000000 "Looks good, merging now"

React to a message:

Terminal window
slackbuzz react #general 1706000000.000000 :white_check_mark:

Edit or delete a message:

Terminal window
slackbuzz message edit #general 1706000000.000000 "corrected text"
slackbuzz message delete #general 1706000000.000000 --confirm
Terminal window
slackbuzz status set "Coding" :computer: --until 2h

View your current status:

Terminal window
slackbuzz status

Clear it:

Terminal window
slackbuzz status clear