Skip to main content
Kyma Agent is the coding agent CLI in the Kyma product stack.
  • Kyma API is the hosted model platform
  • Kyma Agent is the kyma command
  • Kyma Ter is the local multi-agent workspace launched with kyma-ter
Install and get both commands: 
# Recommended on macOS/Linux
curl -fsSL https://kymaapi.com/install.sh | bash

# Recommended on Windows
npm install -g @kyma-api/agent
If you are in PowerShell or Windows Terminal, do not use curl ... | bash. Use npm install -g @kyma-api/agent.

​
What You Get

After install, you have:
  • kyma for terminal-first coding sessions
  • kyma-ter for a browser-based local workspace that can spawn Kyma Agent panes and shell panes side-by-side
kyma-ter is distributed through the same package. The installer downloads the local kyma-ter binary automatically.

​
Install

# Recommended on macOS/Linux
curl -fsSL https://kymaapi.com/install.sh | bash

# Recommended on Windows
npm install -g @kyma-api/agent
Requirements:
  • Node.js 18+

​
First Run

Start Kyma Agent: 
kyma
Then:
  1. Run /login to connect your Kyma account
  2. Run /mode to choose a default mode
  3. Start coding
You can also start with a prompt: 
kyma "explain this repo"
Or run one-shot mode: 
kyma -p "fix the failing test"

​
Core Commands

CommandDescription
kymaStart the interactive coding agent
kyma "prompt"Start with a prompt
kyma -p "task"Run one-shot mode and exit
kyma -cContinue the previous session
Inside a session:
CommandDescription
/loginConnect your Kyma account
/logoutSign out
/modelsBrowse and switch models
/modeSwitch model by task type
/balanceCheck credits and usage limits
/statusAccount, session, and API health
/doctorRun diagnostics
/usageSession cost and token usage
/billingOpen billing page
/dashboardOpen the Kyma dashboard
/upgradeView tiers and upgrade
/feedbackReport issues or give feedback

​
Modes

Kyma Agent lets you switch by task type instead of memorizing model IDs. 
kyma --mode fast
kyma --mode coding
kyma --mode reasoning
kyma --mode cheap
kyma --mode vision
kyma --mode long
Use /mode inside a running session to switch without restarting. Mode defaults currently map to:
ModeDefault model
codingqwen-3-coder
reasoningdeepseek-r1
cheapgpt-oss-120b
visiongemma-4-31b
longkimi-k2.5

​
Project Config

Kyma Agent reads KYMA.md from the project root on session start. Use it for per-project defaults: 
---
model: qwen-3-coder
thinking: high
---
This is useful when one repo should always open with a specific model or thinking level.

​
Authentication Options

Preferred path:
  • launch kyma
  • run /login
  • sign in with your Kyma account
Alternative: 
export KYMA_API_KEY=ky-your-api-key
Optional advanced override: 
export KYMA_BASE_URL=https://your-custom-base-url

​
Kyma Agent And Kyma Ter

Kyma Agent and Kyma Ter are designed to work together:
  • kyma is the agent you talk to
  • kyma-ter is the workspace where you can run many agent and shell sessions in parallel
Start the workspace with: 
kyma-ter
On Windows:
  • kyma runs natively in PowerShell or Windows Terminal
  • kyma-ter is available and works best with WSL2 for shell panes
  • use the copy-paste-first guide at Windows Setup
From there you can:
  • open Kyma Agent panes
  • open regular shell panes
  • manage multiple workspaces in one browser UI
See:

​
Troubleshooting

​
kyma works but kyma-ter does not

Reinstall: 
# Recommended on macOS/Linux
curl -fsSL https://kymaapi.com/install.sh | bash

# Recommended on Windows
npm install -g @kyma-api/agent
If the binary is still missing, install again from a network-enabled environment so the postinstall step can download the kyma-ter binary.

​
Need to verify your account or balance

Use:
  • /status
  • /balance
  • /billing

​
Windows setup and runtime issues

Use:
  • /doctor to verify local runtime, kyma-ter, and WSL detection
  • WSL2 if you want the best kyma-ter shell-pane experience on Windows
  • Windows Setup for the shortest command-by-command path

​
Next Steps

Kyma Ter Overview

See how the local multi-agent workspace fits with Kyma Agent.

Kyma Ter Quickstart

Install, launch, and open your first workspace.

Windows Setup

Use the copy-paste-first setup path for Windows and WSL2.

Authentication

Use your Kyma account or API key across the product stack.

Choosing a Model

Compare active models and pick the right one for each task.