https://github.com/mktoho12/slack-channel-list
Slack ワークスペース内のチャンネル一覧を取得するためのツールです
https://github.com/mktoho12/slack-channel-list
npm slack
Last synced: about 1 year ago
JSON representation
Slack ワークスペース内のチャンネル一覧を取得するためのツールです
- Host: GitHub
- URL: https://github.com/mktoho12/slack-channel-list
- Owner: mktoho12
- Created: 2025-03-31T16:19:18.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-05T21:17:27.000Z (about 1 year ago)
- Last Synced: 2025-04-10T12:15:38.477Z (about 1 year ago)
- Topics: npm, slack
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/slack-channel-list
- Size: 28.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Slack Channel List
このプロジェクトは、Slack ワークスペース内のチャンネル一覧を取得するためのツールです。Playwright を使用してブラウザ操作を自動化し、チャンネル情報を収集します。
## 必要要件
- Node.js がインストールされていること
- npm または pnpm がインストールされていること
- Slack ワークスペースへのアクセス権
## インストール
1. npm または pnpm を使用してツールをインストールします。
```bash
npm install -g slack-channel-list
```
または
```bash
pnpm add -g slack-channel-list
```
2. インストール後、`slack-channel-list` コマンドが使用可能になります。
## 使用方法
### 認証を実行する
Slack にログインし、セッション情報を保存します。
```bash
slack-channel-list --auth
```
セッション情報の保存先を指定する場合:
```bash
slack-channel-list --auth --storageState custom/path/to/storageState.json
```
### チャンネルリストを取得する
ワークスペースの URL を指定してチャンネルリストを取得します。
```bash
slack-channel-list https://your-workspace.slack.com
```
セッション情報の保存先を指定する場合:
```bash
slack-channel-list https://your-workspace.slack.com --storageState custom/path/to/storageState.json
```
## 注意事項
- セッション情報には認証情報が含まれているため、慎重に取り扱ってください。
---
## コントリビューター向け
### 必要要件
- Node.js (22.x 以上)
- pnpm
- Git
### 開発環境のセットアップ
1. リポジトリをクローンします。
```bash
git clone https://github.com/mktoho12/slack-channel-list.git
cd slack-channel-list
```
2. 必要な依存関係をインストールします。
```bash
pnpm install
```
3. 開発モードでスクリプトを実行します。
```bash
pnpm dev https://your-workspace.slack.com
```
### スクリプト
- `pnpm dev`: 開発モードでスクリプトを実行します。
- `pnpm build`: TypeScript をコンパイルします。
- `pnpm lint`: ESLint を使用してコードを検証します。
- `pnpm lint:fix`: ESLint の問題を自動修正します。
- `pnpm prettier`: Prettier を使用してコードを整形します。
### コントリビューションの方法
1. 新しいブランチを作成します。
```bash
git checkout -b feature/your-feature-name
```
2. 変更を加え、コミットします。
```bash
git add .
git commit -m "Add your feature description"
```
3. リモートリポジトリにプッシュします。
```bash
git push origin feature/your-feature-name
```
4. プルリクエストを作成します。
### 注意事項
- コードスタイルを守るために、`pnpm lint` と `pnpm prettier` を実行してください。
- セッション情報や認証情報を含むファイルをコミットしないでください。
## ライセンス
このプロジェクトは [ISC ライセンス](LICENSE) の下でライセンスされています。