slack-rs 0.1.70

A Slack CLI tool with OAuth authentication, profile management, and API access
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292

# Slack CLI Recipes

This document provides practical examples for common tasks using the Slack CLI.

## Table of Contents

- [Profile Management](#profile-management)
- [Output Format Control](#output-format-control)
- [Conversations and Threads](#conversations-and-threads)
- [Error Handling](#error-handling)

## Profile Management

### Switching Between Profiles

Use the `SLACK_PROFILE` environment variable to select a profile:

```bash
# Use default profile
slack-rs api call auth.test

# Use a specific profile
SLACK_PROFILE=work slack-rs api call auth.test

# Use a different profile for a session
export SLACK_PROFILE=personal
slack-rs conv list
slack-rs msg post C123456 "Hello from personal workspace"
```

### List All Profiles

```bash
# Show all configured profiles
slack-rs auth list

# Show detailed status for a profile
slack-rs auth status work
```

### Setting Default Token Type

```bash
# Set default token type for a profile
slack-rs config set work --token-type user

# Now all commands will use user token by default
slack-rs api call users.info user=U123456
```

## Output Format Control

### Raw vs Envelope Output

The CLI provides two output formats:

1. **Envelope format** (default): Includes metadata (profile, team_id, user_id, method)
2. **Raw format**: Returns only the Slack API response

```bash
# Default envelope output
slack-rs api call users.info user=U123456
# Output: {"response": {...}, "meta": {...}}

# Raw output with --raw flag
slack-rs api call users.info user=U123456 --raw
# Output: {"ok": true, "user": {...}}

# Raw output with environment variable (affects all commands)
export SLACKRS_OUTPUT=raw
slack-rs api call users.info user=U123456
# Output: {"ok": true, "user": {...}}

# Switch back to envelope format
export SLACKRS_OUTPUT=envelope
slack-rs api call users.info user=U123456
# Output: {"response": {...}, "meta": {...}}
```

### Using jq with Raw Output

```bash
# Extract specific fields with jq
slack-rs api call users.info user=U123456 --raw | jq '.user.name'

# Use SLACKRS_OUTPUT for cleaner scripts
export SLACKRS_OUTPUT=raw
slack-rs api call users.info user=U123456 | jq '.user.name'

# List channels and extract names
slack-rs api call conversations.list | jq '.channels[].name'
```

## Conversations and Threads

### List Conversations

```bash
# List all conversations (envelope format)
slack-rs conv list

# List with raw output
slack-rs conv list --raw

# Filter by type
slack-rs conv list --filter type:public_channel

# Interactive selection
slack-rs conv select
```

### Get Conversation History

```bash
# Get recent messages from a channel
slack-rs conv history C123456

# Get with specific limit
slack-rs conv history C123456 --limit=50

# Interactive mode with filters
slack-rs conv history --interactive --filter type:public_channel
```

### Post Messages and Threads

```bash
# Post a simple message
slack-rs msg post C123456 "Hello, team!"

# Post a threaded reply
slack-rs msg post C123456 "Reply text" --thread-ts=1234567890.123456

# Post a threaded reply visible in channel
slack-rs msg post C123456 "Important update" \
  --thread-ts=1234567890.123456 \
  --reply-broadcast
```

### Get Thread Replies

```bash
# Get all replies in a thread
slack-rs api call conversations.replies \
  channel=C123456 \
  ts=1234567890.123456 \
  --raw | jq '.messages'
```

## Error Handling

### Debug Mode

Use `--debug` or `--trace` to troubleshoot issues:

```bash
# Show debug information
slack-rs api call users.info user=U123456 --debug
# Output to stderr:
# DEBUG: Profile: default
# DEBUG: Token store: file storage/file
# DEBUG: Token type: bot
# DEBUG: API method: users.info
# DEBUG: Endpoint: https://slack.com/api/users.info

# Verbose trace mode
slack-rs api call users.info user=U123456 --trace
# Shows additional trace-level information
```

### Common Errors

#### Missing Token

```bash
# Error: No token found
slack-rs api call auth.test

# Solution: Login first
slack-rs auth login

# Or set token via environment
export SLACK_TOKEN=xoxb-your-token
slack-rs api call auth.test
```

#### Token Type Mismatch

```bash
# Error: not_allowed_token_type
slack-rs api call conversations.list --token-type=user

# Solution: Use bot token
slack-rs api call conversations.list --token-type=bot

# Or set as default
slack-rs config set default --token-type bot
```

#### Write Protection

```bash
# Error: Write operation not allowed
SLACKCLI_ALLOW_WRITE=false slack-rs msg post C123456 "Test"

# Solution: Enable write operations
SLACKCLI_ALLOW_WRITE=true slack-rs msg post C123456 "Test"
```

#### Non-interactive Mode

```bash
# Error: Operation requires confirmation in non-interactive mode
echo | slack-rs msg delete C123456 1234567890.123456

# Solution: Use --yes flag
echo | slack-rs msg delete C123456 1234567890.123456 --yes

# Or use explicit --non-interactive
slack-rs msg delete C123456 1234567890.123456 --yes --non-interactive
```

### Error Guidance

The CLI automatically provides guidance for common errors:

```bash
# Example: channel_not_found error
slack-rs api call chat.postMessage channel=INVALID text=Hello
# Output includes:
# Error: channel_not_found
# Cause: Channel ID is invalid or bot is not a member
# Resolution: Verify channel ID and add bot to channel

# Use --debug to see additional context
slack-rs api call chat.postMessage channel=INVALID text=Hello --debug
# Shows:
# DEBUG: Slack error code: channel_not_found
```

### Check API Response

```bash
# Check if operation succeeded
slack-rs api call auth.test --raw | jq '.ok'
# Output: true or false

# Extract error message if failed
slack-rs api call chat.postMessage channel=INVALID text=Hello --raw | jq '.error'
# Output: "channel_not_found"
```

## Advanced Patterns

### Batch Operations

```bash
# Process multiple channels
export SLACKRS_OUTPUT=raw
for channel in C111 C222 C333; do
  echo "Processing $channel"
  slack-rs msg post $channel "Notification message"
done
```

### Safe Write Operations

```bash
# Script with write safety
set -e  # Exit on error

# Check write permission first
if [ "$SLACKCLI_ALLOW_WRITE" != "true" ]; then
  echo "Write operations disabled"
  exit 1
fi

# Perform write operation
slack-rs msg post C123456 "Deployment complete"
```

### Pipeline Processing

```bash
# Get channel list and process with jq
export SLACKRS_OUTPUT=raw
slack-rs api call conversations.list | \
  jq -r '.channels[] | select(.is_archived == false) | .id' | \
  while read channel; do
    echo "Active channel: $channel"
  done
```