Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.kymaapi.com/llms.txt

Use this file to discover all available pages before exploring further.

Kyma Ter and Kyma Agent are separate products, but they are designed to work together tightly.

One Package, Two Commands

Install:
# Recommended
curl -fsSL https://kymaapi.com/install.sh | bash

# Or with npm
npm install -g @kyma-api/agent
This gives you:
  • kyma for direct terminal-first coding sessions
  • kyma-ter for the local workspace UI
The package installs the kyma-ter launcher and downloads the local kyma-ter binary automatically.

Windows Position

On Windows:
  • kyma is the native CLI path
  • kyma-ter is the workspace path, currently treated as Windows beta
  • WSL2 is recommended for shell panes inside kyma-ter

How They Work Together

Think about the roles like this:
  • kyma is the agent itself
  • kyma-ter is the workspace that can spawn and manage many agent sessions
In practice:
  • open a Kyma Agent pane in Kyma Ter
  • Kyma Ter launches the local kyma command in that pane
  • you can run other panes alongside it, including normal shell sessions
This is the core workflow:
  1. one pane for agent-driven coding
  2. one pane for shell commands
  3. optional extra panes for parallel tasks, logs, or verification

Shared Setup Model

Kyma Ter checks whether:
  • the kyma command is installed
  • your Kyma account or API key is configured
If not, the setup flow can:
  • install @kyma-api/agent
  • guide you through sign-in
  • or save an API key directly
This is why Kyma Ter feels integrated instead of acting like a generic terminal multiplexer.

When To Use Each

Use kyma directly when:
  • you want a single coding session
  • you are already comfortable in one terminal window
  • you want the fastest path into a task
Use kyma-ter when:
  • you want multiple agent sessions at once
  • you need shell and AI panes side-by-side
  • you want a browser-based local workspace
  • you are coordinating planning, editing, and verification in parallel

Update Model

There are two layers to understand:
  • the installer (curl or npm) gives you the package and initial kyma-ter binary
  • Kyma Ter can later self-update its local binary in the background
That means Kyma Agent package updates and Kyma Ter runtime updates are related, but not identical. For day-to-day use:
  1. install via curl -fsSL https://kymaapi.com/install.sh | bash or npm install -g @kyma-api/agent
  2. use kyma when you only need one session
  3. use kyma-ter when you need a workspace with multiple panes
  4. keep your account signed in once and reuse the same product stack
See: