@kyma-api/agent

Kyma Agent

Terminal-first coding agent powered by Kyma API.

Install one package, sign in once, and use many models through one balance.

Install

npm i -g @kyma-api/agent

On Windows, use npm install -g @kyma-api/agent in PowerShell or Windows Terminal. Do not use curl ... | bash.

This package installs:

• kyma for direct coding sessions
• kyma-ter for the local multi-agent workspace

Kyma Agent vs Kyma Ter

The package contains two related tools:

• kyma is the coding agent CLI
• kyma-ter is the browser-based local workspace for running many kyma and shell sessions in parallel

kyma-ter is distributed through this same package. The install step downloads the local kyma-ter binary automatically.

Usage

kyma                          # Interactive coding agent
kyma "explain this repo"      # Start with a prompt
kyma -p "fix the bug"         # One-shot mode (process and exit)
kyma -c                       # Continue previous session

Launch the workspace with:

kyma-ter

On Windows:

• kyma runs natively in PowerShell or Windows Terminal
• kyma-ter is available, with shell panes optimized for WSL2

First Run

kyma
# 1. Run /connect to connect your Kyma account
# 2. Run /init in a repo to scaffold KYMA.md
# 3. Start coding

Or start with kyma-ter if you want a local multi-pane workspace first.

Switching Models

Browse and switch models with /models. Filter by keyword:

/models coding          # models tagged for code
/models vision          # vision-capable models
/models cheap           # budget-tier models

Or set a per-project default by pinning model: in your KYMA.md frontmatter — see Project Config below.

Commands

Command	Description
/connect	Sign in to your Kyma account
/disconnect	Sign out
/models	Browse and switch models
/init	Scaffold KYMA.md for this project
/mcp	Manage Model Context Protocol servers
/status	Account, credits, session, and diagnostics (merged /doctor, /balance, /usage)
/billing	Open billing page
/dashboard	Open Kyma dashboard
/upgrade	View tiers and upgrade
/feedback	Report issues or give feedback

Project Config

Create a KYMA.md at your project root to set per-project defaults. /init scaffolds one for you:

---
model: qwen-3-coder
thinking: high
---

# My Project

## Conventions
- All DB access goes through `src/db.ts`
- Run tests before committing

The frontmatter pins model + thinking level at session start. The markdown body is prepended to the system prompt on every turn, so edits apply without restarting.

Kyma loads context from three layers in precedence order (later layers override):

• ~/.kyma/agent/KYMA.md — user global
• ./KYMA.md (or ./CLAUDE.md or ./AGENTS.md as fallback) — project shared, committed
• ./KYMA.local.md — personal overrides, gitignored

MCP Servers

Kyma speaks Model Context Protocol over stdio. Drop a config at ~/.kyma/agent/mcp.json (user) or ./.kyma/mcp.json (project):

{
  "mcpServers": {
    "filesystem": {
      "command": "npx",
      "args": ["-y", "@modelcontextprotocol/server-filesystem", "/Users/me/projects"],
      "enabled": true
    }
  }
}

Manage servers inside kyma:

/mcp                      # list configured servers and their tools
/mcp test filesystem      # spawn + handshake + list tools (useful for debugging)
/mcp enable filesystem    # flip enabled in config
/mcp disable filesystem

Tools are namespaced as mcp__<server>__<tool> in the Pi tool registry.

Environment

Variable	Description
KYMA_API_KEY	API key (alternative to /login)
KYMA_BASE_URL	Custom API base URL

Windows Notes

• kyma is intended to run natively on Windows
• kyma-ter on Windows currently works best as a beta experience with WSL2 installed
• Run /status inside kyma to verify local setup, kyma-ter, WSL detection, and MCP health

Docs

• Kyma Agent: docs.kymaapi.com/guides/agent
• Kyma Ter overview: docs.kymaapi.com/guides/kyma-ter/overview
• Kyma Ter quickstart: docs.kymaapi.com/guides/kyma-ter/quickstart

Pricing

All models are pay-per-token through your Kyma account. Free credits on signup. See kymaapi.com for pricing details.

Links

• Website: kymaapi.com
• Docs: docs.kymaapi.com
• Dashboard: kymaapi.com/dashboard

License

MIT