> ## 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 Quickstart

> Install Kyma Agent, launch Kyma Ter, complete setup, and open your first Kyma Agent and shell panes.

## Step 1: Install The Package

Kyma Ter is distributed through the same package as Kyma Agent:

```bash theme={null}
# Recommended
curl -fsSL https://kymaapi.com/install.sh | bash

# Or with npm
npm install -g @kyma-api/agent
```

This installs:

* `kyma`
* `kyma-ter`

<Tip>
  The install step also downloads the local `kyma-ter` binary for your platform.
</Tip>

<Tip>
  Public release assets for `kyma-ter`, including Windows binaries, are published in [`kyma-api/kyma-ter` releases](https://github.com/kyma-api/kyma-ter/releases).
</Tip>

## Step 2: Launch Kyma Ter

```bash theme={null}
kyma-ter
```

Kyma Ter starts a local server and opens the workspace UI in your browser.

By default it runs on localhost port `18800`.

## Windows Notes

On Windows:

* use `kyma` natively in PowerShell or Windows Terminal
* use `kyma-ter` as a Windows beta workflow
* install WSL2 if you want the best shell-pane experience inside the workspace
* use [Windows Setup](/guides/windows-setup) if you want the shortest copy-paste flow

## 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:

1. installing `@kyma-api/agent` if `kyma` is missing
2. signing in with your Kyma account
3. 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:

```bash theme={null}
# 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:

```bash theme={null}
# Recommended
curl -fsSL https://kymaapi.com/install.sh | bash

# Or with npm
npm install -g @kyma-api/agent
```

### Windows shell panes feel limited

That usually means WSL2 is not installed or not available.

Recommended path on Windows:

1. install WSL2
2. reopen `kyma-ter`
3. use shell panes through the default WSL distribution

`kyma` itself can still run natively on Windows even if WSL2 is not installed.

### 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.

### Port 18800 is already in use

If another app on your machine is already listening on `18800` (some audio drivers, plugin hosts, or game servers use this port), Kyma Ter refuses to start with:

```
Error: port 18800 is in use by another process.
Quit it first, or start kyma-ter on a different port with --port
```

Find which app is holding the port:

```bash theme={null}
# macOS / Linux
lsof -i :18800

# Windows (PowerShell)
Get-NetTCPConnection -LocalPort 18800
```

Run Kyma Ter on a different port once:

```bash theme={null}
kyma-ter serve --port 18801
```

Or change the default port permanently by editing the config file:

* **macOS**: `~/Library/Application Support/kyma-ter/config.json`
* **Linux**: `~/.config/kyma-ter/config.json`
* **Windows**: `%AppData%\kyma-ter\config.json`

```json theme={null}
{ "port": 18801 }
```

Kyma Ter 0.1.11 and later also detects when another Kyma Ter is already running on the port and opens the dashboard in your browser instead of erroring out, so you don't need to do anything special when upgrading.

## Next Steps

* [Kyma Ter Overview](/guides/kyma-ter/overview)
* [Kyma Ter + Kyma Agent](/guides/kyma-ter/kyma-integration)
* [Kyma Agent](/guides/agent)
* [Windows Setup](/guides/windows-setup)