Sunucu
opencode serve komutu, opencode istemcisinin kullanabileceği bir OpenAPI endpoint’i açan headless bir HTTP sunucusu çalıştırır.
opencode serve [--port <number>] [--hostname <string>] [--cors <origin>]Seçenekler
| Bayrak | Açıklama | Varsayılan |
|---|---|---|
--port | Dinlenecek bağlantı noktası | 4096 |
--hostname | Dinlenecek ana bilgisayar adı | 127.0.0.1 |
--mdns | mDNS keşfini etkinleştir | false |
--mdns-domain | mDNS hizmeti için özel alan adı | opencode.local |
--cors | İzin verilecek ek tarayıcı kaynakları (origin) | [] |
--cors birden fazla kez geçilebilir:
opencode serve --cors http://localhost:5173 --cors https://app.example.comSunucuyu HTTP temel kimlik doğrulama (basic auth) ile korumak için OPENCODE_SERVER_PASSWORD ayarlayın. Kullanıcı adı varsayılan olarak opencode değeridir; değiştirmek isterseniz OPENCODE_SERVER_USERNAME ayarlayabilirsiniz. Bu ayar hem opencode serve hem de opencode web için geçerlidir.
OPENCODE_SERVER_PASSWORD=your-password opencode serveopencode çalıştırdığınızda hem TUI hem de sunucu başlar. TUI, sunucuyla konuşan istemci tarafıdır.
Sunucu bir OpenAPI 3.1 spesifikasyon uç noktası açar. Bu uç nokta SDK üretiminde de kullanılır.
Bu mimari, opencode’un birden fazla istemciyi desteklemesini ve programatik kullanımları mümkün kılmasını sağlar.
opencode serve ile bağımsız bir sunucu başlatabilirsiniz. opencode TUI açıksa, opencode serve yeni bir sunucu başlatır.
Mevcut sunucuya bağlanın
TUI başlarken rastgele bir port ve hostname atanır. Bunun yerine --hostname ve --port bayraklarını verebilirsiniz.
/tui uç noktası sunucu üzerinden TUI’yi sürmek için kullanılabilir. Örneğin bir istemi önceden doldurabilir veya çalıştırabilirsiniz. Bu kurulum opencode IDE eklentileri tarafından kullanılır.
Sunucu, şu adreste görülebilen bir OpenAPI 3.1 spesifikasyonu yayınlar:
http://<hostname>:<port>/docÖrneğin http://localhost:4096/doc. İstemci oluşturmak, istek/yanit tiplerini incelemek veya Swagger gezgininde açmak için bu spec’i kullanın.
opencode sunucusu aşağıdaki API’leri sunar.
| Yöntem | Yol | Açıklama | Yanıt |
|---|---|---|---|
GET | /global/health | Sunucu sağlığını ve sürümünü al | { healthy: true, version: string } |
GET | /global/event | Küresel olayları al (SSE akışı) | Olay akışı |
| Yöntem | Yol | Açıklama | Yanıt |
|---|---|---|---|
GET | /project | Tüm projeleri listele | Project[] |
GET | /project/current | Mevcut projeyi al | Project |
| Yöntem | Yol | Açıklama | Yanıt |
|---|---|---|---|
POST | /instance/dispose | Mevcut örneği (instance) kapat | boolean |
| Yöntem | Yol | Açıklama | Yanıt |
|---|---|---|---|
GET | /config | Yapılandırma bilgisini al | Config |
PATCH | /config | Yapılandırmayı güncelle | Config |
GET | /config/providers | Sağlayıcıları ve varsayılan modelleri listele | { providers: Provider[], default: { [key: string]: string } } |
| Yöntem | Yol | Açıklama | Yanıt |
|---|---|---|---|
GET | /provider | Tüm sağlayıcıları listele | { all: Provider[], default: {...}, connected: string[] } |
GET | /provider/auth | Sağlayıcı kimlik doğrulama yöntemlerini al | { [providerID: string]: ProviderAuthMethod[] } |
POST | /provider/{id}/oauth/authorize | OAuth kullanarak bir sağlayıcıyı yetkilendir | ProviderAuthAuthorization |
POST | /provider/{id}/oauth/callback | Bir sağlayıcı için OAuth geri çağrısını işle | boolean |
| Yöntem | Yol | Açıklama | Notlar |
|---|---|---|---|
GET | /session | Tüm oturumları listele | Session[] döndürür |
POST | /session | Yeni bir oturum oluştur | gövde: { parentID?, title? }, Session döndürür |
GET | /session/status | Tüm oturumlar için durumu al | { [sessionID: string]: SessionStatus } döndürür |
GET | /session/:id | Oturum ayrıntılarını al | Session döndürür |
DELETE | /session/:id | Bir oturumu ve tüm verilerini sil | boolean döndürür |
PATCH | /session/:id | Oturum özelliklerini güncelle | gövde: { title? }, Session döndürür |
GET | /session/:id/children | Bir oturumun alt oturumlarını al | Session[] döndürür |
POST | /session/:id/init | Uygulamayı analiz et ve AGENTS.md oluştur | gövde: { messageID, providerID, modelID }, boolean döndürür |
POST | /session/:id/fork | Mevcut bir oturumu bir mesajda çatalla | gövde: { messageID? }, Session döndürür |
POST | /session/:id/abort | Çalışan bir oturumu iptal et | boolean döndürür |
GET | /session/:id/diff | Bu oturum için farkı (diff) al | sorgu: messageID?, FileDiff[] döndürür |
POST | /session/:id/summarize | Oturumu özetle | gövde: { providerID, modelID }, boolean döndürür |
POST | /session/:id/revert | Bir mesajı geri al | gövde: { messageID, partID? }, boolean döndürür |
POST | /session/:id/unrevert | Geri alınan tüm mesajları geri yükle | boolean döndürür |
POST | /session/:id/permissions/:permissionID | Bir izin isteğine yanıt ver | gövde: { response, remember? }, boolean döndürür |
| Yöntem | Yol | Açıklama | Notlar |
|---|---|---|---|
GET | /session/:id/message | Bir oturumdaki mesajları listele | sorgu: limit?, { info: Message, parts: Part[]}[] döndürür |
POST | /session/:id/message | Bir mesaj gönder ve yanıt bekle | gövde: { messageID?, model?, agent?, noReply?, system?, tools?, parts }, { info: Message, parts: Part[]} döndürür |
GET | /session/:id/message/:messageID | Mesaj ayrıntılarını al | { info: Message, parts: Part[]} döndürür |
POST | /session/:id/prompt_async | Eşzamansız bir mesaj gönder (bekleme yok) | gövde: /session/:id/message ile aynı, 204 No Content döndürür |
POST | /session/:id/command | Bir eğik çizgi (slash) komutu çalıştır | gövde: { messageID?, agent?, model?, command, arguments }, { info: Message, parts: Part[]} döndürür |
POST | /session/:id/shell | Bir kabuk komutu çalıştır | gövde: { agent, model?, command }, { info: Message, parts: Part[]} döndürür |
| Yöntem | Yol | Açıklama | Yanıt |
|---|---|---|---|
GET | /command | Tüm komutları listele | Command[] |
| Yöntem | Yol | Açıklama | Yanıt |
|---|---|---|---|
GET | /find?pattern=<pat> | Dosyalarda metin ara | path, lines, line_number, absolute_offset, submatches içeren eşleşme nesneleri dizisi |
GET | /find/file?query=<q> | Dosya ve dizinleri isme göre bul | string[] (yollar) |
GET | /find/symbol?query=<q> | Çalışma alanı sembollerini bul | Symbol[] |
GET | /file?path=<path> | Dosya ve dizinleri listele | FileNode[] |
GET | /file/content?path=<p> | Bir dosyayı oku | FileContent |
GET | /file/status | İzlenen dosyalar için durumu al | File[] |
/find/file sorgu parametreleri
query(gerekli) - arama metni (bulanık eşleşme)type(isteğe bağlı) - sonuçları"file"veya"directory"ile sınırlamadirectory(isteğe bağlı) - arama için proje kökünü geçersiz kılmalimit(isteğe bağlı) - en fazla sonuç (1-200)dirs(isteğe bağlı) - eski bayrak ("false"sadece dosyaları döndürür)
| Yöntem | Yol | Açıklama | Yanıt |
|---|---|---|---|
GET | /experimental/tool/ids | Tüm araç kimliklerini listele | ToolIDs |
GET | /experimental/tool?provider=<p>&model=<m> | Bir model için araçları JSON şemalarıyla listele | ToolList |
| Yöntem | Yol | Açıklama | Yanıt |
|---|---|---|---|
GET | /lsp | LSP sunucu durumunu al | LSPStatus[] |
GET | /formatter | Biçimlendirici durumunu al | FormatterStatus[] |
GET | /mcp | MCP sunucu durumunu al | { [name: string]: MCPStatus } |
POST | /mcp | Dinamik olarak MCP sunucusu ekle | gövde: { name, config }, MCP durum nesnesi döndürür |
| Yöntem | Yol | Açıklama | Yanıt |
|---|---|---|---|
GET | /agent | Tüm mevcut agent’ları listele | Agent[] |
| Yöntem | Yol | Açıklama | Yanıt |
|---|---|---|---|
POST | /log | Günlük girdisi yaz. Gövde: { service, level, message, extra? } | boolean |
| Yöntem | Yol | Açıklama | Yanıt |
|---|---|---|---|
POST | /tui/append-prompt | İsteme metin ekle | boolean |
POST | /tui/open-help | Yardım iletişim kutusunu aç | boolean |
POST | /tui/open-sessions | Oturum seçiciyi aç | boolean |
POST | /tui/open-themes | Tema seçiciyi aç | boolean |
POST | /tui/open-models | Model seçiciyi aç | boolean |
POST | /tui/submit-prompt | Mevcut istemi gönder | boolean |
POST | /tui/clear-prompt | İstemi temizle | boolean |
POST | /tui/execute-command | Bir komut çalıştır ({ command }) | boolean |
POST | /tui/show-toast | Toast bildirimi göster ({ title?, message, variant }) | boolean |
GET | /tui/control/next | Bir sonraki kontrol isteğini bekle | Kontrol isteği nesnesi |
POST | /tui/control/response | Bir kontrol isteğine yanıt ver ({ body }) | boolean |
| Yöntem | Yol | Açıklama | Yanıt |
|---|---|---|---|
PUT | /auth/:id | Kimlik bilgilerini ayarla. Gövde sağlayıcı şemasıyla eşleşmelidir | boolean |
| Yöntem | Yol | Açıklama | Yanıt |
|---|---|---|---|
GET | /event | Sunucu tarafından gönderilen olay akışı (SSE). İlk olay server.connected, ardından veriyolu olayları | Sunucu tarafından gönderilen olay akışı |
| Yöntem | Yol | Açıklama | Yanıt |
|---|---|---|---|
GET | /doc | OpenAPI 3.1 spesifikasyonu | OpenAPI spec içeren HTML sayfası |