Can I use EmailOctopus as a CLI?

Yes. KosmoKrator exposes a EmailOctopus CLI through kosmo integrations:call and the provider shortcut command. Commands can return JSON for scripts, CI, and coding agents.

Can I expose EmailOctopus through MCP?

Yes. The KosmoKrator MCP gateway can expose selected EmailOctopus tools to clients such as Claude Code, Cursor, Codex, and other MCP-compatible tools.

Where are EmailOctopus credentials stored?

EmailOctopus credentials are configured in KosmoKrator's local integration settings and reused by CLI, Lua, and MCP gateway surfaces.

Can I deny write access for EmailOctopus MCP tools?

Yes. Start the gateway with --write=deny for read-only clients, or use ask/allow only for trusted workspaces.

EmailOctopus CLI for Shell Scripts

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

6 functions 5 read 1 write API key auth

Submit EmailOctopus feedback View package source

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

Command Shape

# EmailOctopus CLI for Shell Scripts
kosmokrator integrations:configure email-octopus --set api_key="$EMAIL_OCTOPUS_API_KEY" --set list_id="$EMAIL_OCTOPUS_LIST_ID" --enable --read allow --write ask --json
kosmo integrations:call email-octopus.emailoctopus_list_contacts '{"list_id":"example_list_id","limit":1,"before":"example_before","after":"example_after"}' --json

Discovery Before Execution

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

kosmo integrations:docs email-octopus --json
kosmo integrations:docs email-octopus.emailoctopus_list_contacts --json
kosmo integrations:schema email-octopus.emailoctopus_list_contacts --json
kosmo integrations:search "EmailOctopus" --json
kosmo integrations:list --json

Useful EmailOctopus CLI Functions

Function	Type	Parameters	Description
`email-octopus.emailoctopus_list_contacts`	Read	list_id, limit, before, after	List contacts in an EmailOctopus mailing list. Returns contact email addresses, statuses, and pagination cursors.
`email-octopus.emailoctopus_get_contact`	Read	contact_id, list_id	Get details of a specific contact in an EmailOctopus mailing list, including email address, status, and custom fields.
`email-octopus.emailoctopus_create_contact`	Write	email_address, list_id, first_name, last_name	Add a new contact to an EmailOctopus mailing list. Requires an email address.
`email-octopus.emailoctopus_list_campaigns`	Read	limit, before, after	List all email campaigns in your EmailOctopus account, including their status, subject, and send dates.
`email-octopus.emailoctopus_get_campaign`	Read	campaign_id	Get details of a specific EmailOctopus campaign, including status, subject, content, and delivery statistics.
`email-octopus.emailoctopus_get_current_user`	Read	none	Get the authenticated EmailOctopus account details, including name and email address.

Automation Notes

Use --json for machine-readable output.
Keep credentials out of argv by using environment variables or stored KosmoKrator configuration.
Configure read/write policy before unattended runs; use --force only for trusted automation.
Use the MCP gateway instead when the agent needs dynamic tool discovery inside a conversation.

Related EmailOctopus CLI Pages

CI EmailOctopus CLI for CI. Cron Jobs EmailOctopus CLI for cron jobs. Headless Automation EmailOctopus CLI for headless automation. Coding Agents EmailOctopus CLI for coding agents.