sales
Gainsight CLI for Shell Scripts
Use the Gainsight CLI for shell scripts with headless JSON commands, schema discovery, credentials, and permission controls.
7 functions 7 read 0 write Manual OAuth token auth
Gainsight 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 Gainsight CLI uses the same integration registry as the TUI, Lua runtime, and MCP gateway, but returns predictable command output for automation.
Command Shape
# Gainsight CLI for Shell Scripts
kosmokrator integrations:configure gainsight --set access_token="$GAINSIGHT_ACCESS_TOKEN" --enable --read allow --write ask --json
kosmo integrations:call gainsight.gainsight_list_companies '{"page":1,"limit":1,"search":"example_search"}' --json Discovery Before Execution
Agents and scripts can inspect Gainsight docs and schemas before choosing a function.
kosmo integrations:docs gainsight --json
kosmo integrations:docs gainsight.gainsight_list_companies --json
kosmo integrations:schema gainsight.gainsight_list_companies --json
kosmo integrations:search "Gainsight" --json
kosmo integrations:list --json Useful Gainsight CLI Functions
| Function | Type | Parameters | Description |
|---|---|---|---|
gainsight.gainsight_list_companies | Read | page, limit, search | List companies from Gainsight. Returns company details including name, industry, ARR, health score, and lifecycle stage. |
gainsight.gainsight_get_company | Read | companyId | Get detailed information about a specific company in Gainsight, including health score, ARR, lifecycle stage, and CSM assignment. |
gainsight.gainsight_list_users | Read | page, limit, role | List users in the Gainsight tenant. Returns user details including name, email, role, and last active date. |
gainsight.gainsight_get_user | Read | userId | Get detailed information about a specific user in Gainsight, including role, assigned accounts, and activity data. |
gainsight.gainsight_list_surveys | Read | page, limit, status | List surveys from Gainsight. Returns survey details including name, type, status, response count, and creation date. |
gainsight.gainsight_get_survey | Read | surveyId | Get detailed information about a specific survey in Gainsight, including questions, response statistics, and distribution settings. |
gainsight.gainsight_get_current_user | Read | none | Get the currently authenticated Gainsight user profile. Useful for verifying credentials and understanding whose data is being accessed. |
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.