KosmoKrator

marketing

VBout CLI for Shell Scripts

Use the VBout CLI for shell scripts with headless JSON commands, schema discovery, credentials, and permission controls.

6 functions 5 read 1 write API key auth

VBout 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 VBout CLI uses the same integration registry as the TUI, Lua runtime, and MCP gateway, but returns predictable command output for automation.

Command Shape

# VBout CLI for Shell Scripts
kosmokrator integrations:configure vbout --set api_key="$VBOUT_API_KEY" --enable --read allow --write ask --json
kosmo integrations:call vbout.vbout_list_contacts '{"limit":1,"offset":1}' --json

Discovery Before Execution

Agents and scripts can inspect VBout docs and schemas before choosing a function.

kosmo integrations:docs vbout --json
kosmo integrations:docs vbout.vbout_list_contacts --json
kosmo integrations:schema vbout.vbout_list_contacts --json
kosmo integrations:search "VBout" --json
kosmo integrations:list --json

Useful VBout CLI Functions

FunctionTypeParametersDescription
vbout.vbout_list_contacts Read limit, offset List contacts from VBout. Returns paginated contact records including email, name, and list membership.
vbout.vbout_get_contact Read id Get details for a specific VBout contact by ID, including email, name, custom fields, and list memberships.
vbout.vbout_create_contact Write email, list_id, first_name, last_name, phone Add a new contact to a VBout email list. Requires an email address and a list ID. Optionally pass additional fields like first name, last name, or custom fields.
vbout.vbout_list_campaigns Read limit, offset List email campaigns from VBout. Returns paginated campaign records including subject, status, and send statistics.
vbout.vbout_get_campaign Read id Get details for a specific VBout email campaign by ID, including subject, content, status, and delivery statistics.
vbout.vbout_get_current_user Read none Get the currently authenticated VBout user profile. Useful for verifying API credentials and retrieving account information.

Automation Notes

Related VBout CLI Pages