Primer arranque

Una vez instalado el comando oar (consulta Instalación), tres cosas te separan de una conversación: el relay necesita una configuración (un puerto, quién puede llegar a él y un token de acceso), tiene que estar en marcha, y tu navegador tiene que iniciar sesión con el token. Esta página las recorre en ese orden.

Configuración #

oar setup escribe el archivo de configuración, config.json, en la carpeta de estado de OAR (~/.oar en macOS y Linux, %APPDATA%\oar en Windows; la variable de entorno OAR_STATE_ROOT la traslada). Fija tres cosas, y en Windows también el inicio automático:

Ajuste	Significado	Valor predeterminado en una configuración nueva
Token de acceso	El secreto con el que inicia sesión cada navegador.	Uno aleatorio, generado para ti.
Acceso	This machine only (Solo esta máquina), o LAN (otros dispositivos de tu red).	Solo esta máquina.
Puerto	El puerto en el que escucha el relay.	3333, o el primer puerto libre a partir de 3333.
Inicio automático (Windows)	Nuevo en 0.9.15 Si el relay arranca solo: al iniciar sesión, al encender antes de que nadie inicie sesión, o nunca. No forma parte de la configuración.	El modo vigente; desactivado en una instalación nueva.

El instalador de macOS y Linux ya ha ejecutado oar setup --defaults --start por ti, así que hay un relay en marcha con esos valores predeterminados y el instalador imprimió su dirección. El instalador de Windows termina ejecutando oar setup, que hace las preguntas de abajo pero no arranca el relay: ejecuta oar start a continuación. Tras un npm install -g manual, ejecuta tú oar setup y luego oar start.

En una terminal, oar setup hace tres preguntas y muestra cada vez el valor actual, así que Enter lo conserva. Nuevo en 0.9.15 En Windows hace una cuarta, cómo arranca el relay (Inicio automático):

New auth token? It signs every device out.
Access: 1 = this machine only, 2 = LAN (other devices on your network) [1]:
Port [3333]:
Autostart: 1 = at sign-in, 2 = at boot, before anyone signs in (one administrator prompt), 3 = off [3]:

At boot (Al encender) pide una confirmación de administrador en el PC; si la rechazas, no cambia nada, y setup escribe igualmente la configuración.

El puerto que elijas debe estar libre. Setup no acepta un puerto que ocupe otro programa, ni en WSL uno que ocupe Windows: con --port se detiene, y en la pregunta vuelve a preguntar. El relay de esta misma instalación puede conservar su propio puerto.

Setup también acepta opciones. Si das cualquiera de --port, --lan, --local, --new-token o --autostart, setup no pregunta nada; lo que no hayas indicado conserva su valor actual.

Opción	Qué hace
`--port <port>`	Usa este puerto (un número de 1 a 65535).
`--lan`	Hace que el relay sea accesible desde otros dispositivos de tu red.
`--local`	Limita el relay a esta máquina. No se puede combinar con `--lan`.
`--new-token`	Sustituye el token de acceso. Todos los navegadores que tenían la sesión iniciada la pierden.
`--autostart signin\|boot\|off`	Nuevo en 0.9.15 Cambia cómo arranca el relay por sí solo, como hace `oar autostart`. Solo instalaciones globales.
`--defaults`	No pregunta nada. Una configuración existente se conserva tal cual; una nueva recibe solo esta máquina y el primer puerto libre a partir de 3333.
`--start`	Además arranca el relay, y en Linux con una sesión de usuario de systemd instala el servicio que lo arranca en cada inicio de sesión. El instalador lo usa.
`--migrate-from <dir>`	Para un checkout de git anterior de OAR, de antes del cambio de nombre: copia el estado del relay del checkout de `<dir>` en la carpeta de estado de OAR. El checkout nunca se modifica. Se rechaza mientras siga ejecutándose un relay desde él. Se ejecuta cada vez que nombras una carpeta: una que ya se trasladó solo lo indica, y una sin nada que trasladar es un error. Consulta Trasladar una instalación antigua.

