fix(docs): locale translations for nav elements and headings
This commit is contained in:
Adam
@@ -1,19 +1,19 @@
|
||||
---
|
||||
title: SDK
|
||||
description: Klient JS bezpieczny dla typu dla serwera opencode.
|
||||
description: Typowany klient JS dla serwera OpenCode.
|
||||
---
|
||||
|
||||
import config from "../../../../config.mjs"
|
||||
export const typesUrl = `${config.github}/blob/dev/packages/sdk/js/src/gen/types.gen.ts`
|
||||
|
||||
Pakiet SDK JS/TS z opencode zapewnia klienta bezpiecznego typu do interakcji z serwerem.
|
||||
Użyj go do budowania integracji i programowej kontroli otwartego kodu.
|
||||
Pakiet SDK JS/TS OpenCode zapewnia klienta z bezpiecznym typowaniem (type-safe) do interakcji z serwerem.
|
||||
Użyj go do budowania integracji i programowej kontroli OpenCode.
|
||||
|
||||
[Dowiedz się więcej](/docs/server) o działaniu serwera. Przykłady znajdziesz w [projektach](/docs/ecosystem#projects) stworzonych przez społeczność.
|
||||
|
||||
---
|
||||
|
||||
## Zainstalować
|
||||
## Instalacja
|
||||
|
||||
Zainstaluj pakiet SDK z npm:
|
||||
|
||||
@@ -23,9 +23,9 @@ npm install @opencode-ai/sdk
|
||||
|
||||
---
|
||||
|
||||
## Utwórz klienta
|
||||
## Tworzenie klienta
|
||||
|
||||
Utwórz instancję otwartego kodu:
|
||||
Utwórz instancję OpenCode:
|
||||
|
||||
```javascript
|
||||
import { createOpencode } from "@opencode-ai/sdk"
|
||||
@@ -33,21 +33,21 @@ import { createOpencode } from "@opencode-ai/sdk"
|
||||
const { client } = await createOpencode()
|
||||
```
|
||||
|
||||
Spowoduje to uruchomienie zarówno serwera, jak i klienta
|
||||
Spowoduje to uruchomienie zarówno serwera, jak i klienta.
|
||||
|
||||
#### Options
|
||||
#### Opcje
|
||||
|
||||
| Opcja | Wpisz | Opis | Domyślne |
|
||||
| Opcja | Typ | Opis | Domyślne |
|
||||
| ---------- | ------------- | ----------------------------------------- | ----------- |
|
||||
| `hostname` | `string` | Nazwa hosta serwera | `127.0.0.1` |
|
||||
| `port` | `number` | Port serwera | `4096` |
|
||||
| `signal` | `AbortSignal` | Sygnał przerwania w celu anulowania | `undefined` |
|
||||
| `timeout` | `number` | Limit czasu w ms dla uruchomienia serwera | `5000` |
|
||||
| `config` | `Config` | Configuration object | `{}` |
|
||||
| `config` | `Config` | Obiekt konfiguracji | `{}` |
|
||||
|
||||
---
|
||||
|
||||
## Config
|
||||
## Konfiguracja
|
||||
|
||||
Można przekazać obiekt konfiguracyjny, aby dostosować zachowanie. Instancja nadal pobiera `opencode.json`, ale możesz zastąpić lub dodać konfigurację bezpośrednio:
|
||||
|
||||
@@ -67,9 +67,9 @@ console.log(`Server running at ${opencode.server.url}`)
|
||||
opencode.server.close()
|
||||
```
|
||||
|
||||
## Client only
|
||||
## Tylko klient
|
||||
|
||||
Jeśli masz już działającą instancję opencode, możesz utworzyć instancję klienta, aby się z nią połączyć:
|
||||
Jeśli masz już działającą instancję OpenCode, możesz utworzyć instancję klienta, aby się z nią połączyć:
|
||||
|
||||
```javascript
|
||||
import { createOpencodeClient } from "@opencode-ai/sdk"
|
||||
@@ -79,19 +79,19 @@ const client = createOpencodeClient({
|
||||
})
|
||||
```
|
||||
|
||||
#### Options
|
||||
#### Opcje
|
||||
|
||||
| Opcja | Wpisz | Opis | Domyślne |
|
||||
| --------------- | ---------- | -------------------------------- | ----------------------- |
|
||||
| `baseUrl` | `string` | Adres URL serwera | `http://localhost:4096` |
|
||||
| `fetch` | `function` | Custom fetch implementation | `globalThis.fetch` |
|
||||
| `parseAs` | `string` | Response parsing method | `auto` |
|
||||
| `responseStyle` | `string` | Return style: `data` or `fields` | `fields` |
|
||||
| `throwOnError` | `boolean` | Throw errors instead of return | `false` |
|
||||
| Opcja | Typ | Opis | Domyślne |
|
||||
| --------------- | ---------- | ----------------------------------- | ----------------------- |
|
||||
| `baseUrl` | `string` | Adres URL serwera | `http://localhost:4096` |
|
||||
| `fetch` | `function` | Niestandardowa implementacja fetch | `globalThis.fetch` |
|
||||
| `parseAs` | `string` | Metoda parsowania odpowiedzi | `auto` |
|
||||
| `responseStyle` | `string` | Styl zwracania: `data` lub `fields` | `fields` |
|
||||
| `throwOnError` | `boolean` | Rzucaj błędy zamiast zwracać je | `false` |
|
||||
|
||||
---
|
||||
|
||||
## Types
|
||||
## Typy
|
||||
|
||||
Zestaw SDK zawiera definicje TypeScript dla wszystkich typów API. Zaimportuj je bezpośrednio:
|
||||
|
||||
@@ -103,7 +103,7 @@ Wszystkie typy są generowane na podstawie specyfikacji OpenAPI serwera i dostę
|
||||
|
||||
---
|
||||
|
||||
## Errors
|
||||
## Błędy
|
||||
|
||||
SDK może generować błędy, które można przechwycić i obsłużyć:
|
||||
|
||||
@@ -117,21 +117,21 @@ try {
|
||||
|
||||
---
|
||||
|
||||
## APIs
|
||||
## API
|
||||
|
||||
Zestaw SDK udostępnia wszystkie interfejsy API serwera za pośrednictwem klienta bezpiecznego typu.
|
||||
|
||||
---
|
||||
|
||||
### Global
|
||||
### Globalne
|
||||
|
||||
| Method | Description | Response |
|
||||
| Metoda | Opis | Odpowiedź |
|
||||
| ----------------- | ----------------------------- | ------------------------------------ |
|
||||
| `global.health()` | Sprawdź stan i wersję serwera | `{ healthy: true, version: string }` |
|
||||
|
||||
---
|
||||
|
||||
#### Examples
|
||||
#### Przykłady
|
||||
|
||||
```javascript
|
||||
const health = await client.global.health()
|
||||
@@ -140,16 +140,16 @@ console.log(health.data.version)
|
||||
|
||||
---
|
||||
|
||||
### App
|
||||
### Aplikacja
|
||||
|
||||
| Method | Description | Response |
|
||||
| Metoda | Opis | Odpowiedź |
|
||||
| -------------- | ----------------------------------- | ------------------------------------------- |
|
||||
| `app.log()` | Write a log entry | `boolean` |
|
||||
| `app.log()` | Zapisz wpis logu | `boolean` |
|
||||
| `app.agents()` | Lista wszystkich dostępnych agentów | <a href={typesUrl}><code>Agent[]</code></a> |
|
||||
|
||||
---
|
||||
|
||||
#### Examples
|
||||
#### Przykłady
|
||||
|
||||
```javascript
|
||||
// Write a log entry
|
||||
@@ -167,16 +167,16 @@ const agents = await client.app.agents()
|
||||
|
||||
---
|
||||
|
||||
### Project
|
||||
### Projekt
|
||||
|
||||
| Method | Description | Response |
|
||||
| Metoda | Opis | Odpowiedź |
|
||||
| ------------------- | -------------------------- | --------------------------------------------- |
|
||||
| `project.list()` | Lista wszystkich projektów | <a href={typesUrl}><code>Project[]</code></a> |
|
||||
| `project.current()` | Get current project | <a href={typesUrl}><code>Project</code></a> |
|
||||
| `project.current()` | Pobierz bieżący projekt | <a href={typesUrl}><code>Project</code></a> |
|
||||
|
||||
---
|
||||
|
||||
#### Examples
|
||||
#### Przykłady
|
||||
|
||||
```javascript
|
||||
// List all projects
|
||||
@@ -188,15 +188,15 @@ const currentProject = await client.project.current()
|
||||
|
||||
---
|
||||
|
||||
### Path
|
||||
### Ścieżka
|
||||
|
||||
| Method | Description | Response |
|
||||
| ------------ | ---------------- | ---------------------------------------- |
|
||||
| `path.get()` | Get current path | <a href={typesUrl}><code>Path</code></a> |
|
||||
| Metoda | Opis | Odpowiedź |
|
||||
| ------------ | ----------------------- | ---------------------------------------- |
|
||||
| `path.get()` | Pobierz bieżącą ścieżkę | <a href={typesUrl}><code>Path</code></a> |
|
||||
|
||||
---
|
||||
|
||||
#### Examples
|
||||
#### Przykłady
|
||||
|
||||
```javascript
|
||||
// Get current path information
|
||||
@@ -205,16 +205,16 @@ const pathInfo = await client.path.get()
|
||||
|
||||
---
|
||||
|
||||
### Config
|
||||
### Konfiguracja
|
||||
|
||||
| Method | Description | Response |
|
||||
| Metoda | Opis | Odpowiedź |
|
||||
| -------------------- | ----------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
||||
| `config.get()` | Get config info | <a href={typesUrl}><code>Config</code></a> |
|
||||
| `config.get()` | Pobierz informacje o konfiguracji | <a href={typesUrl}><code>Config</code></a> |
|
||||
| `config.providers()` | Lista dostawców i modeli domyślnych | `{ providers: `<a href={typesUrl}><code>Provider[]</code></a>`, default: { [key: string]: string } }` |
|
||||
|
||||
---
|
||||
|
||||
#### Examples
|
||||
#### Przykłady
|
||||
|
||||
```javascript
|
||||
const config = await client.config.get()
|
||||
@@ -224,12 +224,12 @@ const { providers, default: defaults } = await client.config.providers()
|
||||
|
||||
---
|
||||
|
||||
### Sessions
|
||||
### Sesje
|
||||
|
||||
| Method | Description | Notes |
|
||||
| Metoda | Opis | Uwagi |
|
||||
| ---------------------------------------------------------- | ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `session.list()` | Lista sesji | Zwraca <a href={typesUrl}><code>Session[]</code></a> |
|
||||
| `session.get({ path })` | Uzyskaj sesję | Zwraca <a href={typesUrl}><code>Session</code></a> |
|
||||
| `session.get({ path })` | Pobierz sesję | Zwraca <a href={typesUrl}><code>Session</code></a> |
|
||||
| `session.children({ path })` | Lista sesji podrzędnych | Zwraca <a href={typesUrl}><code>Session[]</code></a> |
|
||||
| `session.create({ body })` | Utwórz sesję | Zwraca <a href={typesUrl}><code>Session</code></a> |
|
||||
| `session.delete({ path })` | Usuń sesję | Zwraca `boolean` |
|
||||
@@ -238,19 +238,19 @@ const { providers, default: defaults } = await client.config.providers()
|
||||
| `session.abort({ path })` | Przerwij trwającą sesję | Zwraca `boolean` |
|
||||
| `session.share({ path })` | Udostępnij sesję | Zwraca <a href={typesUrl}><code>Session</code></a> |
|
||||
| `session.unshare({ path })` | Cofnij udostępnianie sesji | Zwraca <a href={typesUrl}><code>Session</code></a> |
|
||||
| `session.summarize({ path, body })` | Podsumowanie sesji | Zwraca `boolean` |
|
||||
| `session.summarize({ path, body })` | Podsumuj sesję | Zwraca `boolean` |
|
||||
| `session.messages({ path })` | Lista wiadomości w sesji | Zwraca `{ info: `<a href={typesUrl}><code>Message</code></a>`, parts: `<a href={typesUrl}><code>Part[]</code></a>`}[]` |
|
||||
| `session.message({ path })` | Uzyskaj szczegóły wiadomości | Zwraca `{ info: `<a href={typesUrl}><code>Message</code></a>`, parts: `<a href={typesUrl}><code>Part[]</code></a>`}` |
|
||||
| `session.message({ path })` | Pobierz szczegóły wiadomości | Zwraca `{ info: `<a href={typesUrl}><code>Message</code></a>`, parts: `<a href={typesUrl}><code>Part[]</code></a>`}` |
|
||||
| `session.prompt({ path, body })` | Wyślij wiadomość | `body.noReply: true` zwraca UserMessage (tylko kontekst). Domyślnie zwraca <a href={typesUrl}><code>AssistantMessage</code></a> z odpowiedzią AI |
|
||||
| `session.command({ path, body })` | Wyślij polecenie do sesji | Zwraca `{ info: `<a href={typesUrl}><code>AssistantMessage</code></a>`, parts: `<a href={typesUrl}><code>Part[]</code></a>`}` |
|
||||
| `session.shell({ path, body })` | Uruchom polecenie shell | Zwraca <a href={typesUrl}><code>AssistantMessage</code></a> |
|
||||
| `session.revert({ path, body })` | Przywróć wiadomość | Zwraca <a href={typesUrl}><code>Session</code></a> |
|
||||
| `session.unrevert({ path })` | Przywróć przywrócone wiadomości | Zwraca <a href={typesUrl}><code>Session</code></a> |
|
||||
| `postSessionByIdPermissionsByPermissionId({ path, body })` | Respond to a permission request | Returns `boolean` |
|
||||
| `session.revert({ path, body })` | Cofnij wiadomość (revert) | Zwraca <a href={typesUrl}><code>Session</code></a> |
|
||||
| `session.unrevert({ path })` | Przywróć cofnięte wiadomości | Zwraca <a href={typesUrl}><code>Session</code></a> |
|
||||
| `postSessionByIdPermissionsByPermissionId({ path, body })` | Odpowiedz na żądanie uprawnienia | Zwraca `boolean` |
|
||||
|
||||
---
|
||||
|
||||
#### Examples
|
||||
#### Przykłady
|
||||
|
||||
```javascript
|
||||
// Create and manage sessions
|
||||
@@ -281,25 +281,25 @@ await client.session.prompt({
|
||||
|
||||
---
|
||||
|
||||
### Files
|
||||
### Pliki
|
||||
|
||||
| Method | Description | Response |
|
||||
| Metoda | Opis | Odpowiedź |
|
||||
| ------------------------- | ------------------------------------ | ---------------------------------------------------------------------------------------------- |
|
||||
| `find.text({ query })` | Szukaj tekstu w plikach | Tablica obiektów dopasowania z `path`, `lines`, `line_number`, `absolute_offset`, `submatches` |
|
||||
| `find.files({ query })` | Znajdź pliki i katalogi według nazwy | `string[]` (ścieżki) |
|
||||
| `find.symbols({ query })` | Find workspace symbols | <a href={typesUrl}><code>Symbol[]</code></a> |
|
||||
| `file.read({ query })` | Read a file | `{ type: "raw" \| "patch", content: string }` |
|
||||
| `file.status({ query? })` | Uzyskaj status śledzonych plików | <a href={typesUrl}><code>File[]</code></a> |
|
||||
| `find.symbols({ query })` | Znajdź symbole w obszarze roboczym | <a href={typesUrl}><code>Symbol[]</code></a> |
|
||||
| `file.read({ query })` | Odczytaj plik | `{ type: "raw" \| "patch", content: string }` |
|
||||
| `file.status({ query? })` | Pobierz status śledzonych plików | <a href={typesUrl}><code>File[]</code></a> |
|
||||
|
||||
`find.files` supports a few optional query fields:
|
||||
`find.files` obsługuje kilka opcjonalnych pól zapytania:
|
||||
|
||||
- `type`: `"file"` or `"directory"`
|
||||
- `type`: `"file"` lub `"directory"`
|
||||
- `directory`: zastąp katalog główny projektu dla wyszukiwania
|
||||
- `limit`: max results (1–200)
|
||||
- `limit`: maks. wyników (1–200)
|
||||
|
||||
---
|
||||
|
||||
#### Examples
|
||||
#### Przykłady
|
||||
|
||||
```javascript
|
||||
// Search and read files
|
||||
@@ -324,21 +324,21 @@ const content = await client.file.read({
|
||||
|
||||
### TUI
|
||||
|
||||
| Method | Description | Response |
|
||||
| Metoda | Opis | Odpowiedź |
|
||||
| ------------------------------ | --------------------------- | --------- |
|
||||
| `tui.appendPrompt({ body })` | Dołącz tekst do zachęty | `boolean` |
|
||||
| `tui.appendPrompt({ body })` | Dołącz tekst do promptu | `boolean` |
|
||||
| `tui.openHelp()` | Otwórz okno pomocy | `boolean` |
|
||||
| `tui.openSessions()` | Otwórz selektor sesji | `boolean` |
|
||||
| `tui.openThemes()` | Otwórz selektor motywów | `boolean` |
|
||||
| `tui.openModels()` | Otwórz selektor modelu | `boolean` |
|
||||
| `tui.submitPrompt()` | Prześlij bieżący monit | `boolean` |
|
||||
| `tui.clearPrompt()` | Wyczyść monit | `boolean` |
|
||||
| `tui.submitPrompt()` | Prześlij bieżący prompt | `boolean` |
|
||||
| `tui.clearPrompt()` | Wyczyść prompt | `boolean` |
|
||||
| `tui.executeCommand({ body })` | Wykonaj polecenie | `boolean` |
|
||||
| `tui.showToast({ body })` | Pokaż powiadomienie tostowe | `boolean` |
|
||||
| `tui.showToast({ body })` | Pokaż powiadomienie (toast) | `boolean` |
|
||||
|
||||
---
|
||||
|
||||
#### Examples
|
||||
#### Przykłady
|
||||
|
||||
```javascript
|
||||
// Control TUI interface
|
||||
@@ -353,15 +353,15 @@ await client.tui.showToast({
|
||||
|
||||
---
|
||||
|
||||
### Auth
|
||||
### Uwierzytelnianie
|
||||
|
||||
| Method | Description | Response |
|
||||
| ------------------- | ------------------------------ | --------- |
|
||||
| `auth.set({ ... })` | Set authentication credentials | `boolean` |
|
||||
| Metoda | Opis | Odpowiedź |
|
||||
| ------------------- | ------------------------------------ | --------- |
|
||||
| `auth.set({ ... })` | Ustaw poświadczenia uwierzytelniania | `boolean` |
|
||||
|
||||
---
|
||||
|
||||
#### Examples
|
||||
#### Przykłady
|
||||
|
||||
```javascript
|
||||
await client.auth.set({
|
||||
@@ -372,15 +372,15 @@ await client.auth.set({
|
||||
|
||||
---
|
||||
|
||||
### Events
|
||||
### Zdarzenia
|
||||
|
||||
| Method | Description | Response |
|
||||
| ------------------- | --------------------------------------- | --------------------------------------- |
|
||||
| `event.subscribe()` | Strumień zdarzeń wysłanych przez serwer | Strumień zdarzeń wysłanych przez serwer |
|
||||
| Metoda | Opis | Odpowiedź |
|
||||
| ------------------- | ---------------------------------------- | ---------------------------------------- |
|
||||
| `event.subscribe()` | Strumień zdarzeń wysyłanych przez serwer | Strumień zdarzeń wysyłanych przez serwer |
|
||||
|
||||
---
|
||||
|
||||
#### Examples
|
||||
#### Przykłady
|
||||
|
||||
```javascript
|
||||
// Listen to real-time events
|
||||
|
||||
Reference in New Issue
Block a user