Can I use Litmos as a CLI?

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

Can I expose Litmos through MCP?

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

Where are Litmos credentials stored?

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

Can I deny write access for Litmos MCP tools?

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

education

Litmos CLI for AI Agents

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

7 functions 6 read 1 write API key auth

Submit Litmos feedback View package source

Litmos CLI Setup

Litmos can be configured headlessly with `kosmokrator integrations:configure litmos`.

# 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 litmos --set api_key="$LITMOS_API_KEY" --enable --read allow --write ask --json
kosmokrator integrations:doctor litmos --json
kosmokrator integrations:status --json

Credentials

Authentication type: API key api_key. Configure credentials once, then use the same stored profile from scripts, coding CLIs, Lua code mode, and the MCP gateway.

Key	Env var	Type	Required	Label
`api_key`	`LITMOS_API_KEY`	Secret `secret`	yes	API Key
`url`	`LITMOS_URL`	URL `url`	no	API Base URL

Call Litmos Headlessly

Use the generic call form when another coding CLI or script needs a stable universal interface.

kosmo integrations:call litmos.litmos_list_users '{
  "limit": 1,
  "page": 1,
  "search": "example_search"
}' --json

Use the provider shortcut form for shorter human-facing commands.

kosmo integrations:litmos litmos_list_users '{
  "limit": 1,
  "page": 1,
  "search": "example_search"
}' --json

Agent Discovery Commands

These commands return structured output for coding agents that need to inspect capabilities 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

All CLI Functions

Every function below can be called headlessly. The generic form is stable across all integrations; the provider shortcut is shorter but specific to Litmos.

`litmos.litmos_list_users`

Read read

List users in your Litmos organization. Returns user IDs, names, emails, and status. Supports pagination and search.

Parameters: limit, page, search

Generic CLI call

kosmo integrations:call litmos.litmos_list_users '{"limit":1,"page":1,"search":"example_search"}' --json

Provider shortcut

kosmo integrations:litmos litmos_list_users '{"limit":1,"page":1,"search":"example_search"}' --json

`litmos.litmos_get_user`

Read read

Get detailed information about a specific Litmos user by their ID, including profile data, course assignments, and team memberships.

Parameters: id

Generic CLI call

kosmo integrations:call litmos.litmos_get_user '{"id":"example_id"}' --json

Provider shortcut

kosmo integrations:litmos litmos_get_user '{"id":"example_id"}' --json

`litmos.litmos_create_user`

Write write

Create a new user in Litmos. Requires a first name, last name, email address, and username for login.

Parameters: FirstName, LastName, Email, UserName

Generic CLI call

kosmo integrations:call litmos.litmos_create_user '{"FirstName":"example_FirstName","LastName":"example_LastName","Email":"example_Email","UserName":"example_UserName"}' --json

Provider shortcut

kosmo integrations:litmos litmos_create_user '{"FirstName":"example_FirstName","LastName":"example_LastName","Email":"example_Email","UserName":"example_UserName"}' --json

`litmos.litmos_list_courses`

Read read

List courses in your Litmos organization. Returns course IDs, names, descriptions, and status. Supports pagination and search.

Parameters: limit, page, search

Generic CLI call

kosmo integrations:call litmos.litmos_list_courses '{"limit":1,"page":1,"search":"example_search"}' --json

Provider shortcut

kosmo integrations:litmos litmos_list_courses '{"limit":1,"page":1,"search":"example_search"}' --json

`litmos.litmos_get_course`

Read read

Get detailed information about a specific Litmos course by its ID, including modules, description, and completion settings.

Parameters: id

Generic CLI call

kosmo integrations:call litmos.litmos_get_course '{"id":"example_id"}' --json

Provider shortcut

kosmo integrations:litmos litmos_get_course '{"id":"example_id"}' --json

`litmos.litmos_list_teams`

Read read

List teams in your Litmos organization. Returns team IDs, names, and description. Supports pagination.

Parameters: limit, page

Generic CLI call

kosmo integrations:call litmos.litmos_list_teams '{"limit":1,"page":1}' --json

Provider shortcut

kosmo integrations:litmos litmos_list_teams '{"limit":1,"page":1}' --json

`litmos.litmos_get_current_user`

Read read

Get the profile of the currently authenticated Litmos user. Useful for verifying API credentials and identifying the connected account.

Parameters: none

Generic CLI call

kosmo integrations:call litmos.litmos_get_current_user '{}' --json

Provider shortcut

kosmo integrations:litmos litmos_get_current_user '{}' --json

Function Schemas

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

`litmos.litmos_list_users`

List users in your Litmos organization. Returns user IDs, names, emails, and status. Supports pagination and search.

Operation: Read read
Schema command: kosmo integrations:schema litmos.litmos_list_users --json

Parameter	Type	Required	Description
`limit`	integer	no	Number of users to return per page (default: 100, max: 1000).
`page`	integer	no	Page number for pagination (default: 1).
`search`	string	no	Search term to filter users by name or email.

`litmos.litmos_get_user`

Get detailed information about a specific Litmos user by their ID, including profile data, course assignments, and team memberships.

Operation: Read read
Schema command: kosmo integrations:schema litmos.litmos_get_user --json

Parameter	Type	Required	Description
`id`	string	yes	The Litmos user ID.

`litmos.litmos_create_user`

Create a new user in Litmos. Requires a first name, last name, email address, and username for login.

Operation: Write write
Schema command: kosmo integrations:schema litmos.litmos_create_user --json

Parameter	Type	Required	Description
`FirstName`	string	yes	The user's first name.
`LastName`	string	yes	The user's last name.
`Email`	string	yes	The user's email address.
`UserName`	string	yes	The user's login username.

`litmos.litmos_list_courses`

List courses in your Litmos organization. Returns course IDs, names, descriptions, and status. Supports pagination and search.

Operation: Read read
Schema command: kosmo integrations:schema litmos.litmos_list_courses --json

Parameter	Type	Required	Description
`limit`	integer	no	Number of courses to return per page (default: 100, max: 1000).
`page`	integer	no	Page number for pagination (default: 1).
`search`	string	no	Search term to filter courses by name.

`litmos.litmos_get_course`

Get detailed information about a specific Litmos course by its ID, including modules, description, and completion settings.

Operation: Read read
Schema command: kosmo integrations:schema litmos.litmos_get_course --json

Parameter	Type	Required	Description
`id`	string	yes	The Litmos course ID.

`litmos.litmos_list_teams`

List teams in your Litmos organization. Returns team IDs, names, and description. Supports pagination.

Operation: Read read
Schema command: kosmo integrations:schema litmos.litmos_list_teams --json

Parameter	Type	Required	Description
`limit`	integer	no	Number of teams to return per page (default: 100, max: 1000).
`page`	integer	no	Page number for pagination (default: 1).

`litmos.litmos_get_current_user`

Get the profile of the currently authenticated Litmos user. Useful for verifying API credentials and identifying the connected account.

Operation: Read read
Schema command: kosmo integrations:schema litmos.litmos_get_current_user --json

Parameter	Type	Required	Description
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.