Premier lancement

Une fois la commande oar installée (voir Installation), trois choses vous séparent d’une conversation : le relais a besoin d’une config (un port, qui peut le joindre et un token d’accès), il doit tourner, et votre navigateur doit se connecter avec le token. Cette page les parcourt dans cet ordre.

Configuration #

oar setup écrit le fichier de config, config.json, dans le dossier d’état d’OAR (~/.oar sous macOS et Linux, %APPDATA%\oar sous Windows ; la variable d’environnement OAR_STATE_ROOT le déplace). Il règle trois choses, et sous Windows aussi le démarrage automatique :

Réglage	Signification	Valeur par défaut d’une nouvelle config
Token d’accès	Le secret avec lequel chaque navigateur se connecte.	Un token aléatoire, généré pour vous.
Accès	This machine only (cette machine uniquement), ou LAN (les autres appareils de votre réseau).	Cette machine uniquement.
Port	Le port sur lequel le relais écoute.	3333, ou le premier port libre à partir de 3333.
Démarrage automatique (Windows)	Ajouté en 0.9.15 Si le relais démarre tout seul : à l’ouverture de session, au démarrage avant que quiconque ne se connecte, ou pas du tout. Ne fait pas partie de la config.	Le mode en vigueur ; désactivé sur une nouvelle installation.

L’installateur pour macOS et Linux a déjà exécuté oar setup --defaults --start pour vous : un relais tourne donc avec ces valeurs par défaut, et l’installateur a affiché son adresse. L’installateur Windows se termine en exécutant oar setup, qui pose les questions ci-dessous mais ne démarre pas le relais : exécutez ensuite oar start. Après un npm install -g manuel, exécutez vous-même oar setup, puis oar start.

Dans un terminal, oar setup pose trois questions et affiche chaque fois la valeur actuelle, qu’Enter conserve. Ajouté en 0.9.15 Sous Windows, il en pose une quatrième, sur la façon dont le relais démarre (Démarrage automatique) :

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 (Au démarrage) demande une confirmation d’administrateur sur le PC ; une invite refusée ne change rien, et setup écrit quand même la config.

Le port choisi doit être libre. Setup n’accepte pas un port qu’occupe un autre programme, ni, sous WSL, un port qu’occupe Windows : avec --port, il s’arrête, et à la question, il la repose. Le relais de cette même installation peut garder son propre port.

Setup accepte aussi des options. Donnez l’une quelconque des options --port, --lan, --local, --new-token ou --autostart, et setup ne pose plus aucune question ; ce que vous n’avez pas donné garde sa valeur actuelle.

Option	Ce qu’elle fait
`--port <port>`	Utilise ce port (un nombre de 1 à 65535).
`--lan`	Rend le relais joignable depuis les autres appareils de votre réseau.
`--local`	Réserve le relais à cette seule machine. Incompatible avec `--lan`.
`--new-token`	Remplace le token d’accès. Chaque navigateur qui était connecté est déconnecté.
`--autostart signin\|boot\|off`	Ajouté en 0.9.15 Change la façon dont le relais démarre tout seul, comme le fait `oar autostart`. Installations globales uniquement.
`--defaults`	Ne pose aucune question. Une config existante est conservée telle quelle ; une nouvelle est réglée sur cette machine uniquement et sur le premier port libre à partir de 3333.
`--start`	Démarre aussi le relais et, sous Linux avec une session utilisateur systemd, installe le service qui le démarre à chaque connexion. L’installateur l’utilise.
`--migrate-from <dir>`	Pour un ancien checkout git d’OAR, d’avant le changement de nom : copie l’état du relais du checkout situé dans `<dir>` vers le dossier d’état d’OAR. Le checkout n’est jamais modifié. L’option est refusée tant qu’un relais tourne encore depuis ce checkout. Elle s’exécute chaque fois que vous nommez un dossier : pour un dossier déjà repris, elle se contente de le signaler, et un dossier sans rien à reprendre est une erreur. Voir Déplacer une ancienne installation.

