KosmoKrator

productivity

Kimai CLI for AI Agents

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

Kimai CLI Setup

Kimai can be configured headlessly with `kosmokrator integrations:configure kimai`.

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 kimai --set access_token="$KIMAI_ACCESS_TOKEN" --set url="$KIMAI_URL" --enable --read allow --write ask --json
kosmokrator integrations:doctor kimai --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 KIMAI_ACCESS_TOKEN Secret secret yes API Token
url KIMAI_URL URL url yes Kimai URL

Command Patterns

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

Generic CLI call 
kosmo integrations:call kimai.kimai_list_timesheets '{"page":1,"size":1,"user":"example_user","project":1,"begin":"example_begin","end":"example_end","state":"example_state"}' --json
Provider shortcut 
kosmo integrations:kimai kimai_list_timesheets '{"page":1,"size":1,"user":"example_user","project":1,"begin":"example_begin","end":"example_end","state":"example_state"}' --json

Discovery

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

Discovery commands 
kosmo integrations:docs kimai --json
kosmo integrations:docs kimai.kimai_list_timesheets --json
kosmo integrations:schema kimai.kimai_list_timesheets --json
kosmo integrations:search "Kimai" --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.

CI Run integration calls from CI jobs with JSON output, explicit credentials, and predictable exit status. Cron Jobs Schedule repeatable integration workflows from cron while keeping credentials in KosmoKrator config. Shell Scripts Call integration functions from shell scripts with stable JSON input and output. Headless Automation Use KosmoKrator as a non-interactive integration runtime for local automations and wrappers. Coding Agents Let coding agents discover schemas and execute integration functions through CLI commands or MCP.

CLI Functions

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

kimai.kimai_list_timesheets

List time-tracking entries from Kimai. Supports filtering by user, project, date range, and state. Returns paginated results with timesheet details including duration, description, and associated project/activity.

Read read
Parameters
page, size, user, project, begin, end, state
Generic call 
kosmo integrations:call kimai.kimai_list_timesheets '{"page":1,"size":1,"user":"example_user","project":1,"begin":"example_begin","end":"example_end","state":"example_state"}' --json
Shortcut 
kosmo integrations:kimai kimai_list_timesheets '{"page":1,"size":1,"user":"example_user","project":1,"begin":"example_begin","end":"example_end","state":"example_state"}' --json

kimai.kimai_get_timesheet

Get details of a specific timesheet entry from Kimai. Returns the full timesheet record including begin/end timestamps, duration, description, project, activity, and user information.

Read read
Parameters
id
Generic call 
kosmo integrations:call kimai.kimai_get_timesheet '{"id":1}' --json
Shortcut 
kosmo integrations:kimai kimai_get_timesheet '{"id":1}' --json

kimai.kimai_create_timesheet

Create a new time-tracking entry in Kimai. Requires a begin timestamp and at least a project ID. Optionally specify an end time, activity, and description to categorize the time entry.

Write write
Parameters
begin, end, project, activity, description
Generic call 
kosmo integrations:call kimai.kimai_create_timesheet '{"begin":"example_begin","end":"example_end","project":1,"activity":1,"description":"example_description"}' --json
Shortcut 
kosmo integrations:kimai kimai_create_timesheet '{"begin":"example_begin","end":"example_end","project":1,"activity":1,"description":"example_description"}' --json

kimai.kimai_list_projects

List projects from Kimai. Supports filtering by customer and visibility. Returns project details including name, customer, budget, and time budget information.

Read read
Parameters
page, size, customer, visible
Generic call 
kosmo integrations:call kimai.kimai_list_projects '{"page":1,"size":1,"customer":1,"visible":1}' --json
Shortcut 
kosmo integrations:kimai kimai_list_projects '{"page":1,"size":1,"customer":1,"visible":1}' --json

kimai.kimai_get_project

Get details of a specific project from Kimai. Returns the full project record including name, customer, comment, budget, time budget, and visibility status.

Read read
Parameters
id
Generic call 
kosmo integrations:call kimai.kimai_get_project '{"id":1}' --json
Shortcut 
kosmo integrations:kimai kimai_get_project '{"id":1}' --json

kimai.kimai_list_customers

List customers from Kimai. Supports filtering by visibility. Returns customer details including name, company, contact information, and associated project count.

Read read
Parameters
page, size, visible
Generic call 
kosmo integrations:call kimai.kimai_list_customers '{"page":1,"size":1,"visible":1}' --json
Shortcut 
kosmo integrations:kimai kimai_list_customers '{"page":1,"size":1,"visible":1}' --json

kimai.kimai_get_current_user

Get the profile of the currently authenticated Kimai user. Returns user details including username, display name, email, timezone, and language preferences.

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

Function Schemas

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

kimai.kimai_list_timesheets 7 parameters
Schema command 
kosmo integrations:schema kimai.kimai_list_timesheets --json
ParameterTypeRequiredDescription
page integer no Page number for pagination (default: 1).
size integer no Number of results per page (default: 50).
user string no Filter by user ID or username.
project integer no Filter by project ID.
begin string no Filter start date (ISO 8601, e.g., "2025-01-01T00:00:00"). Only entries starting on or after this date.
end string no Filter end date (ISO 8601, e.g., "2025-01-31T23:59:59"). Only entries starting before or on this date.
state string no Filter by state: "running" for active timers, "stopped" for completed entries. Omit for all.
kimai.kimai_get_timesheet 1 parameters
Schema command 
kosmo integrations:schema kimai.kimai_get_timesheet --json
ParameterTypeRequiredDescription
id integer yes The timesheet entry ID.
kimai.kimai_create_timesheet 5 parameters
Schema command 
kosmo integrations:schema kimai.kimai_create_timesheet --json
ParameterTypeRequiredDescription
begin string yes Start time in ISO 8601 format (e.g., "2025-01-15T09:00:00").
end string no End time in ISO 8601 format (e.g., "2025-01-15T17:00:00"). Omit to start a running timer.
project integer yes The project ID to associate the time entry with.
activity integer no The activity ID to categorize the time entry (e.g., "Development", "Meeting").
description string no A description of the work performed during this time entry.
kimai.kimai_list_projects 4 parameters
Schema command 
kosmo integrations:schema kimai.kimai_list_projects --json
ParameterTypeRequiredDescription
page integer no Page number for pagination (default: 1).
size integer no Number of results per page (default: 50).
customer integer no Filter by customer ID to list only projects for a specific customer.
visible integer no Visibility filter: 1 for visible projects only, 2 for hidden, 3 for all.
kimai.kimai_get_project 1 parameters
Schema command 
kosmo integrations:schema kimai.kimai_get_project --json
ParameterTypeRequiredDescription
id integer yes The project ID.
kimai.kimai_list_customers 3 parameters
Schema command 
kosmo integrations:schema kimai.kimai_list_customers --json
ParameterTypeRequiredDescription
page integer no Page number for pagination (default: 1).
size integer no Number of results per page (default: 50).
visible integer no Visibility filter: 1 for visible customers only, 2 for hidden, 3 for all.
kimai.kimai_get_current_user 0 parameters
Schema command 
kosmo integrations:schema kimai.kimai_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.