summaryrefslogtreecommitdiffhomepage
path: root/packages/web/src/content/docs/es/sdk.mdx
diff options
context:
space:
mode:
authoropencode-agent[bot] <opencode-agent[bot]@users.noreply.github.com>2026-02-09 17:35:30 +0000
committeropencode-agent[bot] <opencode-agent[bot]@users.noreply.github.com>2026-02-09 17:35:30 +0000
commitd578f80f0055082cc7befd29b2ce6bda7326d29f (patch)
tree5ca2ee868fe480104a5464260a8b114c3ef4ec71 /packages/web/src/content/docs/es/sdk.mdx
parentdc53086c1e73d43d3a28fc4cdf161e83d09b1877 (diff)
downloadopencode-d578f80f0055082cc7befd29b2ce6bda7326d29f.tar.gz
opencode-d578f80f0055082cc7befd29b2ce6bda7326d29f.zip
chore: generate
Diffstat (limited to 'packages/web/src/content/docs/es/sdk.mdx')
-rw-r--r--packages/web/src/content/docs/es/sdk.mdx142
1 files changed, 71 insertions, 71 deletions
diff --git a/packages/web/src/content/docs/es/sdk.mdx b/packages/web/src/content/docs/es/sdk.mdx
index 7a55e951e..495ef56f4 100644
--- a/packages/web/src/content/docs/es/sdk.mdx
+++ b/packages/web/src/content/docs/es/sdk.mdx
@@ -37,13 +37,13 @@ Esto inicia tanto un servidor como un cliente.
#### Opciones
-| Opción | Tipo | Descripción | Predeterminado |
-| ---------- | ------------- | ------------------------------ | ----------- |
-| `hostname` | `string` | Nombre de host del servidor | `127.0.0.1` |
-| `port` | `number` | Puerto del servidor | `4096` |
-| `signal` | `AbortSignal` | Señal de aborto para cancelación | `undefined` |
-| `timeout` | `number` | Tiempo de espera en ms para inicio del servidor | `5000` |
-| `config` | `Config` | Objeto de configuración | `{}` |
+| Opción | Tipo | Descripción | Predeterminado |
+| ---------- | ------------- | ----------------------------------------------- | -------------- |
+| `hostname` | `string` | Nombre de host del servidor | `127.0.0.1` |
+| `port` | `number` | Puerto del servidor | `4096` |
+| `signal` | `AbortSignal` | Señal de aborto para cancelación | `undefined` |
+| `timeout` | `number` | Tiempo de espera en ms para inicio del servidor | `5000` |
+| `config` | `Config` | Objeto de configuración | `{}` |
---
@@ -81,13 +81,13 @@ const client = createOpencodeClient({
#### Opciones
-| Opción | Tipo | Descripción | Predeterminado |
-| --------------- | ---------- | -------------------------------- | ----------------------- |
-| `baseUrl` | `string` | URL del servidor | `http://localhost:4096` |
-| `fetch` | `function` | Implementación de recuperación personalizada | `globalThis.fetch` |
-| `parseAs` | `string` | Método de análisis de respuesta | `auto` |
-| `responseStyle` | `string` | Estilo de devolución: `data` o `fields` | `fields` |
-| `throwOnError` | `boolean` | Lanzar errores en lugar de devolver | `false` |
+| Opción | Tipo | Descripción | Predeterminado |
+| --------------- | ---------- | -------------------------------------------- | ----------------------- |
+| `baseUrl` | `string` | URL del servidor | `http://localhost:4096` |
+| `fetch` | `function` | Implementación de recuperación personalizada | `globalThis.fetch` |
+| `parseAs` | `string` | Método de análisis de respuesta | `auto` |
+| `responseStyle` | `string` | Estilo de devolución: `data` o `fields` | `fields` |
+| `throwOnError` | `boolean` | Lanzar errores en lugar de devolver | `false` |
---
@@ -125,8 +125,8 @@ El SDK expone todas las API del servidor a través de un cliente con seguridad d
### Global
-| Método | Descripción | Respuesta |
-| ----------------- | ------------------------------- | ------------------------------------ |
+| Método | Descripción | Respuesta |
+| ----------------- | --------------------------------------------- | ------------------------------------ |
| `global.health()` | Verificar el estado y la versión del servidor | `{ healthy: true, version: string }` |
---
@@ -142,9 +142,9 @@ console.log(health.data.version)
### Aplicación
-| Método | Descripción | Respuesta |
-| -------------- | ------------------------- | ------------------------------------------- |
-| `app.log()` | Escribe una entrada de registro | `boolean` |
+| Método | Descripción | Respuesta |
+| -------------- | ------------------------------------ | -------------------------------------------- |
+| `app.log()` | Escribe una entrada de registro | `boolean` |
| `app.agents()` | Listar todos los agentes disponibles | <a href={typesUrl}><code>Agente[]</code></a> |
---
@@ -169,10 +169,10 @@ const agents = await client.app.agents()
### Proyecto
-| Método | Descripción | Respuesta |
-| ------------------- | ------------------- | --------------------------------------------- |
-| `project.list()` | Listar todos los proyectos | <a href={typesUrl}><code>Proyecto[]</code></a> |
-| `project.current()` | Obtener proyecto actual | <a href={typesUrl}><code>Proyecto</code></a> |
+| Método | Descripción | Respuesta |
+| ------------------- | -------------------------- | ---------------------------------------------- |
+| `project.list()` | Listar todos los proyectos | <a href={typesUrl}><code>Proyecto[]</code></a> |
+| `project.current()` | Obtener proyecto actual | <a href={typesUrl}><code>Proyecto</code></a> |
---
@@ -190,8 +190,8 @@ const currentProject = await client.project.current()
### Camino
-| Método | Descripción | Respuesta |
-| ------------ | ---------------- | ---------------------------------------- |
+| Método | Descripción | Respuesta |
+| ------------ | ------------------- | ---------------------------------------- |
| `path.get()` | Obtener ruta actual | <a href={typesUrl}><code>Ruta</code></a> |
---
@@ -207,9 +207,9 @@ const pathInfo = await client.path.get()
### Configuración
-| Método | Descripción | Respuesta |
-| -------------------- | --------------------------------- | ----------------------------------------------------------------------------------------------------- |
-| `config.get()` | Obtener información de configuración | <a href={typesUrl}><code>Configuración</code></a> |
+| Método | Descripción | Respuesta |
+| -------------------- | ---------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
+| `config.get()` | Obtener información de configuración | <a href={typesUrl}><code>Configuración</code></a> |
| `config.providers()` | Lista de proveedores y modelos predeterminados | `{ providers: `<a href={typesUrl}><code>Proveedor[]</code></a>`, default: { [key: string]: string } }` |
---
@@ -226,27 +226,27 @@ const { providers, default: defaults } = await client.config.providers()
### Sesiones
-| Método | Descripción | Notas |
-| ---------------------------------------------------------- | ---------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
-| `session.list()` | Listar sesiones | Devuelve <a href={typesUrl}><code>Sesión[]</code></a> |
-| `session.get({ path })` | Obtener sesión | Devuelve <a href={typesUrl}><code>Sesión</code></a> |
-| `session.children({ path })` | Listar sesiones infantiles | Devuelve <a href={typesUrl}><code>Sesión[]</code></a> |
-| `session.create({ body })` | Crear sesión | Devuelve <a href={typesUrl}><code>Sesión</code></a> |
-| `session.delete({ path })` | Eliminar sesión | Devuelve `boolean` |
-| `session.update({ path, body })` | Actualizar propiedades de sesión | Devuelve <a href={typesUrl}><code>Sesión</code></a> |
-| `session.init({ path, body })` | Analizar aplicación y crear `AGENTS.md` | Devuelve `boolean` |
-| `session.abort({ path })` | Cancelar una sesión en ejecución | Devuelve `boolean` |
-| `session.share({ path })` | Compartir sesión | Devuelve <a href={typesUrl}><code>Sesión</code></a> |
-| `session.unshare({ path })` | Dejar de compartir sesión | Devuelve <a href={typesUrl}><code>Sesión</code></a> |
-| `session.summarize({ path, body })` | Resumir sesión | Devuelve `boolean` |
-| `session.messages({ path })` | Listar mensajes en una sesión | Devuelve `{ info: `<a href={typesUrl}><code>Mensaje</code></a>`, parts: `<a href={typesUrl}><code>Parte[]</code></a>`}[]` |
-| `session.message({ path })` | Obtener detalles del mensaje | Devuelve `{ info: `<a href={typesUrl}><code>Mensaje</code></a>`, parts: `<a href={typesUrl}><code>Parte[]</code></a>`}` |
-| `session.prompt({ path, body })` | Enviar mensaje rápido | `body.noReply: true` devuelve UserMessage (solo contexto). El valor predeterminado devuelve <a href={typesUrl}><code>AssistantMessage</code></a> con respuesta de IA |
-| `session.command({ path, body })` | Enviar comando a la sesión | Devuelve `{ info: `<a href={typesUrl}><code>AssistantMessage</code></a>`, parts: `<a href={typesUrl}><code>Parte[]</code></a>`}` |
-| `session.shell({ path, body })` | Ejecute un comando de shell | Devuelve <a href={typesUrl}><code>AssistantMessage</code></a> |
-| `session.revert({ path, body })` | Revertir un mensaje | Devuelve <a href={typesUrl}><code>Sesión</code></a> |
-| `session.unrevert({ path })` | Restaurar mensajes revertidos | Devuelve <a href={typesUrl}><code>Sesión</code></a> |
-| `postSessionByIdPermissionsByPermissionId({ path, body })` | Responder a una solicitud de permiso | Devuelve `boolean` |
+| Método | Descripción | Notas |
+| ---------------------------------------------------------- | --------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `session.list()` | Listar sesiones | Devuelve <a href={typesUrl}><code>Sesión[]</code></a> |
+| `session.get({ path })` | Obtener sesión | Devuelve <a href={typesUrl}><code>Sesión</code></a> |
+| `session.children({ path })` | Listar sesiones infantiles | Devuelve <a href={typesUrl}><code>Sesión[]</code></a> |
+| `session.create({ body })` | Crear sesión | Devuelve <a href={typesUrl}><code>Sesión</code></a> |
+| `session.delete({ path })` | Eliminar sesión | Devuelve `boolean` |
+| `session.update({ path, body })` | Actualizar propiedades de sesión | Devuelve <a href={typesUrl}><code>Sesión</code></a> |
+| `session.init({ path, body })` | Analizar aplicación y crear `AGENTS.md` | Devuelve `boolean` |
+| `session.abort({ path })` | Cancelar una sesión en ejecución | Devuelve `boolean` |
+| `session.share({ path })` | Compartir sesión | Devuelve <a href={typesUrl}><code>Sesión</code></a> |
+| `session.unshare({ path })` | Dejar de compartir sesión | Devuelve <a href={typesUrl}><code>Sesión</code></a> |
+| `session.summarize({ path, body })` | Resumir sesión | Devuelve `boolean` |
+| `session.messages({ path })` | Listar mensajes en una sesión | Devuelve `{ info: `<a href={typesUrl}><code>Mensaje</code></a>`, parts: `<a href={typesUrl}><code>Parte[]</code></a>`}[]` |
+| `session.message({ path })` | Obtener detalles del mensaje | Devuelve `{ info: `<a href={typesUrl}><code>Mensaje</code></a>`, parts: `<a href={typesUrl}><code>Parte[]</code></a>`}` |
+| `session.prompt({ path, body })` | Enviar mensaje rápido | `body.noReply: true` devuelve UserMessage (solo contexto). El valor predeterminado devuelve <a href={typesUrl}><code>AssistantMessage</code></a> con respuesta de IA |
+| `session.command({ path, body })` | Enviar comando a la sesión | Devuelve `{ info: `<a href={typesUrl}><code>AssistantMessage</code></a>`, parts: `<a href={typesUrl}><code>Parte[]</code></a>`}` |
+| `session.shell({ path, body })` | Ejecute un comando de shell | Devuelve <a href={typesUrl}><code>AssistantMessage</code></a> |
+| `session.revert({ path, body })` | Revertir un mensaje | Devuelve <a href={typesUrl}><code>Sesión</code></a> |
+| `session.unrevert({ path })` | Restaurar mensajes revertidos | Devuelve <a href={typesUrl}><code>Sesión</code></a> |
+| `postSessionByIdPermissionsByPermissionId({ path, body })` | Responder a una solicitud de permiso | Devuelve `boolean` |
---
@@ -283,13 +283,13 @@ await client.session.prompt({
### Archivos
-| Método | Descripción | Respuesta |
-| ------------------------- | ---------------------------------- | ------------------------------------------------------------------------------------------- |
-| `find.text({ query })` | Buscar texto en archivos | Matriz de objetos coincidentes con `path`, `lines`, `line_number`, `absolute_offset`, `submatches` |
-| `find.files({ query })` | Buscar archivos y directorios por nombre | `string[]` (rutas) |
-| `find.symbols({ query })` | Buscar símbolos del espacio de trabajo | <a href={typesUrl}><code>Símbolo[]</code></a> |
-| `file.read({ query })` | Leer un archivo | `{ type: "raw" \| "patch", content: string }` |
-| `file.status({ query? })` | Obtener el estado de los archivos rastreados | <a href={typesUrl}><code>Archivo[]</code></a> |
+| Método | Descripción | Respuesta |
+| ------------------------- | -------------------------------------------- | -------------------------------------------------------------------------------------------------- |
+| `find.text({ query })` | Buscar texto en archivos | Matriz de objetos coincidentes con `path`, `lines`, `line_number`, `absolute_offset`, `submatches` |
+| `find.files({ query })` | Buscar archivos y directorios por nombre | `string[]` (rutas) |
+| `find.symbols({ query })` | Buscar símbolos del espacio de trabajo | <a href={typesUrl}><code>Símbolo[]</code></a> |
+| `file.read({ query })` | Leer un archivo | `{ type: "raw" \| "patch", content: string }` |
+| `file.status({ query? })` | Obtener el estado de los archivos rastreados | <a href={typesUrl}><code>Archivo[]</code></a> |
`find.files` admite algunos campos de consulta opcionales:
@@ -324,17 +324,17 @@ const content = await client.file.read({
### TUI
-| Método | Descripción | Respuesta |
-| ------------------------------ | ------------------------- | --------- |
-| `tui.appendPrompt({ body })` | Agregar texto al mensaje | `boolean` |
-| `tui.openHelp()` | Abra el cuadro de diálogo de ayuda | `boolean` |
-| `tui.openSessions()` | Abrir el selector de sesiones | `boolean` |
-| `tui.openThemes()` | Abra el selector de temas | `boolean` |
-| `tui.openModels()` | Abrir el selector de modelo | `boolean` |
-| `tui.submitPrompt()` | Enviar el mensaje actual | `boolean` |
-| `tui.clearPrompt()` | Borrar el mensaje | `boolean` |
-| `tui.executeCommand({ body })` | Ejecutar un comando | `boolean` |
-| `tui.showToast({ body })` | Mostrar notificación del brindis | `boolean` |
+| Método | Descripción | Respuesta |
+| ------------------------------ | ---------------------------------- | --------- |
+| `tui.appendPrompt({ body })` | Agregar texto al mensaje | `boolean` |
+| `tui.openHelp()` | Abra el cuadro de diálogo de ayuda | `boolean` |
+| `tui.openSessions()` | Abrir el selector de sesiones | `boolean` |
+| `tui.openThemes()` | Abra el selector de temas | `boolean` |
+| `tui.openModels()` | Abrir el selector de modelo | `boolean` |
+| `tui.submitPrompt()` | Enviar el mensaje actual | `boolean` |
+| `tui.clearPrompt()` | Borrar el mensaje | `boolean` |
+| `tui.executeCommand({ body })` | Ejecutar un comando | `boolean` |
+| `tui.showToast({ body })` | Mostrar notificación del brindis | `boolean` |
---
@@ -355,8 +355,8 @@ await client.tui.showToast({
### Autenticación
-| Método | Descripción | Respuesta |
-| ------------------- | ------------------------------ | --------- |
+| Método | Descripción | Respuesta |
+| ------------------- | ---------------------------------------- | --------- |
| `auth.set({ ... })` | Establecer credenciales de autenticación | `boolean` |
---
@@ -374,8 +374,8 @@ await client.auth.set({
### Eventos
-| Método | Descripción | Respuesta |
-| ------------------- | ------------------------- | ------------------------- |
+| Método | Descripción | Respuesta |
+| ------------------- | ----------------------------------------------- | ----------------------------------------------- |
| `event.subscribe()` | Transmisión de eventos enviados por el servidor | Transmisión de eventos enviados por el servidor |
---