Quand un relais tourne et que vous changez le token, le port ou l’accès, setup le redémarre pour que la modification prenne effet. Dans un terminal, il demande d’abord The relay is running. Restart it now to apply the change? (Le relais tourne. Le redémarrer maintenant pour appliquer la modification ?) ; avec --defaults, ou sans terminal, il redémarre aussitôt. Si vous répondez non, le relais en cours garde ses anciens réglages jusqu’à oar restart.

À la fin, setup affiche l’adresse du relais, et un QR code quand un téléphone peut le joindre (voir Depuis un téléphone).

Démarrer et arrêter #

Exécutez oar sans argument dans un terminal pour obtenir un menu : un en-tête avec l’état du relais (en marche ou arrêté, version, adresse, port, accès, service) et une entrée par commande. Utilisez les flèches ou un chiffre, puis Enter ; q quitte. Hors d’un terminal, oar affiche à la place l’état et l’aide.

Les commandes dont vous avez besoin en premier :

Commande	Ce qu’elle fait
`oar start`	Démarre le relais en arrière-plan et affiche son adresse. Un relais qui tourne déjà n’est pas touché.
`oar status`	Indique si le relais tourne, sur quel port et avec quel accès. Son code de sortie vaut 0 quand le relais tourne et 3 sinon.
`oar url`	Affiche de nouveau l’adresse, avec le token, et un QR code là où un téléphone peut l’utiliser.
`oar stop`	Arrête le relais. Il attend qu’aucun turn ne soit en cours.
`oar restart`	Le redémarre, en attendant lui aussi la fin des turns en cours.

oar start affiche une ligne comme celle-ci :

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

Traitez cette adresse comme un mot de passe : elle contient le token. Avec l’accès réglé sur cette machine uniquement, une seconde ligne le signale et indique les deux moyens de joindre le relais depuis un téléphone : l’accès LAN ou un tunnel.

Ouvrir le relais #

Ouvrez l’adresse affichée dans un navigateur sur la machine qui fait tourner le relais. La partie ?token= vous connecte. Le relais garde ensuite le navigateur connecté grâce à un cookie valable 30 jours, et la barre d’adresse du navigateur ne montre plus le token. Le cookie est HttpOnly, et il est marqué Secure quand vous joignez le relais en HTTPS.

Sans le token dans l’adresse, le relais affiche une boîte de connexion qui indique Enter your access token to connect (Saisissez votre token d’accès pour vous connecter). Collez le token et appuyez sur Connect (Se connecter). Un token erroné affiche Invalid token (Token non valide).

Depuis un téléphone #

Pour un téléphone ou un autre ordinateur sur le même réseau, activez l’accès LAN :

oar setup --lan

Si le relais tourne, setup le redémarre (dans un terminal, il demande d’abord). Il affiche une adresse avec l’adresse réseau de votre machine à la place de localhost, accompagnée d’un QR code. Scannez-le avec le téléphone. oar url affiche plus tard la même adresse et le même code. Le QR code n’apparaît que si le relais a l’accès LAN et que la machine a une adresse réseau ; avec l’accès LAN activé et sans adresse réseau, la commande le signale. Sous WSL avec son réseau par défaut, l’adresse est interne à WSL et les autres appareils ne peuvent pas la joindre, donc setup n’affiche pas de code : utilisez un tunnel, ou passez WSL en réseau en miroir (networkingMode=mirrored dans .wslconfig).

L’adresse est en http simple. Au-delà de votre propre réseau, utilisez l’un des tunnels d’OAR, qui ajoutent HTTPS (voir Depuis l’extérieur de votre réseau).

Si vous perdez le token #

oar url affiche l’adresse avec le token actuel. Si vous préférez en avoir un nouveau, exécutez oar setup --new-token : il écrit un nouveau token et redémarre le relais (dans un terminal, il demande d’abord), et chaque appareil qui était connecté doit se reconnecter avec la nouvelle adresse.

Le premier coup d’œil #

Le premier écran est la vue de conversation vide. Ce qu’elle indique dépend du relais :

Set up a provider (Configurer un fournisseur), quand aucun fournisseur n’est prêt. Elle propose Open Settings (Ouvrir les réglages) et + New chat (Nouveau chat). GitHub Copilot est le fournisseur par défaut ; il lui faut une Copilot CLI connectée sur l’hôte du relais. Les autres s’activent sous Settings → Providers (Réglages → Fournisseurs). Les fournisseurs en un coup d’œil indique ce qu’il faut à chacun.
Start your first chat (Démarrez votre premier chat), quand un fournisseur est prêt. + New chat est le bouton principal.

