Can I use Beamer as a CLI?

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

Can I expose Beamer through MCP?

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

Where are Beamer credentials stored?

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

Can I deny write access for Beamer MCP tools?

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

marketing

Beamer CLI for AI Agents

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

6 functions 5 read 1 write API key auth

Submit Beamer feedback View package source

Beamer CLI Setup

Beamer can be configured headlessly with `kosmokrator integrations:configure beamer`.

# 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 beamer --set api_key="$BEAMER_API_KEY" --enable --read allow --write ask --json
kosmokrator integrations:doctor beamer --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`	`BEAMER_API_KEY`	Secret `secret`	yes	API Key
`url`	`BEAMER_URL`	URL `url`	no	Beamer API URL

Call Beamer Headlessly

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

kosmo integrations:call beamer.beamer_list_posts '{
  "limit": 1,
  "page": 1,
  "status": "example_status"
}' --json

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

kosmo integrations:beamer beamer_list_posts '{
  "limit": 1,
  "page": 1,
  "status": "example_status"
}' --json

Agent Discovery Commands

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

kosmo integrations:docs beamer --json
kosmo integrations:docs beamer.beamer_list_posts --json
kosmo integrations:schema beamer.beamer_list_posts --json
kosmo integrations:search "Beamer" --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 Beamer.

`beamer.beamer_list_posts`

Read read

List changelog posts and announcements from Beamer. Supports pagination with limit and page, and filtering by status (published, draft, scheduled).

Parameters: limit, page, status

Generic CLI call

kosmo integrations:call beamer.beamer_list_posts '{"limit":1,"page":1,"status":"example_status"}' --json

Provider shortcut

kosmo integrations:beamer beamer_list_posts '{"limit":1,"page":1,"status":"example_status"}' --json

`beamer.beamer_get_post`

Read read

Retrieve a single Beamer changelog post by its ID. Returns the full post including title, content, date, category, and metadata.

Parameters: id

Generic CLI call

kosmo integrations:call beamer.beamer_get_post '{"id":1}' --json

Provider shortcut

kosmo integrations:beamer beamer_get_post '{"id":1}' --json

`beamer.beamer_create_post`

Write write

Create a new changelog post or announcement in Beamer. Provide a title and content (HTML supported). Optionally set a category and scheduled publication date.

Parameters: title, content, category, date

Generic CLI call

kosmo integrations:call beamer.beamer_create_post '{"title":"example_title","content":"example_content","category":1,"date":"example_date"}' --json

Provider shortcut

kosmo integrations:beamer beamer_create_post '{"title":"example_title","content":"example_content","category":1,"date":"example_date"}' --json

`beamer.beamer_list_comments`

Read read

List all comments on a specific Beamer post. Returns comment text, author info, and timestamps.

Parameters: post_id

Generic CLI call

kosmo integrations:call beamer.beamer_list_comments '{"post_id":1}' --json

Provider shortcut

kosmo integrations:beamer beamer_list_comments '{"post_id":1}' --json

`beamer.beamer_get_current_user`

Read read

Get the profile of the currently authenticated Beamer user. Returns name, email, role, and account details. Useful for verifying credentials.

Parameters: none

Generic CLI call

kosmo integrations:call beamer.beamer_get_current_user '{}' --json

Provider shortcut

kosmo integrations:beamer beamer_get_current_user '{}' --json

`beamer.beamer_list_categories`

Read read

List all post categories in your Beamer account. Returns category IDs and names for use when creating or filtering posts.

Parameters: none

Generic CLI call

kosmo integrations:call beamer.beamer_list_categories '{}' --json

Provider shortcut

kosmo integrations:beamer beamer_list_categories '{}' --json

Function Schemas

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

`beamer.beamer_list_posts`

List changelog posts and announcements from Beamer. Supports pagination with limit and page, and filtering by status (published, draft, scheduled).

Operation: Read read
Schema command: kosmo integrations:schema beamer.beamer_list_posts --json

Parameter	Type	Required	Description
`limit`	integer	no	Maximum number of posts to return (default: 10, max: 100).
`page`	integer	no	Page number for pagination (default: 1).
`status`	string	no	Filter by publication status: "published", "draft", or "scheduled".

`beamer.beamer_get_post`

Retrieve a single Beamer changelog post by its ID. Returns the full post including title, content, date, category, and metadata.

Operation: Read read
Schema command: kosmo integrations:schema beamer.beamer_get_post --json

Parameter	Type	Required	Description
`id`	integer	yes	The post ID.

`beamer.beamer_create_post`

Create a new changelog post or announcement in Beamer. Provide a title and content (HTML supported). Optionally set a category and scheduled publication date.

Operation: Write write
Schema command: kosmo integrations:schema beamer.beamer_create_post --json

Parameter	Type	Required	Description
`title`	string	yes	The post title.
`content`	string	yes	The post body content. HTML formatting is supported.
`category`	integer	no	The category ID to assign the post to.
`date`	string	no	Publication date in ISO 8601 format (e.g., "2025-06-01T12:00:00Z"). Omit to publish immediately.

`beamer.beamer_list_comments`

List all comments on a specific Beamer post. Returns comment text, author info, and timestamps.

Operation: Read read
Schema command: kosmo integrations:schema beamer.beamer_list_comments --json

Parameter	Type	Required	Description
`post_id`	integer	yes	The post ID to list comments for.

`beamer.beamer_get_current_user`

Get the profile of the currently authenticated Beamer user. Returns name, email, role, and account details. Useful for verifying credentials.

Operation: Read read
Schema command: kosmo integrations:schema beamer.beamer_get_current_user --json

Parameter	Type	Required	Description
No parameters.

`beamer.beamer_list_categories`

List all post categories in your Beamer account. Returns category IDs and names for use when creating or filtering posts.

Operation: Read read
Schema command: kosmo integrations:schema beamer.beamer_list_categories --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.