@meetstream/cli 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +127 -19
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -10,6 +10,27 @@ meetstream bot create "https://meet.google.com/abc-defg-hij" -t deepgram
10
10
 
11
11
  ---
12
12
 
13
+ ## Authentication
14
+
15
+ Every command authenticates to `https://api.meetstream.ai/api/v1` with `Authorization: Token <your-key>`. There's no OAuth flow or separate CLI login — the API key **is** the credential.
16
+
17
+ | Source | Precedence | Set with |
18
+ |--------|------------|----------|
19
+ | `MEETSTREAM_API_KEY` env var | wins if set | `export MEETSTREAM_API_KEY=ms_XXXX` |
20
+ | `~/.meetstream/config.json` | fallback | `meetstream auth set-key <key>` (written with `0600` permissions) |
21
+
22
+ Verify it's working:
23
+ ```bash
24
+ meetstream auth status
25
+ # ✓ API key is valid
26
+ # key ms_if0…tH0L
27
+ # base_url https://api.meetstream.ai/api/v1
28
+ # bots_on_account 12
29
+ ```
30
+ Get a key at [app.meetstream.ai/api-keys](https://app.meetstream.ai/api-keys).
31
+
32
+ ---
33
+
13
34
  ## 60-second tour
14
35
 
15
36
  ```bash
@@ -27,45 +48,132 @@ meetstream bot status <bot_id> --watch
27
48
  meetstream transcript <bot_id> --wait
28
49
  ```
29
50
 
30
- ## Commands
51
+ ---
52
+
53
+ ## Full capability list
31
54
 
55
+ ### `auth` — credentials
32
56
  | Command | What it does |
33
- |---------|--------------|
34
- | `auth set-key <key>` / `auth status` | Store + validate your API key (`MEETSTREAM_API_KEY` env wins) |
35
- | `bot create <link>` | Send/schedule a bot — transcription provider, callbacks, live streams, MIA agent, per-participant streams, idempotency |
36
- | `bot list` / `status --watch` / `detail` | Inspect bots |
57
+ |---------|---------------|
58
+ | `auth set-key <key>` | Stores the key in `~/.meetstream/config.json` |
59
+ | `auth status` | Validates the configured key against the live API and shows account info |
60
+
61
+ ### `bot` — lifecycle, media, interaction
62
+ | Command | What it does |
63
+ |---------|---------------|
64
+ | `bot create <meeting-link>` | Sends (or schedules with `--join-at`) a bot to the meeting. See [`bot create` options](#bot-create-options) below — transcription provider, callbacks, per-participant streams, MIA agent, live streaming, idempotency, and safe leave-timeout defaults. |
65
+ | `bot list` | Lists every bot on the account with id, status, and platform |
66
+ | `bot status <id> [--watch]` | Current status; `--watch` polls every 5s until a terminal state (`Stopped`/`Done`/`Error`/etc.) |
67
+ | `bot detail <id>` | Full session metadata — platform, timings, status timeline, `transcript_id`, `caption_file` |
37
68
  | `bot summary <id>` | MeetStream's built-in AI meeting summary |
38
- | `bot audio/video/streams/audio-streams <id>` | Presigned media URLs (incl. per-participant) |
39
- | `bot participants/chats/screenshots/timeline <id>` | Meeting data |
40
- | `bot send-message <id> <msg>` / `send-image <id> <url>` | Interact with a live meeting |
41
- | `bot remove <id>` / `bot delete <id> --yes` | Leave meeting / permanently delete data |
42
- | `transcript <bot_id> [--wait] [--json] [--raw]` | Fetch transcript — resolves `transcript_id` for you |
43
- | `transcriptions <bot_id>` / `transcribe <bot_id> -p assemblyai` | List runs / re-transcribe with another provider |
44
- | `calendar connect/events/schedule/auto-join on` | Google Calendar auto-join |
45
- | `mia list/create/delete` | Conversational AI agents (MIA) |
46
- | `listen [--forward url]` | Local webhook receiver with pretty, colorized lifecycle output |
69
+ | `bot audio <id>` / `bot video <id>` | Presigned recording URL (audio valid 1h, video valid 10min) |
70
+ | `bot streams <id>` / `bot audio-streams <id>` | Per-participant video/audio streams (needs `--separate-video`/`--separate-audio` at creation) |
71
+ | `bot participants <id>` | Everyone detected in the meeting |
72
+ | `bot chats <id>` | In-meeting chat messages |
73
+ | `bot screenshots <id>` | Screenshots captured during the meeting |
74
+ | `bot timeline <id>` | Speaker timeline — who spoke when |
75
+ | `bot send-message <id> <text...>` | Posts a chat message into the **live** meeting |
76
+ | `bot send-image <id> <img-url> [-d seconds]` | Shows an image/GIF as the bot's video frame (public URL required) |
77
+ | `bot remove <id>` | Makes the bot leave the meeting now (data is kept) |
78
+ | `bot delete <id> --yes` | **Permanently** deletes audio/video/transcripts — the `--yes` flag is mandatory, no accidental deletes |
79
+
80
+ <a name="bot-create-options"></a>
81
+ **`bot create` options:**
82
+ ```
83
+ -n, --name <name> bot display name (default "MeetStream Bot")
84
+ --video record video (default: audio only)
85
+ -t, --transcript <provider> deepgram | assemblyai | sarvam | meetstream |
86
+ jigsawstack | meeting_captions |
87
+ deepgram_streaming | assemblyai_streaming
88
+ -l, --language <lang> transcription language (provider-specific format)
89
+ -c, --callback <url> HTTPS webhook for lifecycle events
90
+ --join-at <iso8601> schedule a future join, e.g. 2026-07-02T15:00:00Z
91
+ --bot-message <msg> chat message posted when the bot joins
92
+ --image-url <url> PUBLIC image URL for the bot avatar
93
+ --retention-hours <n> data retention window (API default 24h)
94
+ --separate-audio capture per-participant audio streams
95
+ --separate-video capture per-participant video streams
96
+ --zoom-obf use Zoom On-Behalf-Of
97
+ --agent-config-id <id> attach a MIA conversational agent
98
+ --live-transcript-webhook <url> webhook URL for live transcript chunks
99
+ --live-audio-ws <wss> WebSocket URL for live audio out
100
+ --live-video-ws <wss> WebSocket URL for live video out
101
+ --socket-ws <wss> two-way bot-control WebSocket (socket_connection_url)
102
+ --attr <key=value...> custom_attributes entries (echoed back in webhooks)
103
+ --idempotency-key <uuid> safe-retry key — a retry returns the original
104
+ bot (HTTP 507), never a duplicate
105
+ --everyone-left-timeout <sec> leave after everyone else leaves (default 60)
106
+ --waiting-room-timeout <sec> max seconds in waiting room (default 300)
107
+ --max-recording-seconds <sec> max in-call recording seconds (default 14400)
108
+ ```
109
+
110
+ ### `transcript` / `transcriptions` / `transcribe` — transcription
111
+ | Command | What it does |
112
+ |---------|---------------|
113
+ | `transcript <bot-id> [--wait] [--raw] [--json]` | Fetches the transcript, resolving `transcript_id` automatically (it's never in webhooks). `--wait` polls until ready. Default output is readable `Speaker: text` lines. |
114
+ | `transcriptions <bot-id>` | Lists every transcription run for a bot — provider, status, presigned download URLs |
115
+ | `transcribe <bot-id> -p <provider>` | (Re-)transcribes a bot's recorded audio, optionally with a different provider or language |
116
+
117
+ ### `calendar` — Google Calendar auto-join
118
+ | Command | What it does |
119
+ |---------|---------------|
120
+ | `calendar connect --client-id --client-secret --refresh-token` | Connects a Google Calendar via OAuth refresh-token flow |
121
+ | `calendar list` | Connected calendars |
122
+ | `calendar events` | Fetch/sync upcoming events |
123
+ | `calendar schedule <event-id>` / `calendar unschedule <event-id>` | Send/remove a bot for one specific event |
124
+ | `calendar auto-join on\|off [-n name] [--video]` | Enable/disable auto-join for **every** meeting on the calendar |
125
+ | `calendar reschedule <bot-id> <iso8601>` | Change a scheduled bot's join time |
126
+ | `calendar cancel <bot-id>` | Delete a scheduled (not-yet-joined) bot |
127
+
128
+ ### `mia` — conversational AI agents
129
+ | Command | What it does |
130
+ |---------|---------------|
131
+ | `mia list` | Lists agent configs |
132
+ | `mia create -f <config.json>` | Creates an agent config (`agent_name`, `mode`, `model`, `voice`, `transcriber`, …) — attach it to a bot with `--agent-config-id` |
133
+ | `mia delete <agent-config-id>` | Deletes an agent config |
134
+
135
+ ### `listen` — local webhook receiver
136
+ | Command | What it does |
137
+ |---------|---------------|
138
+ | `listen [-p port] [--path path] [--forward url] [--json]` | Runs a local HTTP server that pretty-prints every MeetStream webhook event as it arrives, color-coded by outcome. Pair with `ngrok http <port>` to give `bot create --callback` a public URL during development. `--forward` also relays the raw payload to another URL. |
47
139
 
48
140
  Every command supports `--json` for scripting.
49
141
 
50
- ## The webhook model (what `listen` shows you)
142
+ ---
143
+
144
+ ## The webhook model — live-verified
51
145
 
52
- Events arrive under the **`event`** key with `bot_id`, `bot_status`, `message`, `status_code` (200/500), `custom_attributes`:
146
+ Events arrive under the **`event`** key with `bot_id`, `bot_status`, `message`, `status_code` (200/500), `custom_attributes` — this is exactly what `meetstream listen` decodes and pretty-prints for you:
53
147
 
54
148
  ```
55
149
  bot.joining → bot.in_waiting_room → bot.inmeeting → bot.recording → bot.leaving → bot.stopped
56
150
  → manifest.completed → audio.processed → transcription.processed → video.processed → bot.done
57
151
  ```
58
152
 
59
- `bot.stopped` fires **once** — `bot_status` says why (`Stopped` · `NotAllowed` lobby-timeout · `Denied` host-denied · `Error`). Streaming-only transcription providers end at `audio.processed` (no `bot.done`). `transcript_id` is **not** in webhooks — `meetstream transcript <bot_id>` resolves it via `/detail`.
153
+ - **`bot.stopped` fires once** — `bot_status` says why (`Stopped` normal · `NotAllowed` lobby-timeout · `Denied` host-denied · `Error` crash).
154
+ - **Streaming-only transcription providers** (`deepgram_streaming`, `assemblyai_streaming`, `meeting_captions`) end at `audio.processed` — they never fire `transcription.processed`, `transcription.failed`, or `bot.done`.
155
+ - **`transcript_id` is not in webhooks** — `meetstream transcript <bot_id>` resolves it via `/detail` automatically.
156
+ - The public docs page for this describes a different (`bot_event`) envelope key — that's inaccurate; this CLI, and the [MeetStream MCP server](https://github.com/meetstream-ai/meetstream-mcp), both implement the live-verified model above.
157
+
158
+ ---
60
159
 
61
160
  ## Configuration
62
161
 
63
162
  | Source | Notes |
64
163
  |--------|-------|
65
164
  | `MEETSTREAM_API_KEY` | wins over the config file |
66
- | `~/.meetstream/config.json` | written by `auth set-key` (0600) |
165
+ | `~/.meetstream/config.json` | written by `auth set-key` (`0600`) |
67
166
  | `MEETSTREAM_API_URL` | override the base URL (default `https://api.meetstream.ai/api/v1`) |
68
167
 
168
+ ## Troubleshooting
169
+
170
+ | Symptom | Fix |
171
+ |---------|-----|
172
+ | "No API key found" | Run `meetstream auth set-key <key>` or `export MEETSTREAM_API_KEY=...` |
173
+ | `auth status` fails with 401 | Key is invalid/revoked — generate a new one at [app.meetstream.ai/api-keys](https://app.meetstream.ai/api-keys) |
174
+ | `transcript` returns "not ready yet" | The meeting isn't fully processed, or the provider is streaming-only (no post-call transcript) — check `bot status` first |
175
+ | `listen` events never arrive | Confirm the bot's `--callback` URL is a public HTTPS URL (use `ngrok http <port>`) — MeetStream will not retry non-2xx or unreachable webhooks |
176
+
69
177
  ## Development
70
178
 
71
179
  ```bash
@@ -75,6 +183,6 @@ npm test # node --test, fully mocked (no network)
75
183
 
76
184
  ---
77
185
 
78
- Docs: [docs.meetstream.ai](https://docs.meetstream.ai) · OpenAPI: [openapi.json](https://docs.meetstream.ai/openapi.json) · MCP server for agents: [meetstream-ai/meetstream-mcp](https://github.com/meetstream-ai/meetstream-mcp)
186
+ Docs: [docs.meetstream.ai](https://docs.meetstream.ai) · OpenAPI: [openapi.json](https://docs.meetstream.ai/openapi.json) · MCP server for AI agents: [@meetstream/mcp](https://github.com/meetstream-ai/meetstream-mcp) · Migrating from Recall.ai: [@meetstream/migrate](https://github.com/meetstream-ai/recall-meetstream-migration-kit)
79
187
 
80
188
  MIT © MeetStream.ai
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@meetstream/cli",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "Official MeetStream CLI — create meeting bots, fetch transcripts, and stream webhook events from your terminal. Zoom, Google Meet, Microsoft Teams.",
5
5
  "type": "module",
6
6
  "bin": {