Skip to content

Getting started

Getting started

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

Step 1: Create a Slack app

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.

Alternative: log in with existing tokens

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-...).

CI / non-interactive mode

Pipe a token via stdin:

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

Check authentication status

Terminal window
slackbuzz auth status

Step 2: Check your inbox

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.

Step 3: Send a message

Terminal window
slackbuzz message 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

Step 4: Set your status

Terminal window
slackbuzz status set "Coding" :computer: --until 2h

View your current status:

Terminal window
slackbuzz status

Clear it:

Terminal window
slackbuzz status clear

Step 5: Get a cross-tool briefing

If you have the ClickUp CLI and GitHub CLI installed, get a combined view of everything across tools:

Terminal window
slackbuzz digest

This shows Slack mentions, ClickUp tasks assigned to you, and GitHub PRs needing your review.

Next steps