Step 1: Install The Package
Kyma Ter is distributed through the same package as Kyma Agent:
# Recommended
curl -fsSL https://kymaapi.com/install.sh | bash
# Or with npm
npm install -g @kyma-api/agent
The install step also downloads the local kyma-ter binary for your platform.
Step 2: Launch Kyma Ter
Kyma Ter starts a local server and opens the workspace UI in your browser.
By default it runs on localhost port 18800.
Step 3: Complete Setup
On first run, Kyma Ter checks whether Kyma Agent is installed and whether your account is ready.
If setup is incomplete, the built-in flow will guide you through:
- installing
@kyma-api/agent if kyma is missing
- signing in with your Kyma account
- or saving a Kyma API key directly
The normal sign-in path opens your browser and uses device-flow style login.
Step 4: Open Your First Panes
Once setup is ready, create:
- a
Kyma Agent pane to run kyma
- a
Shell pane for regular terminal commands
This is the fastest way to understand the workspace model:
- use the agent pane for planning, coding, or explanation
- use the shell pane for git, tests, logs, and manual commands
Step 5: Learn The Core Shortcuts
Default shortcuts include:
| Shortcut | Action |
|---|
Ctrl+K | New Kyma Agent |
Ctrl+N | New terminal |
Ctrl+W | Close pane |
Ctrl+T | New workspace |
Ctrl+A | Open Agent Workspace |
Ctrl+, | Open settings |
Install Troubleshooting
kyma-ter command not found
Reinstall:
# Recommended
curl -fsSL https://kymaapi.com/install.sh | bash
# Or with npm
npm install -g @kyma-api/agent
Kyma Ter opens but asks to install Kyma Agent
That means the local setup check cannot find kyma in your PATH.
Use the setup flow in the UI, or install manually:
# Recommended
curl -fsSL https://kymaapi.com/install.sh | bash
# Or with npm
npm install -g @kyma-api/agent
Want to use an API key instead of login
The setup flow includes an advanced option to paste and save your Kyma API key directly.
Next Steps
