Skip to main content
DocumentationLibraryReference
On this page

Kater CLI Your terminal

kater agent

Starts Claude Code or Codex in your local copy of Kater content, with Kater's tools.

The agent starts on the model-table skill, which sets up your first semantic models and queries.

Examples

Terminal window
# Go to your local copy
cd ~/kater
# Start the agent you have installed, Claude Code before Codex
kater agent
# Start Codex
kater agent codex

Arguments

ArgumentDescription
<agent>Optional. The agent to start: claude for Claude Code, or codex for Codex. Leave it out to start the first one installed, Claude Code before Codex.

Options

It also takes --help.

What it sets up

  • Where it starts. The agent starts at the root of the local copy that you are in. Outside a local copy, it starts in the folder you are in.
  • Kater’s tools. It adds the Kater MCP server to the agent’s settings in that folder. That is .mcp.json for Claude Code, or .codex/config.toml for Codex. The server runs kater serve --kater-root ., and other servers in those files stay.
  • The first message. It tells the agent to follow the model-table skill, ai_tools/skills/model-table.md in your connection’s folder. It also says that files are not in Kater until you commit them and run kater git push.
  • Your company first. When the root about.md holds no company description, the agent first asks you about the business.
  • Install the agent first. The command stops when neither claude nor codex is installed.

See also