What it does
Asterisk calls for agents over MCP. Set up a profile with the pbx CLI first.
- Connects パソコンで動く
- Account or key No key needed
- Category 開発者ツール
一緒に使える
この種の作業を AI に教える Skill。これと一緒に使えます
andrej-karpathy-skills
A single CLAUDE.md file to improve Claude Code behavior, derived from Andrej Karpathy's observations on LLM coding pitfalls.
graphify
Turn any codebase, with its docs, SQL schemas, configs, and PDFs, into a queryable knowledge graph. A /graphify skill for Claude Code, Cursor, Codex, and Gemini CLI: local deterministic AST parsing, every edge explained, no vector store.
この順位の理由
一覧は利用スコア(100 点満点)で並びます。内訳は次のとおり
| 人気 | 4/80 | GitHub スターか週間ダウンロード数。大きい方を 60、小さい方を 20 で数えます |
|---|---|---|
| 新しさ | 12/12 | 30 日以内のリリースかコード更新で満点 |
| 応答中 | 0/8 | 前回の確認でクラウドのエンドポイントが応答 |
| 利用スコア | 16/100 |
品質: 基本チェック 3/3 項目に合格(表示のみ、並び順には不使用) · 勢い: データなし (「急上昇」タブでのみ使用)
インストール
使っているAIアプリを選んで、設定をコピーしてください。
ひとことで AI にインストールしてもらう
WireCat pbx をインストールして。https://mcp.popnx.com/i/wirecat-asterisk-cli.md に従い、コマンドを見せて、私が OK するまで実行しないで。パソコンで作業できる AI(Claude Code や Cursor など)に貼り付けます。手順を読み、コマンドを見せて、あなたの OK を待ちます。キー不要・登録不要。 · AI が読む全文を見る
チェック 3/3 合格 · あなたのパソコンで動きます · ✓ コマンド確認済み 2026年11月18日
まず:どの AI を使っていますか?
使っているアプリを選ぶと、下に手順が表示されます。
Claude につなげますが、先に準備が必要です
先にパソコンへ Node.js を入れてください(1 回だけ) · パソコン版 Claude アプリ(Windows または Mac)のみ。Web やスマホでは使えません
AI にインストールしてもらう
このメッセージを Claude のチャットに貼り付けます。AI がパソコンを確認し、変更するファイルを伝え、毎回あなたの了承を待ちます。
このパソコンの Claude に MCP server WireCat pbx を入れてください。順番に:1) node -v で Node.js があるか確認。なければ https://nodejs.org/en/download から入れるよう私に伝え、自分では入れない。2) この設定だけを使う(PopNx MCP の確認済み):{ "mcpServers": { "asterisk-cli": { "command": "npx", "args": [ "-y", "@wirecat/asterisk-cli", "mcp", "serve", "--profiles", "all" ] } } } 3) 変更するファイルのフルパスか実行するコマンドを伝えて、私の了承を待つ。4) キーは不要。5) 了承した内容を実行し、WireCat pbx のツールが本当に表示されるか確認する。このメッセージにあなたのキーは含まれません。キーが必要な場合は、AI がファイルやアプリの入力欄にご自身で貼るよう案内します。
Node.js を入れる(まだなければ)
もう入っていますか?先に確認 · ターミナルを開き、このコマンドを入力して Enter
node -v- バージョン番号(例 v26.13.1)が出る = 入っています。この手順は飛ばせます
- "command not found"(Windows では "is not recognized")が出る = まだ入っていないか、入れた直後でターミナルを開き直す必要があります
ターミナルの開き方
Mac:⌘ + Space を押し、Terminal と入力して Enter
Windows:スタートメニューを開き、Windows PowerShell と入力して「開く」
まだ入っていない場合: 公式ダウンロードページで LTS 版と、クリックで進むインストーラーを選びます:Mac は .pkg、Windows は .msi。ダブルクリックして最後まで進めるだけで、curl コマンドは不要です
入れ終わったらターミナルを閉じて開き直し、同じコマンドをもう一度実行します。バージョン番号が出れば完了です:
node -v一度入れれば、Node.js を使うすべてのツールで使えます
パソコン版 Claude アプリの設定ファイルを開く
SettingsDeveloperEdit Config
この設定を貼り付けて保存
{ "mcpServers": { "asterisk-cli": { "command": "npx", "args": [ "-y", "@wirecat/asterisk-cli", "mcp", "serve", "--profiles", "all" ] } } }Claude を終了してもう一度開く
試してみる
WireCat pbx を使って、私に何ができるか教えて、1 つやってみせて✓ Claude が WireCat pbx を使っていると言うか、回答に WireCat pbx のツール名が出れば接続成功です
メニュー名は 2026年11月11日 に Anthropic のヘルプページで確認 · アプリのバージョンにより画面が少し違うことがあります
ChatGPT はまだ WireCat pbx につなげません
WireCat pbx はパソコンに入れて使うものですが、ChatGPT は Web 上で動くサーバーにしかつなげません
代わりにできること
A · WireCat pbx につなげるアプリを使う
- 先にパソコンへ Node.js を入れてください(1 回だけ) · パソコン版 Claude アプリ(Windows または Mac)のみ。Web やスマホでは使えません
- 先にパソコンへ Node.js を入れてください(1 回だけ)
- 先にパソコンへ Node.js を入れてください(1 回だけ)
- 先にパソコンへ Node.js を入れてください(1 回だけ)
B · 開発者ツール の中で ChatGPT につなげる別のサーバー
同じカテゴリでよく使われているものから、キーなしでアドレスだけでつなげるものを選びました
- Sentry✓ ChatGPT
- Compiler Explorer✓ ChatGPT
- GitDiagram✓ ChatGPT
Claude Code につなげますが、先に準備が必要です
先にパソコンへ Node.js を入れてください(1 回だけ)
AI にインストールしてもらう
このメッセージを Claude Code のチャットに貼り付けます。AI がパソコンを確認し、変更するファイルを伝え、毎回あなたの了承を待ちます。
このパソコンの Claude Code に MCP server WireCat pbx を入れてください。順番に:1) node -v で Node.js があるか確認。なければ https://nodejs.org/en/download から入れるよう私に伝え、自分では入れない。2) この設定だけを使う(PopNx MCP の確認済み):claude mcp add --scope user asterisk-cli -- npx -y @wirecat/asterisk-cli mcp serve --profiles all 3) 変更するファイルのフルパスか実行するコマンドを伝えて、私の了承を待つ。4) キーは不要。5) 了承した内容を実行し、WireCat pbx のツールが本当に表示されるか確認する。このメッセージにあなたのキーは含まれません。キーが必要な場合は、AI がファイルやアプリの入力欄にご自身で貼るよう案内します。
Node.js を入れる(まだなければ)
もう入っていますか?先に確認 · ターミナルを開き、このコマンドを入力して Enter
node -v- バージョン番号(例 v26.13.1)が出る = 入っています。この手順は飛ばせます
- "command not found"(Windows では "is not recognized")が出る = まだ入っていないか、入れた直後でターミナルを開き直す必要があります
ターミナルの開き方
Mac:⌘ + Space を押し、Terminal と入力して Enter
Windows:スタートメニューを開き、Windows PowerShell と入力して「開く」
まだ入っていない場合: 公式ダウンロードページで LTS 版と、クリックで進むインストーラーを選びます:Mac は .pkg、Windows は .msi。ダブルクリックして最後まで進めるだけで、curl コマンドは不要です
入れ終わったらターミナルを閉じて開き直し、同じコマンドをもう一度実行します。バージョン番号が出れば完了です:
node -v一度入れれば、Node.js を使うすべてのツールで使えます
ターミナルを開く
Mac:Command+スペースで Terminal と入力 · Windows:PowerShell を開く
このコマンドを貼り付けて Enter
claude mcp add --scope user asterisk-cli -- npx -y @wirecat/asterisk-cli mcp serve --profiles allClaude Code で /mcp と入力
WireCat pbx が一覧にあり、接続済みと表示されれば OK です
試してみる
WireCat pbx を使って、私に何ができるか教えて、1 つやってみせて✓ Claude Code が WireCat pbx を使っていると言うか、回答に WireCat pbx のツール名が出れば接続成功です
メニュー名は 2026年11月11日 に Anthropic のヘルプページで確認 · アプリのバージョンにより画面が少し違うことがあります
Cursor につなげますが、先に準備が必要です
先にパソコンへ Node.js を入れてください(1 回だけ)
AI にインストールしてもらう
このメッセージを Cursor のチャットに貼り付けます。AI がパソコンを確認し、変更するファイルを伝え、毎回あなたの了承を待ちます。
このパソコンの Cursor に MCP server WireCat pbx を入れてください。順番に:1) node -v で Node.js があるか確認。なければ https://nodejs.org/en/download から入れるよう私に伝え、自分では入れない。2) この設定だけを使う(PopNx MCP の確認済み):{ "mcpServers": { "asterisk-cli": { "command": "npx", "args": [ "-y", "@wirecat/asterisk-cli", "mcp", "serve", "--profiles", "all" ] } } } 3) 変更するファイルのフルパスか実行するコマンドを伝えて、私の了承を待つ。4) キーは不要。5) 了承した内容を実行し、WireCat pbx のツールが本当に表示されるか確認する。このメッセージにあなたのキーは含まれません。キーが必要な場合は、AI がファイルやアプリの入力欄にご自身で貼るよう案内します。
Node.js を入れる(まだなければ)
もう入っていますか?先に確認 · ターミナルを開き、このコマンドを入力して Enter
node -v- バージョン番号(例 v26.13.1)が出る = 入っています。この手順は飛ばせます
- "command not found"(Windows では "is not recognized")が出る = まだ入っていないか、入れた直後でターミナルを開き直す必要があります
ターミナルの開き方
Mac:⌘ + Space を押し、Terminal と入力して Enter
Windows:スタートメニューを開き、Windows PowerShell と入力して「開く」
まだ入っていない場合: 公式ダウンロードページで LTS 版と、クリックで進むインストーラーを選びます:Mac は .pkg、Windows は .msi。ダブルクリックして最後まで進めるだけで、curl コマンドは不要です
入れ終わったらターミナルを閉じて開き直し、同じコマンドをもう一度実行します。バージョン番号が出れば完了です:
node -v一度入れれば、Node.js を使うすべてのツールで使えます
Cursor の AI チャットを Agent モードで開く
試してみる
WireCat pbx を使って、私に何ができるか教えて、1 つやってみせて✓ Cursor が WireCat pbx を使っていると言うか、回答に WireCat pbx のツール名が出れば接続成功です
メニュー名は 2026年11月11日 に Cursor のヘルプページで確認 · アプリのバージョンにより画面が少し違うことがあります
VS Code につなげますが、先に準備が必要です
先にパソコンへ Node.js を入れてください(1 回だけ)
AI にインストールしてもらう
このメッセージを VS Code のチャットに貼り付けます。AI がパソコンを確認し、変更するファイルを伝え、毎回あなたの了承を待ちます。
このパソコンの VS Code に MCP server WireCat pbx を入れてください。順番に:1) node -v で Node.js があるか確認。なければ https://nodejs.org/en/download から入れるよう私に伝え、自分では入れない。2) この設定だけを使う(PopNx MCP の確認済み):{ "servers": { "asterisk-cli": { "type": "stdio", "command": "npx", "args": [ "-y", "@wirecat/asterisk-cli", "mcp", "serve", "--profiles", "all" ] } } } 3) 変更するファイルのフルパスか実行するコマンドを伝えて、私の了承を待つ。4) キーは不要。5) 了承した内容を実行し、WireCat pbx のツールが本当に表示されるか確認する。このメッセージにあなたのキーは含まれません。キーが必要な場合は、AI がファイルやアプリの入力欄にご自身で貼るよう案内します。
Node.js を入れる(まだなければ)
もう入っていますか?先に確認 · ターミナルを開き、このコマンドを入力して Enter
node -v- バージョン番号(例 v26.13.1)が出る = 入っています。この手順は飛ばせます
- "command not found"(Windows では "is not recognized")が出る = まだ入っていないか、入れた直後でターミナルを開き直す必要があります
ターミナルの開き方
Mac:⌘ + Space を押し、Terminal と入力して Enter
Windows:スタートメニューを開き、Windows PowerShell と入力して「開く」
まだ入っていない場合: 公式ダウンロードページで LTS 版と、クリックで進むインストーラーを選びます:Mac は .pkg、Windows は .msi。ダブルクリックして最後まで進めるだけで、curl コマンドは不要です
入れ終わったらターミナルを閉じて開き直し、同じコマンドをもう一度実行します。バージョン番号が出れば完了です:
node -v一度入れれば、Node.js を使うすべてのツールで使えます
VS Code の AI チャットを Agent モードで開く
試してみる
WireCat pbx を使って、私に何ができるか教えて、1 つやってみせて✓ VS Code が WireCat pbx を使っていると言うか、回答に WireCat pbx のツール名が出れば接続成功です
メニュー名は 2026年11月11日 に VS Code のヘルプページで確認 · アプリのバージョンにより画面が少し違うことがあります
Windsurf、Zed、Gemini CLI など MCP を使える他のアプリは追加方法がそれぞれ違います。アプリ一覧で確認してください
JSON 設定は下の「開発者向け」にあります
開発者向け:ターミナルのコマンドと JSON 設定
パソコンにインストール
Claude Code
claude mcp add --scope user asterisk-cli -- npx -y @wirecat/asterisk-cli mcp serve --profiles allClaude Desktop (claude_desktop_config.json)
{
"mcpServers": {
"asterisk-cli": {
"command": "npx",
"args": [
"-y",
"@wirecat/asterisk-cli",
"mcp",
"serve",
"--profiles",
"all"
]
}
}
}Cursor (~/.cursor/mcp.json)
{
"mcpServers": {
"asterisk-cli": {
"command": "npx",
"args": [
"-y",
"@wirecat/asterisk-cli",
"mcp",
"serve",
"--profiles",
"all"
]
}
}
}VS Code (mcp.json)
{
"servers": {
"asterisk-cli": {
"type": "stdio",
"command": "npx",
"args": [
"-y",
"@wirecat/asterisk-cli",
"mcp",
"serve",
"--profiles",
"all"
]
}
}
}この設定は、作者のレジストリ登録情報から作成しています。READMEと違う場合は、READMEに従ってください。
ひと目でわかる
- 週あたりのダウンロードi
- npm/PyPIにない
- 確認済みドメイン
- ✓ wirecat.dev
- 接続方法
- パソコンで動く
- 最新バージョンi
- 0.8.0
- レジストリ公開日i
- 2026年11月18日
- コードの最終更新i
- 2026年11月18日
- 作者
- WireCatLabs
- パッケージ
npm: @wirecat/asterisk-cli- ウェブサイト
- wirecat.dev
- レジストリでの状態
- 有効
使えるアプリ
このサーバーのつなぎ方と、各アプリの公式ドキュメントに基づきます。2026年11月10日に確認。
パソコン上で動かせるアプリ
ClaudeGooseLM StudioMsty StudioCherry StudioCursorVS Code + GitHub CopilotVisual StudioWindsurf (Devin Desktop)ZedKiroClineContinueJetBrains AI AssistantClaude CodeCodex CLIGemini CLIOpenCodenodecodeWarpLibreChatRaycast
できること
パソコンで動くサーバーです。インストールすると、ツール一覧がAIアプリに表示されます。
基本チェックi
誰でも見られる情報をチェックしており、コードは読んでいません。当てはまらない項目は数に入れていません。 · 2026年11月19日にチェック
- ✓ 合格
作者とリポジトリが一致
レジストリ名はドメイン wirecat.dev で確認済みです(レジストリがドメインの所有を確認しています)
- ✓ 合格
今もメンテナンスされている
コードの最終更新:昨日
- ✓ 合格
ライセンスがある
Apache-2.0を使用
- – 対象外
エンドポイントが応答する
これはパソコンで動くため、インターネット上のエンドポイントはありません
- – 対象外
OAuthでサインイン
パソコンで動き、代わりにローカルの設定を使います
- … 未チェック
ツールの説明に隠れた指示がない
パソコンで動くサーバーです。ツール一覧を読み取れるのは、インターネット上のエンドポイントがある場合だけです
公開済みの脆弱性(OSV.dev)
まだ確認していません
作者の方へ:再確認の依頼・情報の誤りの報告
作者向け:README にバッジを付ける
作者の方は、このコードを README に貼れます。バッジはこのページにリンクします。
[](https://mcp.popnx.com/en/servers/wirecat-asterisk-cli)話し合い
質問、コツの共有、使えないことの報告ができます。「役に立った」の多い順です。
ユーザーレビュー
まだレビューはありません
開発者ツールのほかのサーバーとの比較i
- このカテゴリのほかの6116件のうち69%よりスターが多い
- このカテゴリのほかの6116件のうち96%より最近レジストリに公開
- 基本チェックの結果が、このカテゴリのほかの6116件のうち99%と同じかそれ以上
レジストリでこのカテゴリにある有効なすべてのサーバーと比較しています。スターは、公開者がリポジトリの所有者である場合だけ数えます。
よくある質問
WireCat pbxは安全ですか?
当てはまる基本チェック3項目のうち3項目に合格しました。コードは読んでいません。キーやトークンを追加する前に、サーバーがどんなアクセスを求めているかを確認し、必要な権限だけを持つキーを使ってください。
どんなキーやコードが必要ですか?
レジストリには必須のキーは載っていません。ただし、最初に使うときにサインインを求めるサーバーもあります。
パソコンで動きますか、それともクラウドですか?
あなたのパソコンで動きます。必要なときにAIアプリが起動し、データは作者のサーバーを通りません(サーバー自体がオンラインサービスを呼び出す場合を除きます)。
今もメンテナンスされていますか?
GitHubリポジトリの最終更新は昨日、最新バージョン(0.8.0)がレジストリに届いたのは昨日です。
どのアプリで使えますか?
Claude Desktop、Claude Code、Cursor、VS CodeなどのMCP対応アプリで使えます。パソコンにNode.jsも必要です。
代わりに使えるものは?
同じカテゴリには:GitDiagram, Appllama, Cloudflare MCP, Omnara, Repowise
似た働きのほかの候補
同じカテゴリでほかの作者のもの。コマンドは確認済み。公式を先に、次にスター順。
カードの見方:↓ 週あたりのダウンロードi★ GitHubスターi3つの柱:レビュー · チェック · 利用状況i更新=最新バージョンをレジストリに公開した日i
GitDiagram
Architecture diagrams, explanations and Mermaid source for public GitHub repositories.
Appllama
Study screens, flows and paywalls from top-earning iOS apps, then build from what wins.
Omnara
Deploy durable AI agents with Omnara, an open-source managed-agent platform.
Repowise
Codebase intelligence for AI coding agents: graph, git history, docs, decisions, code health.
| これ WireCat pbx | GitDiagram | Appllama | Cloudflare MCP | Omnara | Repowise | |
|---|---|---|---|---|---|---|
| 動く場所 | パソコンにインストールが必要 | クラウドで動き、インストール不要 | クラウドで動き、インストール不要 | クラウドで動き、インストール不要 | クラウドで動き、インストール不要 | クラウドでもパソコンにインストールでも使える |
| キーが必要 | いいえ | いいえ | いいえ | いいえ | いいえ | いいえ |
| Claude で + から追加 | いいえ | いいえ | いいえ | はい | いいえ | いいえ |
| 基本チェック | 3/3 | 4/4 | 4/4 | 4/4 | 4/4 | 5/5 |
| ライセンス | Apache-2.0 | MIT | MIT | Apache-2.0 | Apache-2.0 | AGPL-3.0 |
| 料金 | 登録情報に費用の記載なし | 登録情報に費用の記載なし | 登録情報に費用の記載なし | 登録情報に費用の記載なし | 登録情報に費用の記載なし | 登録情報に費用の記載なし |
作者のREADME
READMEを開く
作者のリポジトリから書かれたとおりにコピーしたものです。PopNx MCPは内容を確認・推奨していません。HTML、画像、スクリプトは取り除いています。リンクはこのサイトの外へ移動します。
pbx — Asterisk PBX calls for AI agents
Asterisk PBX calls and recordings for your AI agent. Ask who called about the invoice, what the client was promised, and which calls nobody answered, from Claude Code, Codex or any MCP client.
Your company's phone calls from an Asterisk PBX (FreePBX, Issabel, VitalPBX or plain Asterisk), with their recordings transcribed on your computer, counted, searchable by words and by meaning, and ready for any agent, within limits you set.
Documentation · Install and connect · Commands · WireCat
pbx reads the PBX's call records (CDR, the call detail records) from Master.csv or from the CDR database, and copies them into the local WireCat store: one meeting per call, with the extension and the outside caller as its people. It links each call to its recording file. meetings transcribe turns the recordings into text with a speech model that runs on this computer. Then you and your agent count, read, search and mark the calls with no network, next to the chats, mail and meetings of the other WireCat tools. pbx only reads: it never changes the PBX, its settings or a recording.
An example conversation (invented calls, illustrative output):
You: Use pbx. What did +7 900 000-00-01 say about the payment on the last call?
Agent: (runs pbx office meetings list "title:*79000000001*" --json, then pbx office meetings transcript 1 --json) On 31 October the client said the invoice will be paid on Friday, after their director signs it.
Quick start
npm install -g @wirecat/asterisk-cli
pbx office config set cdr_csv_path /var/log/asterisk/cdr-csv/Master.csv pbx office config set recordings_path /var/spool/asterisk/monitor pbx office config set cdr_timezone Europe/Moscow pbx office config set phone_region ru pbx office session start # checks the source; asks a password only where one is needed pbx office meetings sync # import the call records and link their recordings pbx models download gigaam-v3 # the local speech model, once pbx office meetings transcribe # transcribe up to 20 recorded calls
office is a profile: a name you choose for one PBX. It is the first word of every command that uses an account. The first sync reads 30 days back; --since-time 2025-01-01T00:00:00Z reads further. Each later sync reads what is new, and a repeated sync never makes a call twice.
You need Node.js 22.16 or a later 22.x, or Node.js 24 or later, and ffmpeg to transcribe WAV and GSM recordings. The command is pbx, also installed as wcat-pbx. It is not asterisk, so it never hides the PBX's own program.
More: install and connect · use it.
What you can do
List the calls. Filter by time, duration or the number in the title.
pbx office meetings list "started_at>=2026-11-01 duration_ms>=60000"
Read a call. Who called whom, when, how long, and its recording.
pbx office meetings show 42
pbx office meetings transcript 42
Transcribe what is new. Without a query, every call of five seconds or more that has a recording and no transcript yet, newest first. A recording already transcribed is not read again. A call that fails is listed and the rest go on.
pbx office meetings transcribe --max-meetings 50
Count the calls. Calls by direction and outcome, per employee, by hour and by day, and the missed calls with whether the client was called back.
pbx office stats calls show --since-time 7d
Search what was said. By words, or by meaning with a local text model.
pbx office search meetings "refund"
pbx office search meetings "a client unhappy with the delivery" --model embeddinggemma
Mark calls. Mark every call the search finds. A second run marks only the new calls.
pbx office tags add complaint --matching "refund OR complaint"
pbx office tags list tag:complaint
More:
- Find an operator across the calls:
pbx office meetings people "Anna". - Export a call as Markdown or WebVTT:
pbx office meetings export 42 --format vtt --output call.vtt. - Ask about one person across calls, chats and mail:
memo context "Ivan Testov".
More: use it.
For AI agents
- An agent with a terminal — Claude Code, Codex, Gemini CLI, OpenClaw or Hermes Agent. It runs
pbxitself.pbx skill installwrites the skill, the agent's instruction sheet. - An app with no terminal — Claude Desktop, Cursor and other MCP clients. Connect the profile's MCP server,
pbx office mcp serve;pbx office mcp configprints the entry to paste.
pbx skill install
pbx office mcp add claude-code --allow-writes # or: codex
meetings sync, meetings transcribe, meetings embed and tags add change the local store, so mcp add stops until you pass --allow-writes. The profile's permissions decide what an agent may run. Text from a call — a transcript, a caller name, a phone number — is marked untrusted: it is data for the agent, never instructions. session start and session end are never offered to an agent.
Why this tool
- Read-only against the PBX. It opens Master.csv or a read-only database session and reads the recordings. It never writes, moves or deletes a file there, and needs no change to the dialplan.
- The recordings stay with you. Speech is recognized on this computer. No recording or transcript goes to a speech service, unless you turn on cloud transcription for one profile.
- A call is one call. The rows a ring group, a queue or a transfer writes are joined by their
linkedid, and the call says what became of it: who answered after how long, who rang without answering, voicemail, busy or missed. - One store with the other WireCat tools. A caller's number is kept in the international form, as WhatsApp, MAX and the CRMs keep it, and a caller on a mobile number joins the CRM contact or chat person with that number.
Sign-in and profiles
Each profile is one PBX. No command ever picks a profile for you; pbx session list lists them.
pbx office session start # checks the source, asks each password it needs
pbx office session status --check # read the newest call records again pbx office session end # forget the passwords; the imported calls stay
A profile on a local or mounted Master.csv needs no password. A database profile asks for the password of a read-only user once, checks it, and keeps it in the system keyring. A profile that also signs in to SSH or SFTP with a password asks for that one too, and keeps both in the same keyring entry. Where the keyring fails, it uses a private file and says so once. PBX_TOKEN in the environment is read first.
Settings and permissions
The settings of each source are in install and connect; pbx office config show lists them. Each command has a permission key, its path: meetings.sync, meetings.transcribe. Each is allow, ask, readonly or deny. PBX_READ_ONLY=1 refuses every command that changes your sign-in or settings.
More: settings.
Limits
- Call records.
pbxreads the call records (CDR) from Master.csv, from MySQL or MariaDB, and from PostgreSQL. These are the three places where Asterisk most often keeps its call history.pbxdoes not use CEL, AMI or ARI: CEL (channel event logging) is a log of each step inside a call, and AMI and ARI are interfaces that control calls while they happen. Call history does not need them. - Playing a recording. A call links its recording by the file's path, and you open the file in a player. No link plays it in a browser.
meetings showprints a link for WireCat Desktop (wirecat://…). It opens the call once Desktop supports links to calls. - Summaries.
pbxwrites no summary of a call. Your agent reads the transcript and writes the summary. - Who said what. A stereo recording keeps its two channels apart: set
recordings_channels, and each line names the caller or the employee. A mono recording, one mixed track, gives the text without names. - Length and size. A recording longer than one hour is not transcribed. An MP3, Ogg or FLAC file can be up to 64 MB, which is more than an hour at usual phone quality. WAV, GSM and M4A files and Master.csv can be of any size. A call that is not transcribed is listed, and the rest go on.
More: what is planned · compared with other tools · on wirecat.dev
Security
- The store keeps callers' numbers and names, the extensions, and what was said. Treat it like the calls themselves.
- Recording a call and processing it may need the consent of the people on it. That is the PBX owner's duty; see security.
More: security. Report a vulnerability as SECURITY.md says.
When it does not work
pbx doctor # what is set up; no network, no keyring
pbx office session status --check # does the source still answer pbx office meetings sync --trace # the connection log, never content pbx office runs list # failed runs are kept
More: when something goes wrong.
Documentation
| Section | Pages |
|---|---|
| Start | overview · install and connect · use it |
| Reference | all commands · settings and permissions |
| If something is wrong | when something goes wrong · security |
| Project | compared with other tools · roadmap · CHANGELOG.md |
For developers: design, tests and the rules for agents in AGENTS.md.
Development
pnpm install
pnpm lint && pnpm typecheck && pnpm test pnpm build && pnpm smoke:node # the built command: the bundle users install pnpm generate # rewrite the generated files pnpm release:check # every check CI runs
examples/ holds a made-up Master.csv and two short recordings, for trying the tool without a PBX.
Part of WireCat
pbx is one of the WireCat tools. They share one local store, so a caller found in pbx is the same person in Telegram, MAX, WhatsApp, mail and the CRM, and memo answers about them across all of it. The PBX sibling is beeline-cli, for Beeline's cloud PBX.
Contributing and license
Pull requests, bug reports and ideas go to issues.
Apache License 2.0 — LICENSE.