# 📖 Setup Guide — OmniRoute (ਪੰਜਾਬੀ)

🌐 **Languages:** 🇺🇸 [English](../../../../guides/SETUP_GUIDE.md) · 🇪🇹 [am](../../../am/docs/guides/SETUP_GUIDE.md) · 🇸🇦 [ar](../../../ar/docs/guides/SETUP_GUIDE.md) · 🇦🇿 [az](../../../az/docs/guides/SETUP_GUIDE.md) · 🇧🇬 [bg](../../../bg/docs/guides/SETUP_GUIDE.md) · 🇧🇩 [bn](../../../bn/docs/guides/SETUP_GUIDE.md) · 🇧🇦 [bs](../../../bs/docs/guides/SETUP_GUIDE.md) · 🇨🇿 [cs](../../../cs/docs/guides/SETUP_GUIDE.md) · 🇩🇰 [da](../../../da/docs/guides/SETUP_GUIDE.md) · 🇩🇪 [de](../../../de/docs/guides/SETUP_GUIDE.md) · 🇬🇷 [el](../../../el/docs/guides/SETUP_GUIDE.md) · 🇪🇸 [es](../../../es/docs/guides/SETUP_GUIDE.md) · 🇪🇪 [et](../../../et/docs/guides/SETUP_GUIDE.md) · 🇮🇷 [fa](../../../fa/docs/guides/SETUP_GUIDE.md) · 🇫🇮 [fi](../../../fi/docs/guides/SETUP_GUIDE.md) · 🇫🇷 [fr](../../../fr/docs/guides/SETUP_GUIDE.md) · 🇮🇪 [ga](../../../ga/docs/guides/SETUP_GUIDE.md) · 🇮🇳 [gu](../../../gu/docs/guides/SETUP_GUIDE.md) · 🇳🇬 [ha](../../../ha/docs/guides/SETUP_GUIDE.md) · 🇮🇱 [he](../../../he/docs/guides/SETUP_GUIDE.md) · 🇮🇳 [hi](../../../hi/docs/guides/SETUP_GUIDE.md) · 🇭🇷 [hr](../../../hr/docs/guides/SETUP_GUIDE.md) · 🇭🇺 [hu](../../../hu/docs/guides/SETUP_GUIDE.md) · 🇦🇲 [hy](../../../hy/docs/guides/SETUP_GUIDE.md) · 🇮🇩 [id](../../../id/docs/guides/SETUP_GUIDE.md) · 🇳🇬 [ig](../../../ig/docs/guides/SETUP_GUIDE.md) · 🇮🇹 [it](../../../it/docs/guides/SETUP_GUIDE.md) · 🇯🇵 [ja](../../../ja/docs/guides/SETUP_GUIDE.md) · 🇬🇪 [ka](../../../ka/docs/guides/SETUP_GUIDE.md) · 🇰🇭 [km](../../../km/docs/guides/SETUP_GUIDE.md) · 🇮🇳 [kn](../../../kn/docs/guides/SETUP_GUIDE.md) · 🇰🇷 [ko](../../../ko/docs/guides/SETUP_GUIDE.md) · 🇱🇹 [lt](../../../lt/docs/guides/SETUP_GUIDE.md) · 🇱🇻 [lv](../../../lv/docs/guides/SETUP_GUIDE.md) · 🇮🇳 [ml](../../../ml/docs/guides/SETUP_GUIDE.md) · 🇮🇳 [mr](../../../mr/docs/guides/SETUP_GUIDE.md) · 🇲🇾 [ms](../../../ms/docs/guides/SETUP_GUIDE.md) · 🇲🇹 [mt](../../../mt/docs/guides/SETUP_GUIDE.md) · 🇲🇲 [my](../../../my/docs/guides/SETUP_GUIDE.md) · 🇳🇵 [ne](../../../ne/docs/guides/SETUP_GUIDE.md) · 🇳🇱 [nl](../../../nl/docs/guides/SETUP_GUIDE.md) · 🇳🇴 [no](../../../no/docs/guides/SETUP_GUIDE.md) · 🇮🇳 [or](../../../or/docs/guides/SETUP_GUIDE.md) · 🇵🇭 [phi](../../../phi/docs/guides/SETUP_GUIDE.md) · 🇵🇱 [pl](../../../pl/docs/guides/SETUP_GUIDE.md) · 🇵🇹 [pt](../../../pt/docs/guides/SETUP_GUIDE.md) · 🇧🇷 [pt-BR](../../../pt-BR/docs/guides/SETUP_GUIDE.md) · 🇷🇴 [ro](../../../ro/docs/guides/SETUP_GUIDE.md) · 🇷🇺 [ru](../../../ru/docs/guides/SETUP_GUIDE.md) · 🇱🇰 [si](../../../si/docs/guides/SETUP_GUIDE.md) · 🇸🇰 [sk](../../../sk/docs/guides/SETUP_GUIDE.md) · 🇸🇮 [sl](../../../sl/docs/guides/SETUP_GUIDE.md) · 🇷🇸 [sr](../../../sr/docs/guides/SETUP_GUIDE.md) · 🇸🇪 [sv](../../../sv/docs/guides/SETUP_GUIDE.md) · 🇰🇪 [sw](../../../sw/docs/guides/SETUP_GUIDE.md) · 🇮🇳 [ta](../../../ta/docs/guides/SETUP_GUIDE.md) · 🇮🇳 [te](../../../te/docs/guides/SETUP_GUIDE.md) · 🇹🇭 [th](../../../th/docs/guides/SETUP_GUIDE.md) · 🇹🇷 [tr](../../../tr/docs/guides/SETUP_GUIDE.md) · 🇺🇦 [uk-UA](../../../uk-UA/docs/guides/SETUP_GUIDE.md) · 🇵🇰 [ur](../../../ur/docs/guides/SETUP_GUIDE.md) · 🇺🇿 [uz](../../../uz/docs/guides/SETUP_GUIDE.md) · 🇻🇳 [vi](../../../vi/docs/guides/SETUP_GUIDE.md) · 🇳🇬 [yo](../../../yo/docs/guides/SETUP_GUIDE.md) · 🇨🇳 [zh-CN](../../../zh-CN/docs/guides/SETUP_GUIDE.md) · 🇹🇼 [zh-TW](../../../zh-TW/docs/guides/SETUP_GUIDE.md)

