education
Litmos CLI for Shell Scripts
Use the Litmos CLI for shell scripts with headless JSON commands, schema discovery, credentials, and permission controls.
7 functions 6 read 1 write API key auth
Litmos 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 Litmos CLI uses the same integration registry as the TUI, Lua runtime, and MCP gateway, but returns predictable command output for automation.
Command Shape
# Litmos CLI for Shell Scripts
kosmokrator integrations:configure litmos --set api_key="$LITMOS_API_KEY" --enable --read allow --write ask --json
kosmo integrations:call litmos.litmos_list_users '{"limit":1,"page":1,"search":"example_search"}' --json Discovery Before Execution
Agents and scripts can inspect Litmos docs and schemas before choosing a function.
kosmo integrations:docs litmos --json
kosmo integrations:docs litmos.litmos_list_users --json
kosmo integrations:schema litmos.litmos_list_users --json
kosmo integrations:search "Litmos" --json
kosmo integrations:list --json Useful Litmos CLI Functions
| Function | Type | Parameters | Description |
|---|---|---|---|
litmos.litmos_list_users | Read | limit, page, search | List users in your Litmos organization. Returns user IDs, names, emails, and status. Supports pagination and search. |
litmos.litmos_get_user | Read | id | Get detailed information about a specific Litmos user by their ID, including profile data, course assignments, and team memberships. |
litmos.litmos_create_user | Write | FirstName, LastName, Email, UserName | Create a new user in Litmos. Requires a first name, last name, email address, and username for login. |
litmos.litmos_list_courses | Read | limit, page, search | List courses in your Litmos organization. Returns course IDs, names, descriptions, and status. Supports pagination and search. |
litmos.litmos_get_course | Read | id | Get detailed information about a specific Litmos course by its ID, including modules, description, and completion settings. |
litmos.litmos_list_teams | Read | limit, page | List teams in your Litmos organization. Returns team IDs, names, and description. Supports pagination. |
litmos.litmos_get_current_user | Read | none | Get the profile of the currently authenticated Litmos user. Useful for verifying API credentials and identifying the connected account. |
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.