Skip to content

Commit f44f4d9

Browse files
isaacrowntreeclaude
andcommitted
docs: remove digest references, add file upload, regenerate reference
Remove all references to the removed digest command from README, docs site, and setup script. Document the file upload command. Regenerate auto-generated reference pages from the current Cobra command tree. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 2086765 commit f44f4d9

15 files changed

Lines changed: 247 additions & 230 deletions

README.md

Lines changed: 7 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,13 @@ A command-line tool for working with Slack messages, channels, and cross-tool wo
88
[![Go Report Card](https://goreportcard.com/badge/github.com/triptechtravel/slackbuzz-cli)](https://goreportcard.com/report/github.com/triptechtravel/slackbuzz-cli)
99
[![Go Reference](https://pkg.go.dev/badge/github.com/triptechtravel/slackbuzz-cli.svg)](https://pkg.go.dev/github.com/triptechtravel/slackbuzz-cli)
1010

11-
`slackbuzz` bridges Slack, ClickUp, and GitHub from your terminal. Read your inbox, reply to messages, manage your status, and get a cross-tool morning briefing without opening a browser.
11+
`slackbuzz` brings Slack to your terminal. Read your inbox, reply to messages, manage your status, upload files, and search your workspace without opening a browser.
1212

1313
## Features
1414

1515
- **Activity inbox** -- see mentions, DMs, and threads that need your attention (alias: `inbox`)
16-
- **Cross-tool digest** -- morning briefing combining Slack mentions, ClickUp tasks, and GitHub PRs
1716
- **Message management** -- list, send, search, edit, and delete messages in any channel or DM
18-
- **File search** -- search files shared across your workspace
17+
- **File upload & search** -- upload files to channels/DMs (multi-file, thread support) and search shared files
1918
- **Thread support** -- read and reply to threads
2019
- **Reactions** -- add and remove reactions, see reactions inline in activity views
2120
- **Saved items** -- save messages for later and manage your bookmarks
@@ -75,10 +74,10 @@ Send a message:
7574
slackbuzz send '#general' "Hello from the terminal!"
7675
```
7776

78-
Get a cross-tool morning briefing:
77+
Upload a file:
7978

8079
```sh
81-
slackbuzz digest
80+
slackbuzz file upload report.pdf '#general'
8281
```
8382

8483
## Team setup
@@ -103,7 +102,6 @@ The script installs slackbuzz, sets up the Claude Code skill, and walks through
103102
| `slackbuzz activity --all --since 1d` | Everything from the last day |
104103
| `slackbuzz threads` | Show threads you're participating in |
105104
| `slackbuzz dm list` | List DM conversations with recent activity |
106-
| `slackbuzz digest` | Cross-tool briefing (Slack + ClickUp + GitHub) |
107105
| `slackbuzz later list` | Show saved/bookmarked messages |
108106
| `slackbuzz later add <channel> <ts>` | Save a message for later |
109107
| `slackbuzz later remove <channel> <ts>` | Unsave a message |
@@ -118,6 +116,7 @@ The script installs slackbuzz, sets up the Claude Code skill, and walks through
118116
| `slackbuzz message edit <channel> <ts> "text"` | Edit a message |
119117
| `slackbuzz message delete <channel> <ts>` | Delete a message |
120118
| `slackbuzz message search <query>` | Search messages (user token required) |
119+
| `slackbuzz file upload <file>... <channel>` | Upload files to a channel or DM |
121120
| `slackbuzz file search <query>` | Search files (user token required) |
122121
| `slackbuzz react <channel> <ts> :emoji:` | React to a message |
123122
| `slackbuzz react remove <channel> <ts> :emoji:` | Remove a reaction |
@@ -178,35 +177,9 @@ The `slackbuzz app create` command creates a Slack app pre-configured with all r
178177

179178
**User token (`xoxp-`):** `channels:read`, `chat:write`, `groups:read`, `im:read`, `im:write`, `mpim:read`, `search:read`, `stars:read`, `stars:write`, `users:read`, `users.profile:read`, `users.profile:write`
180179

181-
## Cross-tool integration
180+
## Cross-tool enrichment
182181

183-
The `digest` command combines activity from Slack, ClickUp, and GitHub in a single view:
184-
185-
```sh
186-
$ slackbuzz digest
187-
188-
SLACK -- 3 unread mentions
189-
@alice in #dev "Can you review PR #42?" 2h ago
190-
@bob in #backend "CU-abc needs your input" 5h ago
191-
@sarah DM "meeting at 3?" 1d ago
192-
193-
CLICKUP -- 2 tasks assigned to you
194-
CU-abc123 In Review API redesign
195-
CU-def456 In Progress Deploy pipeline fix
196-
197-
GITHUB -- 1 PR needs your review
198-
#42 feat: add caching layer alice +120 -30
199-
200-
---
201-
Quick actions:
202-
slackbuzz message send #dev "reviewing now"
203-
clickup task update CU-abc123 --status complete
204-
gh pr review 42 --approve
205-
```
206-
207-
The digest shells out to the `clickup` and `gh` CLIs if installed. Sections are gracefully skipped if a CLI isn't available.
208-
209-
The activity view also auto-detects ClickUp task IDs (`CU-abc123`) and GitHub PR/issue URLs in messages and shows actionable hints:
182+
The activity view auto-detects ClickUp task IDs (`CU-abc123`) and GitHub PR/issue URLs in messages and shows actionable hints:
210183

211184
```sh
212185
$ slackbuzz activity
@@ -273,9 +246,6 @@ slackbuzz thread #engineering 1706000000.000000 "Fix deployed, see PR #42"
273246

274247
# AI agent reacts to acknowledge
275248
slackbuzz react #engineering 1706000000.000000 :white_check_mark:
276-
277-
# AI agent gets cross-tool context
278-
slackbuzz digest --json
279249
```
280250

281251
The `--json` flag on all commands outputs structured data that agents can parse. The activity view includes channel IDs, timestamps, and permalinks that agents can use to take action.

docs/src/content/docs/ai-agents.md

Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -58,18 +58,6 @@ slackbuzz channel list --json
5858
slackbuzz activity --json --jq '[.[] | select(.type == "mention")]'
5959
```
6060

61-
### Cross-tool context
62-
63-
The `digest` command gives agents a complete picture across Slack, ClickUp, and GitHub:
64-
65-
```sh
66-
# Get cross-tool context in one call
67-
slackbuzz digest --json
68-
69-
# Slack mentions only
70-
slackbuzz digest --slack-only --json
71-
```
72-
7361
### ClickUp and GitHub enrichment
7462

7563
Activity views auto-detect ClickUp task IDs and GitHub PR URLs. The JSON output includes these references, allowing agents to follow up with the appropriate CLI:
@@ -131,7 +119,7 @@ An agent can prepare a morning standup summary:
131119

132120
```sh
133121
# Get everything from the last day
134-
slackbuzz digest --since 1d --json
122+
slackbuzz activity --all --since 1d --json
135123

136124
# Check saved items that need follow-up
137125
slackbuzz later list --json
@@ -209,7 +197,7 @@ slackbuzz doctor
209197
- Use `--json` output when you need the agent to parse data programmatically
210198
- Use `slackbuzz activity --json` to discover what needs attention
211199
- Use `slackbuzz message list --json` to give the agent context from channel discussions
212-
- Use `slackbuzz digest --json` to give the agent cross-tool context
200+
- Use `slackbuzz activity --all --json` to give the agent full context across mentions, DMs, and threads
213201
- The activity view includes channel IDs, timestamps, and permalinks that agents can use to take action
214202
- Use `slackbuzz message edit` and `slackbuzz message delete` to correct mistakes
215203
- Use `slackbuzz file search` to find shared files and documents

docs/src/content/docs/commands.md

Lines changed: 31 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ The CLI automatically picks the correct token (bot or user) for each command. Yo
2020
| `react`, `react remove` | **Bot** | Reactions |
2121
| `notify` | **Bot** | System/automated notifications |
2222
| `thread link` | **Bot** | Generates permalinks |
23-
| `activity`, `threads`, `digest` | **User** | Search API (user-only) |
23+
| `activity`, `threads` | **User** | Search API (user-only) |
2424
| `dm list` | **User** | Search API (user-only) |
2525
| `message search`, `file search` | **User** | Search API (user-only) |
2626
| `later list`, `add`, `remove` | **User** | Stars API (user-only) |
@@ -170,42 +170,6 @@ slackbuzz later remove #general 1706000000.000000
170170

171171
---
172172

173-
## digest
174-
175-
### `digest`
176-
177-
Cross-tool morning briefing combining Slack mentions, ClickUp tasks, and GitHub PRs.
178-
179-
```sh
180-
# Full briefing
181-
slackbuzz digest
182-
183-
# Only Slack section
184-
slackbuzz digest --slack-only
185-
186-
# Only ClickUp section
187-
slackbuzz digest --clickup-only
188-
189-
# Only GitHub section
190-
slackbuzz digest --github-only
191-
192-
# JSON output
193-
slackbuzz digest --json
194-
```
195-
196-
| Flag | Description |
197-
|------|-------------|
198-
| `--since DURATION` | How far back to search for Slack mentions |
199-
| `--slack-only` | Only show Slack section |
200-
| `--clickup-only` | Only show ClickUp section |
201-
| `--github-only` | Only show GitHub section |
202-
| `--json` | Output as JSON |
203-
| `--jq EXPR` | Filter JSON output with a jq expression |
204-
205-
Requires the [ClickUp CLI](https://github.com/triptechtravel/clickup-cli) and [GitHub CLI](https://cli.github.com/) for the respective sections. Missing CLIs are gracefully skipped.
206-
207-
---
208-
209173
## send
210174

211175
### `send <channel|user> <text>`
@@ -378,7 +342,36 @@ Quick actions:
378342

379343
## file
380344

381-
Search files shared in Slack.
345+
Upload and search files shared in Slack.
346+
347+
### `file upload <file-path>... <channel|user>`
348+
349+
Upload one or more files to a channel or DM. Each file is uploaded individually and shared to the target.
350+
351+
```sh
352+
# Upload a single file
353+
slackbuzz file upload report.pdf #general
354+
355+
# Upload multiple files
356+
slackbuzz file upload chart1.png chart2.png #analytics
357+
358+
# Upload with title and comment
359+
slackbuzz file upload data.csv #sales --title "Q4 Revenue" --comment "Updated data"
360+
361+
# Upload to a DM
362+
slackbuzz file upload notes.txt @alice
363+
364+
# Upload to a thread
365+
slackbuzz file upload results.png #dev --thread-ts 1706000000.000000
366+
```
367+
368+
| Flag | Description |
369+
|------|-------------|
370+
| `--title TEXT` | File title in Slack (applies to first file) |
371+
| `--comment TEXT` | Initial comment posted with the file(s) |
372+
| `--thread-ts TIMESTAMP` | Thread timestamp to upload into |
373+
| `--json` | Output as JSON |
374+
| `--jq EXPR` | Filter JSON output with a jq expression |
382375

383376
### `file search <query>`
384377

docs/src/content/docs/cross-tool-integration.md

Lines changed: 7 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -7,52 +7,6 @@ description: How slackbuzz bridges Slack, ClickUp, and GitHub from the terminal.
77

88
SlackBuzz is designed as the glue between Slack, ClickUp, and GitHub CLIs. It detects references to other tools in your Slack messages and provides actionable hints.
99

10-
## The digest command
11-
12-
The `digest` command combines activity from all three tools in a single view:
13-
14-
```sh
15-
$ slackbuzz digest
16-
17-
SLACK -- 3 unread mentions
18-
@alice in #dev "Can you review PR #42?" 2h ago
19-
@bob in #backend "CU-abc needs your input" 5h ago
20-
@sarah DM "meeting at 3?" 1d ago
21-
22-
CLICKUP -- 2 tasks assigned to you
23-
CU-abc123 In Review API redesign
24-
CU-def456 In Progress Deploy pipeline fix
25-
26-
GITHUB -- 1 PR needs your review
27-
#42 feat: add caching layer alice +120 -30
28-
29-
---
30-
Quick actions:
31-
slackbuzz message send #dev "reviewing now"
32-
clickup task update CU-abc123 --status complete
33-
gh pr review 42 --approve
34-
```
35-
36-
### How it works
37-
38-
The digest shells out to the `clickup` and `gh` CLIs if installed:
39-
40-
- **Slack**: Uses `search.messages` API to find your recent mentions
41-
- **ClickUp**: Runs `clickup task list --assignee me --json` to find your assigned tasks
42-
- **GitHub**: Runs `gh pr list --review-requested=@me --json` to find PRs needing review
43-
44-
Sections are gracefully skipped if a CLI is not installed (`exec.LookPath`).
45-
46-
### Flags
47-
48-
```sh
49-
slackbuzz digest --since 2d # Look back 2 days instead of default
50-
slackbuzz digest --slack-only # Only show Slack section
51-
slackbuzz digest --clickup-only # Only show ClickUp section
52-
slackbuzz digest --github-only # Only show GitHub section
53-
slackbuzz digest --json # Structured output
54-
```
55-
5610
## Enrichment in activity views
5711

5812
The `activity` and `threads` commands auto-detect cross-tool references in message text:
@@ -88,8 +42,8 @@ Deeplink format: `slack://channel?team=TEAM_ID&id=CHANNEL_ID&message=TIMESTAMP`
8842
A typical morning workflow combining all three tools:
8943

9044
```sh
91-
# 1. Check what needs attention across all tools
92-
slackbuzz digest
45+
# 1. Check what needs attention
46+
slackbuzz activity
9347

9448
# 2. Read the thread that mentions a ClickUp task
9549
slackbuzz message list #backend --thread-ts 1706000000.000000
@@ -110,12 +64,12 @@ slackbuzz react #backend 1706000000.000000 :eyes:
11064
slackbuzz later add #backend 1706000000.000000
11165
```
11266

113-
## Required CLIs
67+
## Related CLIs
11468

115-
| Tool | Install | Used by |
116-
|------|---------|---------|
69+
| Tool | Install | Used for |
70+
|------|---------|----------|
11771
| **slackbuzz** | `brew install triptechtravel/tap/slackbuzz` | Core Slack operations |
118-
| **clickup** | `brew install triptechtravel/tap/clickup` | `digest` ClickUp section, task ID enrichment hints |
119-
| **gh** | `brew install gh` | `digest` GitHub section, PR URL enrichment hints |
72+
| **clickup** | `brew install triptechtravel/tap/clickup` | Follow up on ClickUp task ID enrichment hints |
73+
| **gh** | `brew install gh` | Follow up on GitHub PR URL enrichment hints |
12074

12175
All three CLIs store credentials in the system keyring and support `--json` output for programmatic access.

docs/src/content/docs/getting-started.md

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -110,18 +110,8 @@ Clear it:
110110
slackbuzz status clear
111111
```
112112

113-
## Step 6: Get a cross-tool briefing
114-
115-
If you have the ClickUp CLI and GitHub CLI installed, get a combined view of everything across tools:
116-
117-
```sh
118-
slackbuzz digest
119-
```
120-
121-
This shows Slack mentions, ClickUp tasks assigned to you, and GitHub PRs needing your review.
122-
123113
## Next steps
124114

125115
- See the full [Command reference](/slackbuzz-cli/commands/) for all available commands and flags.
126-
- Learn about [Cross-tool integration](/slackbuzz-cli/cross-tool-integration/) to combine Slack, ClickUp, and GitHub workflows.
116+
- Learn about [Cross-tool integration](/slackbuzz-cli/cross-tool-integration/) for ClickUp and GitHub enrichment in activity views.
127117
- Read [Using with AI agents](/slackbuzz-cli/ai-agents/) for integrating the CLI with Claude Code, Copilot, and Cursor.

docs/src/content/docs/index.mdx

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,8 @@ import { Card, CardGrid } from '@astrojs/starlight/components';
4747
<Card title="Activity inbox" icon="pencil">
4848
See mentions, DMs, and threads that need your attention -- with ClickUp and GitHub enrichment.
4949
</Card>
50-
<Card title="Cross-tool digest" icon="list-format">
51-
Morning briefing combining Slack mentions, ClickUp tasks, and GitHub PRs in one view.
50+
<Card title="File uploads" icon="list-format">
51+
Upload files to channels and DMs with multi-file and thread support.
5252
</Card>
5353
<Card title="Messaging" icon="rocket">
5454
Send messages, reply to threads, react to messages, and search across your workspace.
@@ -87,9 +87,6 @@ slackbuzz app create
8787
# Check your inbox
8888
slackbuzz activity
8989

90-
# Get a cross-tool morning briefing
91-
slackbuzz digest
92-
9390
# Send a message
9491
slackbuzz message send #general "Hello from the terminal!"
9592
```

docs/src/content/docs/reference/slackbuzz.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,6 @@ Slack CLI - message, search, and manage channels from the command line
1111

1212
Work with Slack channels, messages, and users from your terminal.
1313

14-
Integrates with ClickUp and GitHub CLIs for cross-tool developer workflows.
15-
1614
GETTING STARTED
1715
slackbuzz app create Create a Slack app with required scopes
1816
slackbuzz auth login Log in with bot/user tokens
@@ -21,8 +19,6 @@ INBOX & ACTIVITY
2119
slackbuzz activity See mentions, DMs, and threads (alias: inbox)
2220
slackbuzz threads Threads you're participating in
2321
slackbuzz dm list DM conversations with recent activity
24-
slackbuzz digest Cross-tool briefing (Slack + ClickUp + GitHub)
25-
2622
MESSAGING
2723
slackbuzz message list <chan> Read channel/thread history
2824
slackbuzz message send <chan> Send a message
@@ -59,13 +55,14 @@ TIPS
5955
* [slackbuzz auth](/slackbuzz-cli/reference/slackbuzz_auth/) - Authenticate with Slack
6056
* [slackbuzz channel](/slackbuzz-cli/reference/slackbuzz_channel/) - Manage Slack channels
6157
* [slackbuzz completion](/slackbuzz-cli/reference/slackbuzz_completion/) - Generate shell completion scripts
62-
* [slackbuzz digest](/slackbuzz-cli/reference/slackbuzz_digest/) - Cross-tool morning briefing (Slack + ClickUp + GitHub)
6358
* [slackbuzz dm](/slackbuzz-cli/reference/slackbuzz_dm/) - Direct message management
64-
* [slackbuzz file](/slackbuzz-cli/reference/slackbuzz_file/) - Search and manage files
59+
* [slackbuzz doctor](/slackbuzz-cli/reference/slackbuzz_doctor/) - Check token health and required scopes
60+
* [slackbuzz file](/slackbuzz-cli/reference/slackbuzz_file/) - Search, upload, and manage files
6561
* [slackbuzz later](/slackbuzz-cli/reference/slackbuzz_later/) - Saved/bookmarked items
6662
* [slackbuzz message](/slackbuzz-cli/reference/slackbuzz_message/) - Send and read Slack messages
6763
* [slackbuzz notify](/slackbuzz-cli/reference/slackbuzz_notify/) - Send formatted notifications
6864
* [slackbuzz react](/slackbuzz-cli/reference/slackbuzz_react/) - React to a message
65+
* [slackbuzz send](/slackbuzz-cli/reference/slackbuzz_send/) - Send a message (shortcut for 'message send')
6966
* [slackbuzz status](/slackbuzz-cli/reference/slackbuzz_status/) - Slack status management
7067
* [slackbuzz thread](/slackbuzz-cli/reference/slackbuzz_thread/) - Work with Slack threads
7168
* [slackbuzz threads](/slackbuzz-cli/reference/slackbuzz_threads/) - Show threads you're participating in

0 commit comments

Comments
 (0)