Cuando hay un relay en marcha y cambias el token, el puerto o el acceso, setup lo reinicia para que el cambio surta efecto. En una terminal pregunta antes: The relay is running. Restart it now to apply the change? (El relay está en marcha. ¿Reiniciarlo ahora para aplicar el cambio?). Con --defaults, o sin terminal, reinicia de inmediato. Si respondes que no, el relay en marcha conserva sus ajustes anteriores hasta oar restart.

Al final, setup imprime la dirección del relay, y un código QR cuando un teléfono puede llegar a él (consulta Desde un teléfono).

Arrancar y detener #

Ejecuta oar sin argumentos en una terminal para obtener un menú: una cabecera con el estado del relay (en marcha o detenido, versión, dirección, puerto, acceso, servicio) y una entrada por cada comando. Usa las flechas o un dígito y Enter; q sale. Fuera de una terminal, oar imprime en su lugar el estado y el uso.

Los comandos que necesitas primero:

Comando	Qué hace
`oar start`	Arranca el relay en segundo plano e imprime su dirección. Un relay que ya está en marcha se deja como está.
`oar status`	Dice si el relay está en marcha, en qué puerto y con qué acceso. Su código de salida es 0 cuando el relay está en marcha y 3 cuando no.
`oar url`	Vuelve a imprimir la dirección, con el token, y un código QR donde un teléfono puede usarlo.
`oar stop`	Detiene el relay. Espera hasta que no haya ningún turn en curso.
`oar restart`	Lo reinicia, esperando también a los turns en curso.

oar start imprime una línea como esta:

[oar] Relay URL: http://localhost:3333/?token=<your token>

Trata esa dirección como una contraseña: lleva el token. Con el acceso limitado a esta máquina, una segunda línea lo indica y nombra las dos formas de llegar desde un teléfono: el acceso LAN o un túnel.

Abrir el relay #

Abre la dirección impresa en un navegador de la máquina que ejecuta el relay. La parte ?token= inicia tu sesión. Después, el relay mantiene la sesión del navegador con una cookie que dura 30 días, y la barra de direcciones del navegador deja de mostrar el token. La cookie es HttpOnly, y se marca como Secure cuando llegas al relay por HTTPS.

Sin el token en la dirección, el relay muestra un cuadro de inicio de sesión que dice Enter your access token to connect (Introduce tu token de acceso para conectarte). Pega el token y pulsa Connect (Conectar). Uno incorrecto muestra Invalid token (Token no válido).

Desde un teléfono #

Para un teléfono u otro ordenador de la misma red, activa el acceso LAN:

oar setup --lan

Si el relay está en marcha, setup lo reinicia (en una terminal pregunta antes). Imprime una dirección con la dirección de red de tu máquina en lugar de localhost, junto con un código QR. Escanéalo con el teléfono. oar url imprime la misma dirección y el mismo código más tarde. El código QR solo aparece cuando el relay tiene acceso LAN y la máquina tiene una dirección de red; con el acceso LAN activado y sin dirección de red, el comando lo indica. En WSL con su red predeterminada, la dirección es interna de WSL y los demás dispositivos no pueden llegar a ella, así que setup no imprime ningún código: usa un túnel, o cambia WSL a la red en modo espejo (networkingMode=mirrored en .wslconfig).

La dirección es http sin cifrar. Más allá de tu propia red, usa uno de los túneles de OAR, que añaden HTTPS (consulta Desde fuera de tu red).

Si pierdes el token #

oar url imprime la dirección con el token actual. Si prefieres uno nuevo, ejecuta oar setup --new-token: escribe un token nuevo y reinicia el relay (en una terminal pregunta antes), y todos los dispositivos que tenían la sesión iniciada tienen que volver a iniciarla con la dirección nueva.

El primer vistazo #

La primera pantalla es la vista de conversación vacía. Lo que dice depende del relay:

