Slack の投稿を解析することを目的とした CLI です。
設定する必要がある環境変数は Slack 用のユーザートークン（ SLACK_TOKEN ）とボットトークン（ SLACK_BOT_TOKEN ）の 2 つです。
https://api.slack.com/ にて作成して設定してください。
また、必要に応じて SLACK_TEAM_ID も設定することができます。
| 環境変数名 | 必須 | 用途 |
|---|---|---|
| SLACK_BOT_TOKEN | ⭕ | ボットトークン。Slack API を利用するために必須。 |
| SLACK_TOKEN | ⭕ | ユーザートークン。Slack API をユーザーとして利用する際に利用。 |
| SLACK_TEAM_ID | ❌ | Slack の team_id。設定したトークンが複数チームに所属している場合指定する。 |
| SLACK_SIGNING_SECRET | 🔺 | Slash Command として BOT を起動させる場合必須。 |
| SLACK_ARCHIVE_WORKFLOW_WEBHOOK_URL | ❌ | Slack チャンネルのアーカイブを行うワークフローの Webhook URL。archive コマンド利用する場合に利用。（＊1） |
| SLACK_EARLY_CHANNEL | ❌ | 条件を満たした投稿を通知する際の通知先。Slack BOT として起動させる場合に利用可能。（＊2） |
| SLACK_HOT_CHANNEL | ❌ | 条件を満たした投稿を通知する際の通知先。Slack BOT として起動させる場合に利用可能。（＊2） |
| OPENAI_API_KEY | ❌ | OpenAI の apiKey。summarize 関連のコマンドを使用する際に必須。 |
| OPENAI_API_BASE | ❌ | OpenAI の basePath。sumamrize 関連のコマンドを使用する際に必須。 |
| OPENAI_MODEL | ❌ | OpenAI の model。デフォルトは 'text-davinci-003' |
| OPENAI_API_VERSION | ❌ | OpenAI の api-version。デフォルトは '2022-12-01' |
| GOOGLE_SPREADSHEET_ID | ❌ | GoogleSpreadsheet の ID。aggregate コマンドの取得結果を出力する場合に利用。（＊3） |
現状 SLACK_TOKEN も必須となってしまっているのでユーザートークンを使わない場合は SLACK_BOT_TOKEN と同じものを設定してください。
（＊1）使用する場合 https://api.slack.com/automation/triggers/webhook を参考にアーカイブするワークフローおよびトリガーを作成して Webhook URL を設定する必要がある。
（＊2）使用する場合 Events API の reaction_added と reactione_removed 権限が必要。また、SQLite3 をインストールしておく必要がある。
（＊3）使用する場合 project root にスプレッドシートの利用権限が付与されている .spreadsheet-credential.json も必要。また、 GOOGLE_SPREADSHEET_ID で指定したスプレッドシートの編集権限が付いている必要がある。
権限が足りない場合は Slack Web API から必要なスコープ情報が返ってきます。
事前に全てを網羅することは現実的ではないので、実際にコマンドを実行してみてエラーになったスコープを都度追加してください。
環境変数 SLACK_SIGNING_SECRET を設定した上で Slack App に /slack-cli を登録した上で bot:start コマンドにて起動してください。
特定のユーザーのみ利用できるようにしたい場合は --permitted-users オプションに , 区切りで許可したいユーザーの user-id を指定してください。
オプションの一覧は以下の通りです。
| オプション | 用途 |
|---|---|
| --port | ポート番号を指定する。デフォルト値は 3000 |
| --permitted-users | 特定のユーザーのみ利用できるようにしたい場合に , 区切りで user-id を指定する。 |
| --monitoring-channel-id | コマンドが実行されたことを通知するチャンネルの ID |
| --debug | デバッグログを出力する場合に指定する |
bot:start --debug --permitted-users "UXXXXX,UYYYYY" --port 3001
slack-cli --help にて一覧を確認できます。
| コマンド名 | 概要 |
|---|---|
| aggregate:reactions | 指定された期間内に指定されたリアクション数が多いユーザーを上位 5 位までリストアップする |
| aggregate:members-reacted | 指定された期間内に指定されたリアクションを最も行ったユーザー上位 5 位までリストアップする |
| archive:channel | 指定されたパブリックチャンネルをアーカイブする |
| archive:inactive-channels | 指定された期間以上更新のないパブリックチャンネル全てをアーカイブする |
| delete:message | 指定された投稿を削除する（この BOT が投稿したもののみ）る |
| get:channels | チャンネル一覧を出力する。オプションで各種フィルターやソートが使える |
| get:members | Slack に参加しているメンバー一覧を出力する。チャンネルを指定するとそのチャンネルに参加しているメンバーのみを出力する |
| get:usergroups | ユーザーグループ一覧を表示する |
| get:usergroups:members | 指定された Usergroup に属するメンバー一覧を出力する |
| listup:reactions | 指定された投稿に付いているリアクションを集計してスレッドに投稿する |
| summarize:channel | 指定されたチャンネルの直近の投稿を GPT で要約する |
| summarize:member | 指定されたチャンネル x メンバーの直近の投稿を GPT で要約する |
| join:public-channels | BOT を全てのパブリックチャンネルに参加させる。ユーザートークンが必須 |
| --version, -v | バージョンを表示する |
| --help, -h | ヘルプを表示する |
slack-cli aggregate:reactions --help
# => aggregate:reactions コマンドのヘルプを表示
slack-cli aggregate:reactions --start-date '2022-12-01T00:00:00' --end-date '2023-01-01T00:00:00' --reactions 'stamp-name,ok,+1' --channel-name 'hogehoge'
# => 指定期間内の投稿に対して :stamp-name:, :ok:, :+1: が押された投稿を行ったユーザー毎に集計してトップ5を #hogehoge チャンネルへと投稿する
slack-cli aggregate:members-reacted --help
# => aggregate:members-reacted コマンドのヘルプを表示
slack-cli aggregate:members-reacted --start-date 2023-03-28 --reactions "www,+1" --channel-name general
# => 2023年3月28日以降の投稿に :www:, :+1: を行ったユーザーを集計してトップ5を #general チャンネルへと投稿する。
slack-cli archive:channel -h
# => archive:channel コマンドのヘルプを表示
slack-cli archive:channel --channel-id Cxxxxx
# => 指定した channel-id Cxxxxx のパブリックチャンネルをアーカイブする
slack-cli archive:inactive-channels -h
# => slack-cli archive:inactive-channels コマンドのヘルプを表示
slack-cli archive:inactive-channels --days 100
# => 100日間投稿のないパブリックチャンネルをまとめてアーカイブする
slack-cli delete:message --help
# => delete:message コマンドのヘルプを表示
slack-cli delete:message --url https://slack.com/archive/xxxxx
# => --url で指定された BOT の投稿 URL を削除する
slack-cli get:channels --help
# => get:channels コマンドのヘルプを表示
slack-cli get:channels --filter-prefix hoge --excludes "dev,test"
# => チャンネル名の先頭に hoge が付いて、dev と test という文字列を含まないチャンネル一覧を表示する
slack-cli get:members --help
# => get:members コマンドのヘルプを表示
slack-cli get:members --channel-name slack-test
# => #slack-test チャンネルに参加しているメンバーの一覧を表示する
slack-cli get:usergroups --help
# => get:usergroups コマンドのヘルプを表示
slack-cli get:usergroups --includes club --sort-members --desc
# => ユーザーグループ名に club を含む一覧を人数の多い順に表示する
slack-cli get:usergroups:members --help
# => slack-cli get:usergroups:members コマンドのヘルプを表示
slack-cli get:usergroups:members --usergroup-id Sxxxxxx
# => 指定したユーザーグループのメンバー一覧を表示する
slack-cli listup:reactions --help
# => listup:reactions コマンドのヘルプを表示
slack-cli listup:reactions -u https://xxxx.slack.com/archives/XXXXX/p1672724638273089
# => url で指定された投稿に対してその投稿スレッドにリアクションの集計結果を投稿する
slack-cli summarize:channel --help
# => summarize:channel コマンドのヘルプを表示
slack-cli summarize:channel --channel-name slack-test --limit 200
# => #slack-test チャンネルの直近200件の投稿を取得して要約する
slack-cli summarize:member --help
# => summarize:member コマンドのヘルプを表示
slack-cli summarize:member --channel-name slack-test --member-id xxx --limit 200
# => #slack-test チャンネルの指定したメンバーの直近200件の投稿を取得して要約する
slack-cli join:public-channels --help
# => join:public-channels コマンドのヘルプを表示
slack-cli join:public-channels
# => BOT を全てのパブリックチャンネルに参加させる。Slack Web API の reactions を使用している aggregate 関連のコマンドを使用するために必要。