communication
Whereby CLI for Shell Scripts
Use the Whereby CLI for shell scripts with headless JSON commands, schema discovery, credentials, and permission controls.
7 functions 5 read 2 write Bearer token auth
Whereby CLI for Shell Scripts
Call integration functions from shell scripts with stable JSON input and output.
Use shell scripts for small local automations that need one or more integration calls. The Whereby CLI uses the same integration registry as the TUI, Lua runtime, and MCP gateway, but returns predictable command output for automation.
Command Shape
# Whereby CLI for Shell Scripts
kosmokrator integrations:configure whereby --set access_token="$WHEREBY_ACCESS_TOKEN" --enable --read allow --write ask --json
kosmo integrations:call whereby.whereby_list_rooms '{"limit":1,"cursor":"example_cursor"}' --json Discovery Before Execution
Agents and scripts can inspect Whereby docs and schemas before choosing a function.
kosmo integrations:docs whereby --json
kosmo integrations:docs whereby.whereby_list_rooms --json
kosmo integrations:schema whereby.whereby_list_rooms --json
kosmo integrations:search "Whereby" --json
kosmo integrations:list --json Useful Whereby CLI Functions
| Function | Type | Parameters | Description |
|---|---|---|---|
whereby.whereby_list_rooms | Read | limit, cursor | List Whereby rooms with optional pagination and filtering. |
whereby.whereby_get_room | Read | room_name | Get detailed information about a specific Whereby room, including meeting URL, configuration, and host details. |
whereby.whereby_create_room | Write | room_mode, room_name_prefix, start_date, end_date, fields | Create a new Whereby video meeting room with optional configuration such as room mode, time limits, and participant settings. |
whereby.whereby_delete_room | Write | room_name | Delete a Whereby room by its name. This action is permanent and cannot be undone. |
whereby.whereby_list_meetings | Read | limit, cursor, from_date, to_date, room_name | List past Whereby meetings with optional pagination and date filtering. |
whereby.whereby_get_meeting | Read | meeting_id | Get detailed information about a specific past Whereby meeting, including participants, duration, and recording status. |
whereby.whereby_get_current_user | Read | none | Get the profile information of the currently authenticated Whereby user, including account details and plan information. |
Automation Notes
- Use
--jsonfor machine-readable output. - Keep credentials out of argv by using environment variables or stored KosmoKrator configuration.
- Configure read/write policy before unattended runs; use
--forceonly for trusted automation. - Use the MCP gateway instead when the agent needs dynamic tool discovery inside a conversation.