---

> OmniRoute ਲਈ ਪੂਰਾ ਸੈੱਟਅੱਪ ਹਵਾਲਾ। ਤੁਰੰਤ ਵਰਜਨ ਲਈ, [README ਵਿੱਚ ਤੁਰੰਤ ਸ਼ੁਰੂਆਤ](../README.md#-quick-start) ਵੇਖੋ।

## ਵਿਸ਼ਾ-ਸੂਚੀ

- [ਇੰਸਟਾਲੇਸ਼ਨ ਵਿਧੀਆਂ](#install-methods)
- [CLI ਟੂਲ ਸੰਰਚਨਾ](#cli-tool-configuration)
- [ਪ੍ਰੋਟੋਕੋਲ ਸੈੱਟਅੱਪ (MCP + A2A)](#protocol-setup-mcp--a2a)
- [ਟਾਈਮਆਉਟ ਸੰਰਚਨਾ](#timeout-configuration)
- [ਸਪਲਿਟ-ਪੋਰਟ ਮੋਡ](#split-port-mode)
- [Void Linux (xbps-src)](#void-linux-xbps-src-template)
- [ਅਣਇੰਸਟਾਲ ਕਰਨਾ](#uninstalling)

---

## ਇੰਸਟਾਲੇਸ਼ਨ ਵਿਧੀਆਂ

### npm (ਸਿਫ਼ਾਰਸ਼ੀ)

```bash
npm install -g omniroute
omniroute
```

ਡੈਸ਼ਬੋਰਡ `http://localhost:20128` 'ਤੇ ਖੁੱਲ੍ਹਦਾ ਹੈ ਅਤੇ API ਦਾ ਬੇਸ URL `http://localhost:20128/v1` ਹੈ।

### pnpm

```bash
pnpm add -g omniroute@latest --allow-build=better-sqlite3 --allow-build=@swc/core
omniroute
```

> **pnpm ਵਰਤੋਂਕਾਰ:** `better-sqlite3` ਅਤੇ `@swc/core` ਲਈ ਨੇਟਿਵ ਬਿਲਡ ਸਕ੍ਰਿਪਟਾਂ ਸਮਰੱਥ ਕਰਨ ਵਾਸਤੇ `--allow-build` ਫਲੈਗ ਲਾਜ਼ਮੀ ਹੈ। pnpm v11 ਵਿੱਚ ਗਲੋਬਲ ਇੰਸਟਾਲੇਸ਼ਨਾਂ ਲਈ `pnpm approve-builds -g` ਕਮਾਂਡ ਸਮਰਥਿਤ ਨਹੀਂ ਹੈ।

### Arch Linux (AUR)

```bash
yay -S omniroute-bin
systemctl --user enable --now omniroute.service
```

[AUR ਪੈਕੇਜ](https://aur.archlinux.org/packages/omniroute-bin) OmniRoute ਨੂੰ ਇੰਸਟਾਲ ਕਰਦਾ ਹੈ ਅਤੇ ਇੱਕ systemd ਵਰਤੋਂਕਾਰ ਸੇਵਾ ਪ੍ਰਦਾਨ ਕਰਦਾ ਹੈ।

### ਸਰੋਤ ਤੋਂ

```bash
npm install
PORT=20128 DASHBOARD_PORT=20129 NEXT_PUBLIC_BASE_URL=http://localhost:20129 npm run dev
```

> **Windows ਨੋਟ:** ਮੂਲ ਰੂਪ ਵਿੱਚ, ਜਦੋਂ ਪੁਰਾਣੀ `%USERPROFILE%\.omniroute` ਡਾਇਰੈਕਟਰੀ ਮੌਜੂਦ ਨਹੀਂ ਹੁੰਦੀ, ਤਾਂ OmniRoute `%APPDATA%\omniroute` ਦੀ ਵਰਤੋਂ ਕਰਦਾ ਹੈ। ਡਾਟਾ ਡਾਇਰੈਕਟਰੀ ਲਈ ਕੋਈ ਵੱਖਰਾ ਟਿਕਾਣਾ ਚੁਣਨ ਵਾਸਤੇ `DATA_DIR` ਸੈੱਟ ਕਰੋ।

> **ਨੋਟ:** ਪਹਿਲੀ ਵਾਰ ਚਲਾਉਣ ਵੇਲੇ `npm install`, `.env.example` ਤੋਂ ਆਪਣੇ ਆਪ `.env` ਤਿਆਰ ਕਰਦਾ ਹੈ। ਬਾਅਦ ਦੀਆਂ ਇੰਸਟਾਲੇਸ਼ਨਾਂ ਮੌਜੂਦਾ `.env` ਨੂੰ ਓਵਰਰਾਈਟ ਨਹੀਂ ਕਰਨਗੀਆਂ, ਇਸ ਲਈ ਕਸਟਮਾਈਜ਼ੇਸ਼ਨਾਂ ਸੁਰੱਖਿਅਤ ਰਹਿੰਦੀਆਂ ਹਨ। ਮੁੜ ਸ਼ੁਰੂਆਤੀ ਮੁੱਲ ਭਰਨ ਲਈ, ਦੁਬਾਰਾ ਚਲਾਉਣ ਤੋਂ ਪਹਿਲਾਂ `.env` ਮਿਟਾਓ।

### Docker

Compose ਪ੍ਰੋਫਾਈਲਾਂ ਅਤੇ Caddy HTTPS ਸਮੇਤ Docker ਦੇ ਪੂਰੇ ਸੈੱਟਅੱਪ ਲਈ [Docker ਗਾਈਡ](./DOCKER_GUIDE.md) ਵੇਖੋ।

### ਡੈਸਕਟਾਪ ਐਪ (Electron)

OmniRoute ਨਾਲ Electron 41 + electron-builder 26.10 'ਤੇ ਬਣਿਆ ਇੱਕ ਡੈਸਕਟਾਪ ਰੈਪਰ ਮਿਲਦਾ ਹੈ। ਉਪਲਬਧ ਸਕ੍ਰਿਪਟਾਂ (ਵਰਕਸਪੇਸ ਰੂਟ):

```bash
npm run electron:dev          # ਹਾਟ-ਰੀਲੋਡ ਨਾਲ ਡੈਸਕਟਾਪ ਚਲਾਓ
npm run electron:build        # ਮੌਜੂਦਾ OS ਲਈ ਬਿਲਡ ਕਰੋ (ਆਪਣੇ ਆਪ ਪਛਾਣਿਆ ਜਾਂਦਾ ਹੈ)
npm run electron:build:win    # Windows ਇੰਸਟਾਲਰ (NSIS + ਪੋਰਟੇਬਲ)
npm run electron:build:mac    # macOS (dmg + zip, arm64+x64)
npm run electron:build:linux  # Linux (AppImage + deb + rpm)
npm run electron:smoke:packaged  # ਪੈਕੇਜ ਕੀਤੇ ਬਿਲਡ ਦਾ ਸਮੋਕ ਟੈਸਟ ਕਰੋ
```

ਡੈਸਕਟਾਪ ਇੰਸਟਾਲਰਾਂ ਦੀਆਂ ਰਿਲੀਜ਼ਾਂ GitHub Releases ਨਾਲ ਨੱਥੀ ਕੀਤੀਆਂ ਜਾਂਦੀਆਂ ਹਨ। Electron ਬਾਰੇ ਪੂਰੀ ਡੂੰਘੀ ਜਾਣਕਾਰੀ (ਸਾਈਨਿੰਗ, IPC ਬ੍ਰਿਜ, ਡਿਸਟ੍ਰੋਜ਼) ਲਈ, [`ELECTRON_GUIDE.md`](./ELECTRON_GUIDE.md) ਵੇਖੋ _(ਬਾਅਦਲੇ ਪੜਾਅ ਵਿੱਚ ਬਣਾਇਆ ਗਿਆ)_।

### ਹੈੱਡਲੈੱਸ ਸਰਵਰ (CI/ਆਟੋਮੇਸ਼ਨ)

ਬਿਨਾਂ ਨਿਗਰਾਨੀ ਵਾਲੇ ਸੈੱਟਅੱਪਾਂ (Docker, Kubernetes, CI) ਲਈ, ਇਹ ਵਰਤੋ:

```bash
omniroute setup --non-interactive
omniroute providers test-batch
```

env vars (`INITIAL_PASSWORD`, `OMNIROUTE_WS_BRIDGE_SECRET`, ਆਦਿ) ਨਾਲ ਮਿਲਾ ਕੇ, ਇਹ ਤੁਹਾਨੂੰ ਪੂਰੀ ਤਰ੍ਹਾਂ ਸਕ੍ਰਿਪਟ-ਯੋਗ OmniRoute ਇੰਸਟੈਂਸ ਚਾਲੂ ਕਰਨ ਦਿੰਦਾ ਹੈ।

### CLI ਵਿਕਲਪ

| ਕਮਾਂਡ                   | ਵੇਰਵਾ                                                                              |
| ----------------------- | ---------------------------------------------------------------------------------- |
| `omniroute`             | ਸਰਵਰ ਸ਼ੁਰੂ ਕਰੋ (`PORT=20128`, API ਅਤੇ ਡੈਸ਼ਬੋਰਡ ਇੱਕੋ ਪੋਰਟ 'ਤੇ)                      |
| `omniroute setup`       | ਪਾਸਵਰਡ ਅਤੇ ਪਹਿਲੇ ਪ੍ਰਦਾਤਾ ਲਈ ਮਾਰਗਦਰਸ਼ਿਤ CLI ਆਨਬੋਰਡਿੰਗ                               |
| `omniroute doctor`      | ਸਰਵਰ ਸ਼ੁਰੂ ਕੀਤੇ ਬਿਨਾਂ ਸਥਾਨਕ ਸਿਹਤ ਜਾਂਚਾਂ ਚਲਾਓ                                       |
| `omniroute providers`   | CLI ਤੋਂ ਪ੍ਰਦਾਤਾਵਾਂ ਨੂੰ ਖੋਜੋ, ਸੂਚੀਬੱਧ ਕਰੋ, ਪ੍ਰਮਾਣਿਤ ਕਰੋ ਅਤੇ ਜਾਂਚੋ                   |
| `omniroute config`      | CLI ਟੂਲ ਸੰਰਚਨਾ — ਕੌਂਫਿਗ ਸੂਚੀਬੱਧ ਕਰੋ, ਲਵੋ, ਸੈੱਟ ਕਰੋ, ਪ੍ਰਮਾਣਿਤ ਕਰੋ                   |
| `omniroute status`      | ਆਫ਼ਲਾਈਨ ਸਥਿਤੀ ਡੈਸ਼ਬੋਰਡ — ਵਰਜਨ, DB, ਟੂਲ, ਕੌਂਫਿਗ                                     |
| `omniroute logs`        | API ਤੋਂ ਵਰਤੋਂ ਲੌਗ ਸਟ੍ਰੀਮ ਕਰੋ (`--follow` ਸਮਰਥਿਤ ਹੈ)                                |
| `omniroute update`      | OmniRoute ਅੱਪਡੇਟਾਂ ਦੀ ਜਾਂਚ ਕਰੋ ਜਾਂ ਲਾਗੂ ਕਰੋ                                        |
| `omniroute provider`    | ਪ੍ਰਦਾਤਾ ਕਨੈਕਸ਼ਨਾਂ ਦਾ ਪ੍ਰਬੰਧਨ ਕਰੋ — ਜੋੜੋ, ਸੂਚੀਬੱਧ ਕਰੋ, ਹਟਾਓ, ਜਾਂਚੋ, ਡਿਫੌਲਟ ਸੈੱਟ ਕਰੋ |
| `omniroute --port 3000` | ਕੈਨੋਨਿਕਲ/API ਪੋਰਟ ਨੂੰ 3000 'ਤੇ ਸੈੱਟ ਕਰੋ                                            |
| `omniroute --mcp`       | MCP ਸਰਵਰ ਸ਼ੁਰੂ ਕਰੋ (stdio ਟ੍ਰਾਂਸਪੋਰਟ)                                              |
| `omniroute --no-open`   | ਬ੍ਰਾਊਜ਼ਰ ਆਪਣੇ ਆਪ ਨਾ ਖੋਲ੍ਹੋ                                                         |
| `omniroute --help`      | ਮਦਦ ਦਿਖਾਓ                                                                          |

ਹੈੱਡਲੈੱਸ ਸੈੱਟਅੱਪ ਨੂੰ ਫਲੈਗਾਂ ਜਾਂ ਵਾਤਾਵਰਣ ਵੇਰੀਏਬਲਾਂ ਨਾਲ ਸਕ੍ਰਿਪਟ ਕੀਤਾ ਜਾ ਸਕਦਾ ਹੈ:

```bash
omniroute setup --non-interactive --password "$OMNIROUTE_PASSWORD"
omniroute setup --non-interactive --add-provider --provider openai --api-key "$OPENAI_API_KEY"
omniroute setup --non-interactive --add-provider --provider openai --api-key "$OPENAI_API_KEY" --test-provider
```

ਡੈਸ਼ਬੋਰਡ ਖੋਲ੍ਹੇ ਬਿਨਾਂ ਸਥਾਨਕ ਡਾਇਗਨੋਸਟਿਕ ਚਲਾਓ:

```bash
omniroute doctor
omniroute doctor --json
omniroute doctor --no-liveness
```

ਡੈਸ਼ਬੋਰਡ ਖੋਲ੍ਹੇ ਬਿਨਾਂ SSH ਜਾਂ ਸਕ੍ਰਿਪਟਾਂ ਤੋਂ ਪ੍ਰਦਾਤਾਵਾਂ ਦਾ ਪ੍ਰਬੰਧਨ ਕਰੋ:

```bash
omniroute providers available
omniroute providers available --search openai
omniroute providers available --category api-key
omniroute providers list
omniroute providers test <id-or-name>
omniroute providers test-all
omniroute providers validate
```

---

## CLI ਟੂਲ ਸੰਰਚਨਾ

### 1) ਪ੍ਰਦਾਤਾਵਾਂ ਨੂੰ ਕਨੈਕਟ ਕਰੋ ਅਤੇ API ਕੁੰਜੀ ਬਣਾਓ

1. Dashboard → `Providers` ਖੋਲ੍ਹੋ ਅਤੇ ਘੱਟੋ-ਘੱਟ ਇੱਕ ਪ੍ਰਦਾਤਾ (OAuth ਜਾਂ API ਕੁੰਜੀ) ਕਨੈਕਟ ਕਰੋ।
2. Dashboard → `Endpoints` ਖੋਲ੍ਹੋ ਅਤੇ ਇੱਕ API ਕੁੰਜੀ ਬਣਾਓ।
3. (ਵਿਕਲਪਿਕ) Dashboard → `Combos` ਖੋਲ੍ਹੋ ਅਤੇ ਆਪਣੀ ਫਾਲਬੈਕ ਲੜੀ ਸੈੱਟ ਕਰੋ।

### 2) ਆਪਣੇ ਕੋਡਿੰਗ ਟੂਲ ਨੂੰ ਨਿਰਧਾਰਤ ਕਰੋ

```txt
ਬੇਸ URL: http://localhost:20128/v1
API ਕੁੰਜੀ:  [Endpoint ਪੰਨੇ ਤੋਂ ਕਾਪੀ ਕਰੋ]
ਮਾਡਲ:    if/qwen3.8-max-preview (ਜਾਂ ਕੋਈ ਵੀ ਪ੍ਰਦਾਤਾ/ਮਾਡਲ ਪ੍ਰੀਫਿਕਸ)
```

ਜੇ ਤੁਹਾਡਾ ਐਡੀਟਰ `Authorization: Bearer ...` ਨਹੀਂ ਭੇਜ ਸਕਦਾ, ਤਾਂ ਇਸਦੀ ਬਜਾਏ ਟੋਕਨ-ਯੁਕਤ ਅਨੁਕੂਲਤਾ ਬੇਸ ਦੀ ਵਰਤੋਂ ਕਰੋ:

```txt
ਬੇਸ URL: http://localhost:20128/api/v1/vscode/YOUR_KEY/
ਮਾਡਲ URL: http://localhost:20128/api/v1/vscode/YOUR_KEY/models
ਚੈਟ URL: http://localhost:20128/api/v1/vscode/YOUR_KEY/chat/completions
Ollama ਟੈਗ URL: http://localhost:20128/api/v1/vscode/YOUR_KEY/api/tags
```

Claude Code, Codex CLI, Cursor, Cline, OpenClaw, OpenCode ਅਤੇ OpenAI-ਅਨੁਕੂਲ SDKs ਨਾਲ ਕੰਮ ਕਰਦਾ ਹੈ।

#### `setup-*` ਨਾਲ ਸਵੈਚਾਲਿਤ ਸੰਰਚਨਾ

ਬੇਸ URL ਅਤੇ ਕੁੰਜੀ ਨੂੰ ਹੱਥੀਂ ਪੇਸਟ ਕਰਨ ਦੀ ਬਜਾਏ, OmniRoute ਨੂੰ ਲਾਈਵ ਮਾਡਲ ਕੈਟਾਲਾਗ ਤੋਂ ਹਰ ਟੂਲ ਦੀ
ਆਪਣੀ ਸੰਰਚਨਾ ਲਿਖਣ ਦਿਓ। ਪ੍ਰਤੀ ਟੂਲ ਇੱਕ ਕਮਾਂਡ:

```bash
omniroute setup-codex        # ~/.codex/<name>.config.toml ਪ੍ਰੋਫਾਈਲਾਂ
omniroute setup-claude       # ~/.claude/profiles/<name>/settings.json
omniroute setup-opencode     # ~/.config/opencode/opencode.json (openai-ਅਨੁਕੂਲ)
omniroute setup-cline        # Cline CLI + VS Code ਐਕਸਟੈਂਸ਼ਨ ਸੈਟਿੰਗਾਂ
omniroute setup-kilo         # Kilo Code
omniroute setup-continue     # ~/.continue/config.yaml (Continue / cn)
omniroute setup-cursor       # Cursor ਦੇ ਇਨ-ਐਪ ਕਦਮ ਪ੍ਰਿੰਟ ਕਰਦਾ ਹੈ
omniroute setup-roo          # Roo Code ਇੰਪੋਰਟ + autoImport ਪੁਆਇੰਟਰ
omniroute setup-crush        # ~/.config/crush/crush.json
omniroute setup-goose        # ~/.config/goose/config.yaml
omniroute setup-aider        # ~/.aider.conf.yml
omniroute setup-qwen         # ~/.qwen/settings.json + ~/.qwen/.env
```

ਹਰੇਕ ਇੱਕ ਸਥਾਨਕ ਟੂਲ ਨੂੰ ਇੱਕ **ਰਿਮੋਟ** OmniRoute ਦੇ ਵਿਰੁੱਧ ਸੰਰਚਿਤ ਕਰਨ ਲਈ `--remote <url> --api-key <key>` ਸਵੀਕਾਰ ਕਰਦਾ ਹੈ,
ਅਤੇ ਨਾਲ ਹੀ ਝਲਕ ਦੇਖਣ ਲਈ `--dry-run` ਵੀ। ਸਹੀ env ਇੰਜੈਕਟ ਕਰਕੇ ਅਤੇ ਕੋਈ ਵੀ ਸੰਰਚਨਾ ਲਿਖੇ ਬਿਨਾਂ CLI ਲਾਂਚ ਕਰਨ ਲਈ,
ਆਮ ਲਾਂਚਰ `omniroute run <target>` (claude, codex, aider, goose, opencode, qwen, gemini) ਦੀ ਵਰਤੋਂ ਕਰੋ;
ਪੁਰਾਣੇ ਪ੍ਰਤੀ-ਟੂਲ ਲਾਂਚਰ `omniroute launch` (Claude Code) ਅਤੇ
`omniroute launch-codex` (Codex) ਉਪਲਬਧ ਰਹਿੰਦੇ ਹਨ।

ਪੂਰੀ ਸਾਰਣੀ (ਹਰ ਕਮਾਂਡ ਕੀ ਲਿਖਦੀ ਹੈ, ਹਰ ਫਲੈਗ, ਸਥਾਨਕ ਬਨਾਮ ਰਿਮੋਟ, ਬੇਸ-URL
`/v1` ਰਵਾਇਤਾਂ) ਲਈ, **[CLI ਇੰਟੀਗ੍ਰੇਸ਼ਨ](./CLI-INTEGRATIONS.md)** ਵੇਖੋ।

ਵਿਸਤ੍ਰਿਤ ਪ੍ਰਤੀ-ਟੂਲ ਸੰਰਚਨਾ (Claude Code, Codex CLI, Cursor, Cline, OpenClaw, Kilo Code, Copilot ਅਤੇ ਹੋਰ) ਲਈ, ਸਮਰਪਿਤ **[CLI ਟੂਲ ਗਾਈਡ](../reference/CLI-TOOLS.md)** ਵੇਖੋ।

---

## ਪ੍ਰੋਟੋਕੋਲ ਸੈੱਟਅੱਪ (MCP + A2A)

### MCP ਸੈੱਟਅੱਪ (ਮਾਡਲ ਕਾਂਟੈਕਸਟ ਪ੍ਰੋਟੋਕੋਲ)

MCP ਟ੍ਰਾਂਸਪੋਰਟ ਨੂੰ stdio ਮੋਡ ਵਿੱਚ ਸ਼ੁਰੂ ਕਰੋ:

```bash
omniroute --mcp
```

ਸਿਫਾਰਸ਼ੀ ਪ੍ਰਮਾਣੀਕਰਨ ਪ੍ਰਵਾਹ:

```bash
# 1. MCP ਸਰਵਰ ਸ਼ੁਰੂ ਕਰੋ
omniroute --mcp

# 2. ਆਪਣੇ MCP ਕਲਾਇੰਟ ਤੋਂ, ਕਾਲ ਕਰੋ:
omniroute_get_health        # ਸਿਸਟਮ ਦੀ ਸਿਹਤ ਵਾਪਸ ਕਰਨੀ ਚਾਹੀਦੀ ਹੈ
omniroute_list_combos       # ਸਰਗਰਮ ਕਾਂਬੋ ਵਾਪਸ ਕਰਨੇ ਚਾਹੀਦੇ ਹਨ

# 3. ਜਾਂ ਪੂਰਾ E2E ਸੂਟ ਚਲਾਓ:
npm run test:protocols:e2e
```

#### MCP ਕਲਾਇੰਟ ਸੰਰਚਨਾ

**Claude Code:**

```bash
claude mcp add-server omniroute --type http --url http://localhost:20128/api/mcp/stream
```

**Cursor / Cline:**

ਆਪਣੀਆਂ MCP ਸੈਟਿੰਗਾਂ ਵਿੱਚ ਸ਼ਾਮਲ ਕਰੋ:

```json
{
  "mcpServers": {
    "omniroute": {
      "command": "omniroute",
      "args": ["--mcp"],
      "env": {}
    }
  }
}
```

**ਪੂਰਾ MCP ਦਸਤਾਵੇਜ਼ੀਕਰਨ:** [MCP ਸਰਵਰ README](../../open-sse/mcp-server/README.md) — 110 ਟੂਲ, IDE ਸੰਰਚਨਾਵਾਂ, Python/TS/Go ਕਲਾਇੰਟ।

### A2A ਸੈੱਟਅੱਪ (ਏਜੰਟ-ਤੋਂ-ਏਜੰਟ ਪ੍ਰੋਟੋਕੋਲ)

Agent Card ਦੀ ਪੁਸ਼ਟੀ ਕਰੋ:

```bash
curl http://localhost:20128/.well-known/agent.json
```

ਇੱਕ ਟਾਸਕ ਭੇਜੋ:

```bash
curl -X POST http://localhost:20128/a2a \
  -H 'content-type: application/json' \
  -d '{"jsonrpc":"2.0","id":"quickstart","method":"message/send","params":{"skill":"quota-management","messages":[{"role":"user","content":"Give me a short quota summary."}]}}'
```

**ਪੂਰਾ A2A ਦਸਤਾਵੇਜ਼ੀਕਰਨ:** [A2A ਸਰਵਰ README](../../src/lib/a2a/README.md) — JSON-RPC 2.0, ਹੁਨਰ, ਸਟ੍ਰੀਮਿੰਗ, ਟਾਸਕ ਜੀਵਨ-ਚੱਕਰ।

---

## ਟਾਈਮਆਉਟ ਸੰਰਚਨਾ

### ਬੁਨਿਆਦੀ ਟਾਈਮਆਉਟ

ਜ਼ਿਆਦਾਤਰ ਡਿਪਲੌਇਮੈਂਟਾਂ ਲਈ, ਤੁਹਾਨੂੰ ਸਿਰਫ਼ ਇਹਨਾਂ ਦੋ ਵੇਰੀਏਬਲਾਂ ਦੀ ਲੋੜ ਹੁੰਦੀ ਹੈ:

| ਵੇਰੀਏਬਲ                  | ਡਿਫੌਲਟ                          | ਉਦੇਸ਼                                                                                                                                        |
| ------------------------ | ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| `REQUEST_TIMEOUT_MS`     | `600000`                        | ਅੱਪਸਟ੍ਰੀਮ ਜਵਾਬ ਸ਼ੁਰੂ ਹੋਣ ਦੇ ਟਾਈਮਆਉਟ, ਲੁਕਵੇਂ Undici ਟਾਈਮਆਉਟਾਂ, TLS ਫਿੰਗਰਪ੍ਰਿੰਟ ਬੇਨਤੀਆਂ ਅਤੇ API ਬ੍ਰਿਜ ਬੇਨਤੀ/ਪ੍ਰੌਕਸੀ ਟਾਈਮਆਉਟਾਂ ਲਈ ਸਾਂਝੀ ਬੇਸਲਾਈਨ |
| `STREAM_IDLE_TIMEOUT_MS` | `REQUEST_TIMEOUT_MS` ਤੋਂ ਪ੍ਰਾਪਤ | OmniRoute ਵੱਲੋਂ SSE ਸਟ੍ਰੀਮ ਨੂੰ ਰੋਕਣ ਤੋਂ ਪਹਿਲਾਂ ਸਟ੍ਰੀਮਿੰਗ ਚੰਕਾਂ ਵਿਚਕਾਰ ਵੱਧ ਤੋਂ ਵੱਧ ਅੰਤਰਾਲ                                                     |

ਪਿਛਲੀ ਅਨੁਕੂਲਤਾ ਬਰਕਰਾਰ ਰੱਖੀ ਗਈ ਹੈ: ਮੌਜੂਦਾ `FETCH_TIMEOUT_MS`, `API_BRIDGE_PROXY_TIMEOUT_MS`, ਅਤੇ ਹੋਰ ਪ੍ਰਤੀ-ਲੇਅਰ ਟਾਈਮਆਉਟ ਵੇਰੀਏਬਲ ਅਜੇ ਵੀ ਕੰਮ ਕਰਦੇ ਹਨ ਅਤੇ ਸਾਂਝੀ ਬੇਸਲਾਈਨ ਨੂੰ ਓਵਰਰਾਈਡ ਕਰਦੇ ਹਨ।

### ਪ੍ਰਦਾਤਾ-ਵਿਸ਼ੇਸ਼ ਨੋਟਸ

Claude Code-ਅਨੁਕੂਲ ਅੱਪਸਟ੍ਰੀਮਾਂ (`anthropic-compatible-cc-*`) ਲਈ, OmniRoute ਹੱਲ ਕੀਤੇ ਫੈਚ ਟਾਈਮਆਉਟ ਤੋਂ ਆਊਟਬਾਊਂਡ `X-Stainless-Timeout` ਹੈਡਰ ਪ੍ਰਾਪਤ ਕਰਦਾ ਹੈ, ਤਾਂ ਜੋ ਪ੍ਰਦਾਤਾ-ਪਾਸੇ ਦੇ ਰੀਡ ਟਾਈਮਆਉਟ ਤੁਹਾਡੀ env ਸੰਰਚਨਾ ਨਾਲ ਇਕਸਾਰ ਰਹਿਣ।

ਤੀਜੀ-ਧਿਰ Claude Code-ਅਨੁਕੂਲ ਰਿਵਰਸ ਪ੍ਰੌਕਸੀਆਂ ਲਈ, OmniRoute ਡਿਫੌਲਟ `anthropic-beta` ਸੈੱਟ ਨੂੰ ਸੀਮਤ ਰੱਖਦਾ ਹੈ ਅਤੇ ਜਦੋਂ `Client Cache Control` ਨੂੰ `Auto` 'ਤੇ ਛੱਡਿਆ ਜਾਂਦਾ ਹੈ, ਤਾਂ ਸਿਰਫ਼ ਕਲਾਇੰਟ ਵੱਲੋਂ ਦਿੱਤੇ `cache_control` ਮਾਰਕਰ ਹੀ ਅੱਗੇ ਭੇਜਦਾ ਹੈ। ਪ੍ਰਤੀ-ਕਨੈਕਸ਼ਨ "ਰਿਡੈਕਟ-ਥਿੰਕਿੰਗ ਬੀਟਾ ਸਮਰੱਥ ਕਰੋ" ਟੌਗਲ ਨੂੰ ਕੇਵਲ ਉਸ ਵੇਲੇ ਸਮਰੱਥ ਕਰੋ ਜਦੋਂ ਅੱਪਸਟ੍ਰੀਮ ਨੂੰ ਖ਼ਾਸ ਤੌਰ 'ਤੇ ਰਿਡੈਕਟ ਕੀਤੀਆਂ Claude ਥਿੰਕਿੰਗ ਸਟ੍ਰੀਮਾਂ ਦੀ ਲੋੜ ਹੋਵੇ।

### ਉੱਨਤ ਟਾਈਮਆਉਟ ਓਵਰਰਾਈਡ

| ਵੇਰੀਏਬਲ                                  | ਡਿਫੌਲਟ                                       | ਉਦੇਸ਼                                                                      |
| ---------------------------------------- | -------------------------------------------- | -------------------------------------------------------------------------- |
| `FETCH_TIMEOUT_MS`                       | `REQUEST_TIMEOUT_MS` ਤੋਂ ਪ੍ਰਾਪਤ              | ਜਵਾਬ ਦੇ ਹੈਡਰ ਆਉਣ ਤੱਕ ਵਰਤਿਆ ਜਾਣ ਵਾਲਾ ਅੱਪਸਟ੍ਰੀਮ ਜਵਾਬ-ਸ਼ੁਰੂਆਤ ਟਾਈਮਆਉਟ         |
| `FETCH_HEADERS_TIMEOUT_MS`               | `FETCH_TIMEOUT_MS` ਤੋਂ ਪ੍ਰਾਪਤ                | ਅੱਪਸਟ੍ਰੀਮ ਜਵਾਬ ਦੇ ਹੈਡਰ ਪ੍ਰਾਪਤ ਕਰਨ ਲਈ Undici ਦੀ ਸਮਾਂ-ਸੀਮਾ                   |
| `FETCH_BODY_TIMEOUT_MS`                  | `FETCH_TIMEOUT_MS` ਤੋਂ ਪ੍ਰਾਪਤ                | ਅੱਪਸਟ੍ਰੀਮ ਬੌਡੀ ਚੰਕਾਂ ਵਿਚਕਾਰ Undici ਦੀ ਸਮਾਂ-ਸੀਮਾ (`0` ਇਸਨੂੰ ਅਸਮਰੱਥ ਕਰਦਾ ਹੈ) |
| `FETCH_CONNECT_TIMEOUT_MS`               | `30000`                                      | Undici TCP ਕਨੈਕਟ ਟਾਈਮਆਉਟ                                                   |
| `FETCH_KEEPALIVE_TIMEOUT_MS`             | `4000`                                       | Undici ਨਿਸ਼ਕਿਰਿਆ keep-alive ਸਾਕਟ ਟਾਈਮਆਉਟ                                   |
| `TLS_CLIENT_TIMEOUT_MS`                  | `FETCH_TIMEOUT_MS` ਤੋਂ ਪ੍ਰਾਪਤ                | `wreq-js` ਰਾਹੀਂ ਕੀਤੀਆਂ TLS ਫਿੰਗਰਪ੍ਰਿੰਟ ਬੇਨਤੀਆਂ ਲਈ ਟਾਈਮਆਉਟ                  |
| `API_BRIDGE_PROXY_TIMEOUT_MS`            | `REQUEST_TIMEOUT_MS` ਜਾਂ `600000` ਤੋਂ ਪ੍ਰਾਪਤ | API ਪੋਰਟ ਤੋਂ ਡੈਸ਼ਬੋਰਡ ਪੋਰਟ ਵੱਲ `/v1` ਪ੍ਰੌਕਸੀ ਫਾਰਵਰਡਿੰਗ ਲਈ ਟਾਈਮਆਉਟ          |
| `API_BRIDGE_SERVER_REQUEST_TIMEOUT_MS`   | `max(API_BRIDGE_PROXY_TIMEOUT_MS, 300000)`   | API ਬ੍ਰਿਜ ਸਰਵਰ 'ਤੇ ਆਉਣ ਵਾਲੀ ਬੇਨਤੀ ਦਾ ਟਾਈਮਆਉਟ                               |
| `API_BRIDGE_SERVER_HEADERS_TIMEOUT_MS`   | `60000`                                      | API ਬ੍ਰਿਜ ਸਰਵਰ 'ਤੇ ਆਉਣ ਵਾਲੇ ਹੈਡਰ ਦਾ ਟਾਈਮਆਉਟ                                |
| `API_BRIDGE_SERVER_KEEPALIVE_TIMEOUT_MS` | `5000`                                       | API ਬ੍ਰਿਜ ਸਰਵਰ 'ਤੇ keep-alive ਟਾਈਮਆਉਟ                                      |
| `API_BRIDGE_SERVER_SOCKET_TIMEOUT_MS`    | `0`                                          | API ਬ੍ਰਿਜ ਸਰਵਰ 'ਤੇ ਸਾਕਟ ਨਿਸ਼ਕਿਰਿਆਤਾ ਟਾਈਮਆਉਟ (`0` ਇਸਨੂੰ ਅਸਮਰੱਥ ਕਰਦਾ ਹੈ)     |

> **ਨੋਟ:** ਸਟ੍ਰੀਮਿੰਗ ਬੇਨਤੀਆਂ ਲਈ, `FETCH_TIMEOUT_MS` ਸਿਰਫ਼ ਕਨੈਕਸ਼ਨ ਸੈੱਟਅੱਪ / ਪਹਿਲੇ ਅੱਪਸਟ੍ਰੀਮ ਜਵਾਬ ਦੀ ਉਡੀਕ ਨੂੰ ਕਵਰ ਕਰਦਾ ਹੈ। ਸਟ੍ਰੀਮ ਸਰਗਰਮ ਹੋ ਜਾਣ ਤੋਂ ਬਾਅਦ, OmniRoute ਸਿਰਫ਼ ਅਸਲ ਰੁਕਾਵਟ (`STREAM_IDLE_TIMEOUT_MS`) ਜਾਂ Undici ਬੌਡੀ ਨਿਸ਼ਕਿਰਿਆਤਾ (`FETCH_BODY_TIMEOUT_MS`) ਹੋਣ 'ਤੇ ਹੀ ਇਸਨੂੰ ਰੋਕੇਗਾ।

### ਰਿਵਰਸ ਪ੍ਰੌਕਸੀ ਅਨੁਕੂਲਤਾ

ਜੇ ਤੁਸੀਂ OmniRoute ਨੂੰ Nginx, Caddy, Cloudflare, ਜਾਂ ਕਿਸੇ ਹੋਰ ਰਿਵਰਸ ਪ੍ਰੌਕਸੀ ਦੇ ਪਿੱਛੇ ਚਲਾਉਂਦੇ ਹੋ, ਤਾਂ ਯਕੀਨੀ ਬਣਾਓ ਕਿ ਪ੍ਰੌਕਸੀ ਟਾਈਮਆਉਟ ਵੀ ਤੁਹਾਡੇ OmniRoute ਸਟ੍ਰੀਮ/ਫੈਚ ਟਾਈਮਆਉਟਾਂ ਤੋਂ ਵੱਧ ਹੋਣ।

---

## ਵੱਖਰੇ-ਪੋਰਟ ਮੋਡ

ਉੱਨਤ ਸਥਿਤੀਆਂ (ਰਿਵਰਸ ਪ੍ਰੌਕਸੀ, ਕੰਟੇਨਰ ਨੈੱਟਵਰਕਿੰਗ) ਲਈ API ਅਤੇ Dashboard ਨੂੰ ਵੱਖਰੇ ਪੋਰਟਾਂ 'ਤੇ ਚਲਾਓ:

```bash
PORT=20128 DASHBOARD_PORT=20129 omniroute
# API:       http://localhost:20128/v1
# Dashboard: http://localhost:20129
```

---

## Void Linux (`xbps-src`) ਟੈਂਪਲੇਟ

Void Linux ਵਰਤੋਂਕਾਰਾਂ ਲਈ, ਤੁਸੀਂ `xbps-src` ਦੀ ਵਰਤੋਂ ਕਰਕੇ ਇੱਕ ਮੂਲ ਪੈਕੇਜ ਬਣਾ ਸਕਦੇ ਹੋ। ਇਸ ਬਲਾਕ ਨੂੰ `srcpkgs/omniroute/template` ਵਜੋਂ ਸੰਭਾਲੋ:

```bash
# 'omniroute' ਲਈ ਟੈਂਪਲੇਟ ਫ਼ਾਈਲ
pkgname=omniroute
version=3.8.0
revision=1
hostmakedepends="nodejs python3 make"
depends="openssl"
short_desc="Universal AI gateway with smart routing for multiple LLM providers"
maintainer="zenobit <zenobit@disroot.org>"
license="MIT"
homepage="https://github.com/diegosouzapw/OmniRoute"
distfiles="https://github.com/diegosouzapw/OmniRoute/archive/refs/tags/v${version}.tar.gz"
# ਹਰ ਰਿਲੀਜ਼ ਲਈ ਚੈੱਕਸਮ ਨੂੰ ਇਸ ਨਾਲ ਮੁੜ ਤਿਆਰ ਕਰੋ:
#   curl -L -o /tmp/omniroute.tar.gz "https://github.com/diegosouzapw/OmniRoute/archive/refs/tags/v${version}.tar.gz" && sha256sum /tmp/omniroute.tar.gz
checksum=PLACEHOLDER_REGENERATE_PER_RELEASE
system_accounts="_omniroute"
omniroute_homedir="/var/lib/omniroute"
export NODE_ENV=production
export npm_config_engine_strict=false
export npm_config_loglevel=error
export npm_config_fund=false
export npm_config_audit=false

do_build() {
	local _gyp_arch
	case "$XBPS_TARGET_MACHINE" in
		aarch64*) _gyp_arch=arm64 ;;
		armv7*|armv6*) _gyp_arch=arm ;;
		i686*) _gyp_arch=ia32 ;;
		*) _gyp_arch=x64 ;;
	esac

	NODE_ENV=development npm ci --ignore-scripts
	npm run build
	cp -r .next/static .next/standalone/.next/static
	[ -d public ] && cp -r public .next/standalone/public || true

	local _node_gyp=/usr/lib/node_modules/npm/node_modules/node-gyp/bin/node-gyp.js
	(cd node_modules/better-sqlite3 && node "$_node_gyp" rebuild --arch="$_gyp_arch")

	local _bs3_release=.next/standalone/node_modules/better-sqlite3/build/Release
	mkdir -p "$_bs3_release"
	cp node_modules/better-sqlite3/build/Release/better_sqlite3.node "$_bs3_release/"

	rm -rf .next/standalone/node_modules/@img

	for _mod in pino-abstract-transport split2 process-warning; do
		cp -r "node_modules/$_mod" .next/standalone/node_modules/
	done
}

do_check() {
	npm run test:unit
}

do_install() {
	vmkdir usr/lib/omniroute/.next
	vcopy .next/standalone/. usr/lib/omniroute/.next/standalone

	for _d in \
		.next/standalone/.next/server/app/dashboard \
		.next/standalone/.next/server/app/dashboard/settings \
		.next/standalone/.next/server/app/dashboard/providers; do
		touch "${DESTDIR}/usr/lib/omniroute/${_d}/.keep"
	done

	cat > "${WRKDIR}/omniroute" <<'EOF'
#!/bin/sh
export PORT="${PORT:-20128}"
export DATA_DIR="${DATA_DIR:-${XDG_DATA_HOME:-${HOME}/.local/share}/omniroute}"
export APP_LOG_TO_FILE="${APP_LOG_TO_FILE:-false}"
mkdir -p "${DATA_DIR}"
exec node /usr/lib/omniroute/.next/standalone/server.js "$@"
EOF
	vbin "${WRKDIR}/omniroute"
}

post_install() {
	vlicense LICENSE
}
```

---

## ਅਣਇੰਸਟਾਲ ਕਰਨਾ

| ਕਮਾਂਡ                    | ਕਾਰਵਾਈ                                                                                            |
| ------------------------ | ------------------------------------------------------------------------------------------------- |
| `npm run uninstall`      | ਸਿਸਟਮ ਐਪ ਨੂੰ ਹਟਾਉਂਦੀ ਹੈ, ਪਰ `~/.omniroute` ਵਿੱਚ **ਤੁਹਾਡੇ DB ਅਤੇ ਸੰਰਚਨਾਵਾਂ ਨੂੰ ਬਰਕਰਾਰ ਰੱਖਦੀ ਹੈ**।  |
| `npm run uninstall:full` | ਐਪ ਨੂੰ ਹਟਾਉਂਦੀ ਹੈ ਅਤੇ **ਸਾਰੀਆਂ ਸੰਰਚਨਾਵਾਂ, ਕੁੰਜੀਆਂ ਅਤੇ ਡਾਟਾਬੇਸਾਂ ਨੂੰ ਸਥਾਈ ਤੌਰ 'ਤੇ ਮਿਟਾ ਦਿੰਦੀ ਹੈ**। |

> ਸਾਰੇ ਤਰੀਕਿਆਂ ਲਈ ਵਿਸਤ੍ਰਿਤ ਅਣਇੰਸਟਾਲ ਨਿਰਦੇਸ਼ਾਂ ਵਾਸਤੇ, [UNINSTALL.md](./UNINSTALL.md) ਵੇਖੋ।