⚙️ Settings se trouve dans le menu ⋯ en haut d’une conversation, et l’écran vide a aussi un bouton pour y accéder. Sur un écran étroit, le bouton ☰ affiche la liste des conversations.

+ New Chat dans la barre latérale ouvre la boîte de dialogue où vous choisissez le fournisseur, le modèle et le dossier de travail. Démarrer une conversation la décrit champ par champ.

Le garder en marche #

oar start fait tourner le relais jusqu’à ce que vous l’arrêtiez ou que la machine redémarre. Pour le démarrer à chaque connexion, oar service install met cela en place sous Linux avec une session utilisateur systemd et sous Windows ; le menu a une entrée pour cela. Ajouté en 0.9.15 Sous Windows, oar autostart boot le démarre plutôt au démarrage de la machine, avant que quiconque ne se connecte. Ce n’est pas encore disponible sous macOS : démarrez-y le relais avec oar start.

Depuis l’extérieur de votre réseau #

OAR prend en charge des tunnels intégrés pour joindre le relais depuis l’extérieur de votre réseau en HTTPS : un Cloudflare Tunnel ou un tunnel SSH. Lisez d’abord Ce qu’OAR expose.

S’il ne démarre pas #

Ce que vous voyez	Que faire
`Port 3333 is in use by another program (or by a relay with another token).` venant de `oar start`	Un autre programme utilise le port, ou un relais avec un ancien token tourne encore. Le message suggère `oar setup --port <port>`.
`Port 3333 is held by another program, or by a relay with another token.` venant de `oar status`, `oar stop` ou `oar restart`	Même cause. `oar stop` et `oar restart` ajoutent une seconde ligne quand un relais de cette installation semble tourner, avec son identifiant de processus : redémarrez-le depuis son interface web, avec 🌄 Restart web relay (Redémarrer le relais web) dans le menu `⋯`, ou mettez fin à ce processus, puis exécutez `oar start`. `oar status` ne donne pas cette indication.
`Port 3333 is in use by another program.` venant de `oar setup`	Même cause. Setup demande un autre port ou, avec `--port`, vous dit d’en choisir un.
`The relay did not come up — see …/server-err.log`	Le relais a démarré puis s’est arrêté. Le message nomme le fichier journal dans le dossier `logs` d’OAR ; lisez-en les dernières lignes. `oar doctor` affiche l’installation, le dossier d’état et la config utilisés.
Un serveur que vous avez lancé à la main s’arrête aussitôt avec Relay already running (Le relais tourne déjà) ou Relay appears to be owned by another live process (Le relais semble appartenir à un autre processus actif)	Un seul relais peut tourner par dossier de données. Le message apparaît dans ce terminal, ou dans le `server-err.log` quand `oar` l’a démarré, et nomme l’identifiant de processus du relais qui détient le verrou ainsi que le fichier de verrou. Ajouté en 0.9.14 Il se termine par la marche à suivre (`oar stop, or end process <pid>`), et le relais s’arrête avec le code 78. Arrêtez ce relais avec `oar stop`, puis relancez. Voir Un seul relais par dossier de données.
WSL : le navigateur sous Windows affiche une autre page, ou refuse le token	Avec le réseau par défaut de WSL, un port peut être libre dans la distribution alors qu’un programme Windows écoute dessus, et `localhost:<port>` dans un navigateur Windows joint alors ce programme. `oar setup` choisit un port libre des deux côtés, et `oar status`, `oar start` et `oar doctor` avertissent quand Windows occupe le port. Choisissez-en un autre avec `oar setup --port <port>`.
Invalid token dans la boîte de connexion	Utilisez le token affiché par `oar url`, qui donne toujours le token actuel. Après `--new-token`, ou un changement de token dans la config, les anciennes adresses cessent de fonctionner.
`The relay runs with its earlier settings; restart it to apply the new ones.`	Vous avez changé le token, le port ou l’accès pendant que le relais tournait. `oar restart` les applique.