Set up a provider (Configurar un proveedor), cuando ningún proveedor está listo. Ofrece Open Settings (Abrir Ajustes) y + New chat (Nuevo chat). GitHub Copilot es el proveedor predeterminado; necesita una Copilot CLI con la sesión iniciada en el host del relay. Los demás se activan en Settings → Providers (Ajustes → Proveedores). Los proveedores de un vistazo explica lo que necesita cada uno.
Start your first chat (Inicia tu primer chat), cuando hay un proveedor listo. + New chat es el botón principal.

⚙️ Settings está en el menú ⋯ de la parte superior de una conversación, y la pantalla vacía también tiene un botón para ello. En una pantalla estrecha, el botón ☰ muestra la lista de conversaciones.

+ New Chat en la barra lateral abre el cuadro de diálogo en el que eliges el proveedor, el modelo y la carpeta de trabajo. Iniciar una conversación lo describe campo por campo.

Mantenerlo en marcha #

oar start ejecuta el relay hasta que lo detienes o la máquina se reinicia. Para arrancarlo en cada inicio de sesión, oar service install lo configura en Linux con una sesión de usuario de systemd y en Windows; el menú tiene una entrada para ello. Nuevo en 0.9.15 En Windows, oar autostart boot lo arranca en cambio al encender, antes de que nadie inicie sesión. Aún no está disponible en macOS: allí, arranca el relay con oar start.

Desde fuera de tu red #

OAR tiene soporte integrado de túneles para llegar al relay desde fuera de tu red por HTTPS: un Cloudflare Tunnel o un túnel SSH. Lee antes Qué expone OAR.

Si no arranca #

Lo que ves	Qué hacer
`Port 3333 is in use by another program (or by a relay with another token).` de `oar start`	Otro programa usa el puerto, o sigue en marcha un relay con un token anterior. El mensaje sugiere `oar setup --port <port>`.
`Port 3333 is held by another program, or by a relay with another token.` de `oar status`, `oar stop` u `oar restart`	La misma causa. `oar stop` y `oar restart` añaden una segunda línea cuando parece que hay en marcha un relay de esta instalación, con su id de proceso: reinícialo desde su interfaz web, con 🌄 Restart web relay (Reiniciar el relay web) en el menú `⋯`, o termina ese proceso, y luego ejecuta `oar start`. `oar status` no da esa pista.
`Port 3333 is in use by another program.` de `oar setup`	La misma causa. Setup pide otro puerto, o con `--port` te dice que elijas uno.
`The relay did not come up — see …/server-err.log`	El relay arrancó y terminó. El mensaje nombra el archivo de registro en la carpeta `logs` de OAR; lee las últimas líneas. `oar doctor` muestra la instalación, la carpeta de estado y la configuración en uso.
Un servidor que arrancaste a mano termina de inmediato con Relay already running (El relay ya está en marcha) o Relay appears to be owned by another live process (El relay parece pertenecer a otro proceso activo)	Solo puede ejecutarse un relay por carpeta de datos. El mensaje aparece en esa terminal, o en el `server-err.log` cuando lo arrancó `oar`, y nombra el id de proceso del relay que tiene el bloqueo y el archivo de bloqueo. Nuevo en 0.9.14 Termina con lo que hay que hacer (`oar stop, or end process <pid>`), y el relay sale con el código 78. Detén ese relay con `oar stop` y vuelve a arrancar. Consulta Un relay por carpeta de datos.
WSL: el navegador de Windows muestra otra página, o rechaza el token	Con la red predeterminada de WSL, un puerto puede estar libre en la distribución mientras un programa de Windows escucha en él, y `localhost:<port>` en un navegador de Windows llega entonces a ese programa. `oar setup` elige un puerto libre en ambos lados, y `oar status`, `oar start` y `oar doctor` avisan cuando Windows ocupa el puerto. Elige otro con `oar setup --port <port>`.
Invalid token en el cuadro de inicio de sesión	Usa el token de `oar url`, que imprime el actual. Tras `--new-token`, o un cambio de token en la configuración, las direcciones antiguas dejan de funcionar.
`The relay runs with its earlier settings; restart it to apply the new ones.`	Cambiaste el token, el puerto o el acceso mientras el relay estaba en marcha. `oar restart` los aplica.