KosmoKrator

productivity

Cloudways CLI for AI Agents

Use the Cloudways CLI from KosmoKrator to call Cloudways tools headlessly, return JSON, inspect schemas, and automate workflows from coding agents, scripts, and CI.

Cloudways CLI Setup

Cloudways can be configured headlessly with `kosmokrator integrations:configure cloudways`.

Install, configure, and verify
# Install KosmoKrator first if it is not available on PATH.
curl -fsSL https://raw.githubusercontent.com/OpenCompanyApp/kosmokrator/main/install.sh | bash

# Configure and verify this integration.
kosmokrator integrations:configure cloudways --set access_token="$CLOUDWAYS_ACCESS_TOKEN" --enable --read allow --write ask --json
kosmokrator integrations:doctor cloudways --json
kosmokrator integrations:status --json

Credentials

Authentication type: Bearer token bearer_token. Configure credentials once, then reuse the same stored profile from scripts, coding CLIs, Lua, and MCP.

KeyEnv varTypeRequiredLabel
access_token CLOUDWAYS_ACCESS_TOKEN Secret secret yes API Key
url CLOUDWAYS_URL URL url no API Base URL

Command Patterns

The generic command is stable across every integration. The provider shortcut is shorter for humans.

Generic CLI call
kosmo integrations:call cloudways.cloudways_list_servers '{}' --json
Provider shortcut
kosmo integrations:cloudways cloudways_list_servers '{}' --json

Discovery

These commands return structured output for coding agents that need to inspect capabilities before choosing a function.

Discovery commands
kosmo integrations:docs cloudways --json
kosmo integrations:docs cloudways.cloudways_list_servers --json
kosmo integrations:schema cloudways.cloudways_list_servers --json
kosmo integrations:search "Cloudways" --json
kosmo integrations:list --json

Automation Contexts

The same configured command surface works in these environments. The command does not change unless the host wrapper, credentials, or permissions change.

CLI Functions

Every function below can be called headlessly. Commands are highlighted, copyable, and scroll horizontally when payloads are long.

cloudways.cloudways_list_servers

List all servers in the Cloudways account.

Read read
Parameters
none
Generic call
kosmo integrations:call cloudways.cloudways_list_servers '{}' --json
Shortcut
kosmo integrations:cloudways cloudways_list_servers '{}' --json

cloudways.cloudways_get_server

Get details for a specific Cloudways server.

Read read
Parameters
server_id
Generic call
kosmo integrations:call cloudways.cloudways_get_server '{"server_id":1}' --json
Shortcut
kosmo integrations:cloudways cloudways_get_server '{"server_id":1}' --json

cloudways.cloudways_list_apps

List all applications across all servers in the Cloudways account.

Read read
Parameters
none
Generic call
kosmo integrations:call cloudways.cloudways_list_apps '{}' --json
Shortcut
kosmo integrations:cloudways cloudways_list_apps '{}' --json

cloudways.cloudways_get_app

Get details for a specific Cloudways application.

Read read
Parameters
server_id, app_id
Generic call
kosmo integrations:call cloudways.cloudways_get_app '{"server_id":1,"app_id":1}' --json
Shortcut
kosmo integrations:cloudways cloudways_get_app '{"server_id":1,"app_id":1}' --json

cloudways.cloudways_list_domains

List domains for a specific Cloudways application.

Read read
Parameters
server_id, app_id
Generic call
kosmo integrations:call cloudways.cloudways_list_domains '{"server_id":1,"app_id":1}' --json
Shortcut
kosmo integrations:cloudways cloudways_list_domains '{"server_id":1,"app_id":1}' --json

cloudways.cloudways_list_projects

List all projects in the Cloudways account.

Read read
Parameters
none
Generic call
kosmo integrations:call cloudways.cloudways_list_projects '{}' --json
Shortcut
kosmo integrations:cloudways cloudways_list_projects '{}' --json

cloudways.cloudways_get_current_user

Get the current authenticated Cloudways account information.

Read read
Parameters
none
Generic call
kosmo integrations:call cloudways.cloudways_get_current_user '{}' --json
Shortcut
kosmo integrations:cloudways cloudways_get_current_user '{}' --json

Function Schemas

Use these parameter tables when building CLI payloads without calling integrations:schema first.

cloudways.cloudways_list_servers 0 parameters
Schema command
kosmo integrations:schema cloudways.cloudways_list_servers --json
ParameterTypeRequiredDescription
No parameters.
cloudways.cloudways_get_server 1 parameters
Schema command
kosmo integrations:schema cloudways.cloudways_get_server --json
ParameterTypeRequiredDescription
server_id integer yes The server ID to look up.
cloudways.cloudways_list_apps 0 parameters
Schema command
kosmo integrations:schema cloudways.cloudways_list_apps --json
ParameterTypeRequiredDescription
No parameters.
cloudways.cloudways_get_app 2 parameters
Schema command
kosmo integrations:schema cloudways.cloudways_get_app --json
ParameterTypeRequiredDescription
server_id integer yes The server ID the application belongs to.
app_id integer yes The application ID to look up.
cloudways.cloudways_list_domains 2 parameters
Schema command
kosmo integrations:schema cloudways.cloudways_list_domains --json
ParameterTypeRequiredDescription
server_id integer yes The server ID the application belongs to.
app_id integer yes The application ID to list domains for.
cloudways.cloudways_list_projects 0 parameters
Schema command
kosmo integrations:schema cloudways.cloudways_list_projects --json
ParameterTypeRequiredDescription
No parameters.
cloudways.cloudways_get_current_user 0 parameters
Schema command
kosmo integrations:schema cloudways.cloudways_get_current_user --json
ParameterTypeRequiredDescription
No parameters.

Permissions

Headless calls still follow the integration read/write permission policy. Configure read/write defaults with integrations:configure. Add --force only for trusted automation that should bypass that policy.