communication
Agora CLI for Headless Automation
Use the Agora CLI for headless automation with headless JSON commands, schema discovery, credentials, and permission controls.
7 functions 5 read 2 write API key auth
Agora CLI for Headless Automation
Use KosmoKrator as a non-interactive integration runtime for local automations and wrappers.
Use headless automation when another tool needs a stable local command surface. The Agora CLI uses the same integration registry as the TUI, Lua runtime, and MCP gateway, but returns predictable command output for automation.
Command Shape
# Agora CLI for Headless Automation
kosmokrator integrations:configure agora --set api_key="$AGORA_API_KEY" --enable --read allow --write ask --json
kosmo integrations:call agora.agora_list_projects '{}' --json Discovery Before Execution
Agents and scripts can inspect Agora docs and schemas before choosing a function.
kosmo integrations:docs agora --json
kosmo integrations:docs agora.agora_list_projects --json
kosmo integrations:schema agora.agora_list_projects --json
kosmo integrations:search "Agora" --json
kosmo integrations:list --json Useful Agora CLI Functions
| Function | Type | Parameters | Description |
|---|---|---|---|
agora.agora_list_projects | Read | none | List all Agora projects. Returns project IDs, names, and their current status. |
agora.agora_get_project | Read | project_id | Get details of a specific Agora project by ID, including its name, App ID, App Certificate, and status. |
agora.agora_create_project | Write | name, recording_config, sign_key | Create a new Agora project. Specify a project name and optional configuration such as recording settings and authentication mode. |
agora.agora_list_recordings | Read | cname, resource_id, limit, start_ts, end_ts | List cloud recordings from Agora with optional filters. Supports filtering by channel name, resource ID, and time range. |
agora.agora_get_recording | Read | recording_id | Get details of a specific Agora cloud recording by its session ID (sid), including status, file list, and download URLs. |
agora.agora_start_recording | Write | cname, uid, clientRequest | Start a cloud recording for an Agora channel. Specify the channel name, UID, and recording configuration such as container format, storage settings, and layout. |
agora.agora_get_current_user | Read | none | Get information about the current authenticated Agora user. |
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.