Kyma Ter

Kyma Ter is the local multi-agent workspace for coding agents and shell execution.

It gives you one browser-based workspace where kyma and normal shell sessions can run side by side on your machine.

• Kyma API is the hosted backend platform
• Kyma Agent is the kyma coding agent
• Kyma Ter is the local workspace launched with kyma-ter

Links:

• Website: https://kymaapi.com/ter
• Docs: https://docs.kymaapi.com/guides/kyma-ter/overview
• Windows setup: https://docs.kymaapi.com/guides/windows-setup
• Releases: https://github.com/kyma-api/kyma-ter/releases

Kyma Ter runs a local Go server, serves an embedded frontend, and lets you run Kyma Agent and shell sessions side by side in a browser UI.

How It Is Distributed

Kyma Ter is distributed through the @kyma-api/agent npm package.

Recommended — curl installer:

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

The install script detects your OS, installs Node.js if needed, runs npm install -g @kyma-api/agent, and the postinstall step downloads the kyma-ter binary into ~/.kyma/ter/bin/.

Alternative — npm directly:

npm install -g @kyma-api/agent

Both methods install:

• kyma
• kyma-ter

GitHub release assets for kyma-ter, including Windows binaries, are published in:

• https://github.com/kyma-api/kyma-ter/releases

Windows Support

Current support position:

• kyma runs natively on Windows
• kyma-ter is available on Windows as a beta experience
• for the best shell-pane experience in kyma-ter, use WSL2

Support summary:

• macOS: native
• Linux: native
• Windows: beta
• Windows shell panes: best with WSL2

Recommended Windows setup:

1. install @kyma-api/agent
2. run kyma in PowerShell or Windows Terminal
3. run kyma-ter
4. use WSL2 for shell panes inside the workspace

If you want copy-paste-first instructions, use:

• https://docs.kymaapi.com/guides/windows-setup

What Kyma Ter Does

Kyma Ter is built for local, parallel terminal work:

• multi-pane workspace UI
• Kyma Agent panes
• shell panes
• multiple workspaces
• keyboard shortcuts
• local config and local persistence
• browser UI connected over local HTTP and WebSocket routes

Typical workflow:

1. run kyma-ter
2. open one pane for kyma
3. open one pane for tests or builds
4. open more workspaces when one grid is not enough

Local Development

Backend:

go run ./cmd/kyma-ter/ serve --port 18800

Frontend:

cd frontend
npm install
npm run dev

Useful shortcuts from the project root:

make run
make frontend

Validation:

go test ./...
cd frontend && npm run build

Architecture At A Glance

Main entrypoints:

• cmd/kyma-ter/main.go - CLI entry and startup
• internal/server/server.go - HTTP and WebSocket routes, setup flow, session/task APIs
• internal/config/config.go - local config file and defaults
• internal/updater/updater.go - runtime self-update behavior
• frontend/src/App.tsx - main UI shell

Important behavior:

• kyma-ter starts a local server and opens the workspace UI
• the UI can spawn kyma sessions and normal shell sessions
• setup can install @kyma-api/agent if kyma is not present
• runtime updater can download a newer kyma-ter binary in the background

Local Paths

Kyma Ter uses:

• ~/.kyma/ter/bin/kyma-ter
• ~/.kyma/ter/version
• config dir from the OS user config directory, for example:
  • macOS/Linux: ~/.config/kyma-ter/
  • Windows: %AppData%\kyma-ter\

Release Relationship

When releasing a new Kyma Ter build:

1. build new binaries from this repo
2. create or update the GitHub Release in kyma-api/kyma-ter
3. update the pinned kymaTerminal version in kyma-api/packages/kyma-agent/package.json
4. publish @kyma-api/agent
5. sync public docs and READMEs

See:

• scripts/release.sh
• ../kyma-api/docs/PACKAGING-AND-DISTRIBUTION.md

Community

• Contributing: ./CONTRIBUTING.md
• Security: ./SECURITY.md
• Open-source checklist: ./OPEN-SOURCE-CHECKLIST.md

Docs

• Kyma Ter overview: https://docs.kymaapi.com/guides/kyma-ter/overview
• Kyma Ter quickstart: https://docs.kymaapi.com/guides/kyma-ter/quickstart
• Kyma Ter + Kyma Agent: https://docs.kymaapi.com/guides/kyma-ter/kyma-integration
• Windows setup: https://docs.kymaapi.com/guides/windows-setup

Notes

This repo is the runtime source of truth for Kyma Ter behavior. Public docs should be derived from this codebase, not the other way around.