Can I use Immigrant as a CLI?

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

Can I expose Immigrant through MCP?

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

Where are Immigrant credentials stored?

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

Can I deny write access for Immigrant MCP tools?

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

productivity

Immigrant CLI for Shell Scripts

Use the Immigrant CLI for shell scripts with headless JSON commands, schema discovery, credentials, and permission controls.

7 functions 6 read 1 write Bearer token auth

Submit Immigrant feedback View package source

Immigrant 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 Immigrant CLI uses the same integration registry as the TUI, Lua runtime, and MCP gateway, but returns predictable command output for automation.

Command Shape

# Immigrant CLI for Shell Scripts
kosmokrator integrations:configure immigrant --set access_token="$IMMIGRANT_ACCESS_TOKEN" --enable --read allow --write ask --json
kosmo integrations:call immigrant.immigrant_list_applications '{"limit":1,"page":1,"status":"example_status"}' --json

Discovery Before Execution

Agents and scripts can inspect Immigrant docs and schemas before choosing a function.

kosmo integrations:docs immigrant --json
kosmo integrations:docs immigrant.immigrant_list_applications --json
kosmo integrations:schema immigrant.immigrant_list_applications --json
kosmo integrations:search "Immigrant" --json
kosmo integrations:list --json

Useful Immigrant CLI Functions

Function	Type	Parameters	Description
`immigrant.immigrant_list_applications`	Read	limit, page, status	List immigration applications. Returns a paginated list of applications, optionally filtered by status.
`immigrant.immigrant_get_application`	Read	id	Get details of a specific immigration application by its ID.
`immigrant.immigrant_create_application`	Write	type, applicant_name, details	Create a new immigration application. Requires a type and applicant name. Optionally provide additional details.
`immigrant.immigrant_list_documents`	Read	application_id, limit, page	List documents for a specific immigration application. Returns a paginated list of documents.
`immigrant.immigrant_get_document`	Read	id	Get details of a specific document by its ID.
`immigrant.immigrant_list_statuses`	Read	none	List all available immigration application statuses. Use this to understand valid status values for filtering.
`immigrant.immigrant_get_current_user`	Read	none	Get the profile of the currently authenticated Immigrant user. Use this to verify credentials and see user details.

Automation Notes

Use --json for machine-readable output.
Keep credentials out of argv by using environment variables or stored KosmoKrator configuration.
Configure read/write policy before unattended runs; use --force only for trusted automation.
Use the MCP gateway instead when the agent needs dynamic tool discovery inside a conversation.

Related Immigrant CLI Pages

CI Immigrant CLI for CI. Cron Jobs Immigrant CLI for cron jobs. Headless Automation Immigrant CLI for headless automation. Coding Agents Immigrant CLI for coding agents.