初回起動

oar コマンドをインストールしたら（インストールを参照）、会話を始めるまでに必要なことは 3 つです。リレーに設定ファイル（ポート、接続できる相手、アクセストークン）が必要で、リレーが実行中である必要があり、ブラウザーがトークンでサインインする必要があります。このページでは、この順に説明します。

セットアップ #

oar setup は設定ファイルを書き込みます。設定ファイルは OAR の状態フォルダー（macOS と Linux では ~/.oar、Windows では %APPDATA%\oar。環境変数 OAR_STATE_ROOT で場所を変えられます）にある config.json です。設定するのは次の 3 つで、Windows では自動起動も設定します。

macOS と Linux のインストーラーは、すでに oar setup --defaults --start を実行しているため、これらの既定値でリレーが動作しており、インストーラーがそのアドレスを表示しています。Windows のインストーラーは最後に oar setup を実行します。これは下記の質問をしますが、リレーは起動しません。続けて oar start を実行してください。npm install -g で手動インストールした後は、自分で oar setup を実行し、続けて oar start を実行します。

ターミナルでは、oar setup は 3 つの質問をし、毎回現在の値を表示するため、Enter を押すとその値のままになります。0.9.15 で追加 Windows では 4 つ目として、リレーの起動方法（自動起動）を尋ねます。

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（起動時）では、PC で管理者の確認を 1 回求められます。確認を拒否しても何も変わらず、セットアップは設定ファイルを書き込みます。

選ぶポートは空いている必要があります。セットアップは、別のプログラムが使っているポート、WSL では Windows が使っているポートを受け付けません。--port を指定した場合は停止し、質問の場合はもう一度尋ねます。同じインストールのリレーは、自分のポートをそのまま使えます。

セットアップはオプションも受け付けます。--port、--lan、--local、--new-token、--autostart のいずれかを指定すると、セットアップは何も尋ねません。指定しなかった項目は現在の値のままです。

リレーが動作中にトークン、ポート、アクセスを変更すると、セットアップは変更を反映するためにリレーを再起動します。ターミナルでは先に The relay is running. Restart it now to apply the change?（リレーは実行中です。変更を適用するために今すぐ再起動しますか？）と確認します。--defaults を指定した場合やターミナルがない場合は、すぐに再起動します。「いいえ」と答えると、動作中のリレーは oar restart まで以前の設定のままです。

最後に、セットアップはリレーのアドレスを表示し、スマートフォンから接続できる場合は QR コードも表示します（スマートフォンからを参照）。

起動と停止 #

ターミナルで引数なしで oar を実行すると、メニューが表示されます。リレーの状態（実行中か停止中か、バージョン、アドレス、ポート、アクセス、サービス）を示すヘッダーと、コマンドごとの項目があります。矢印キーまたは数字と Enter で操作し、q で終了します。ターミナル以外では、oar は代わりに状態と使い方を表示します。

最初に必要なコマンドは次のとおりです。

oar start は次のような行を表示します。

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

このアドレスはパスワードと同じように扱ってください。トークンが含まれています。アクセスがこのマシンのみに設定されている場合は、2 行目でその旨が表示され、スマートフォンから接続する 2 つの方法（LAN アクセスまたはトンネル）が示されます。

リレーを開く #

リレーを実行しているマシンのブラウザーで、表示されたアドレスを開きます。?token= の部分でサインインします。その後、リレーは 30 日間有効な Cookie でブラウザーのサインインを保ち、ブラウザーのアドレスバーからはトークンが消えます。Cookie は HttpOnly で、HTTPS でリレーに接続した場合は Secure も付きます。

アドレスにトークンがない場合、リレーは Enter your access token to connect（接続するにはアクセストークンを入力してください）と表示するサインイン欄を表示します。トークンを貼り付けて Connect（接続）を押します。間違ったトークンでは Invalid token（無効なトークン）と表示されます。

スマートフォンから #

同じネットワーク上のスマートフォンや別のコンピューターから使うには、LAN アクセスを有効にします。

oar setup --lan

リレーが動作中なら、セットアップはリレーを再起動します（ターミナルでは先に確認します）。localhost の代わりにマシンのネットワークアドレスを使ったアドレスが、QR コードと一緒に表示されます。スマートフォンでスキャンしてください。後から oar url で同じアドレスとコードを表示できます。QR コードは、リレーに LAN アクセスがあり、マシンにネットワークアドレスがある場合にだけ表示されます。LAN アクセスが有効でもネットワークアドレスがない場合は、コマンドがその旨を表示します。既定のネットワーク設定の WSL では、アドレスが WSL の内部のものになり、他のデバイスからは接続できないため、セットアップはコードを表示しません。トンネルを使うか、WSL をミラーモードのネットワーク（.wslconfig の networkingMode=mirrored）に切り替えてください。

アドレスはただの http です。自分のネットワークの外から使うには、HTTPS を付け加える OAR のトンネルのいずれかを使ってください（ネットワークの外からを参照）。

トークンをなくしたとき #

oar url は、現在のトークンを含むアドレスを表示します。新しいトークンにしたい場合は、oar setup --new-token を実行します。新しいトークンを書き込んでリレーを再起動し（ターミナルでは先に確認します）、サインインしていたすべてのデバイスは新しいアドレスでサインインし直す必要があります。

最初の画面 #

最初の画面は、空の会話ビューです。表示される内容はリレーの状態によって変わります。

• プロバイダーの準備ができていないときは Set up a provider（プロバイダーを設定）。Open Settings（設定を開く）と + New chat（新しいチャット）が表示されます。既定のプロバイダーは GitHub Copilot で、リレーのホストにサインイン済みの Copilot CLI が必要です。その他のプロバイダーは Settings → Providers（設定 → プロバイダー）で有効にします。それぞれに必要なものはプロバイダーの概要に書かれています。
• プロバイダーの準備ができているときは Start your first chat（最初のチャットを始めましょう）。+ New chat がメインのボタンです。

⚙️ Settings は会話の上部の ⋯ メニューにあり、空の画面にもそのためのボタンがあります。幅の狭い画面では、☰ ボタンで会話リストが表示されます。

サイドバーの + New Chat を押すと、プロバイダー、モデル、作業フォルダーを選ぶダイアログが開きます。各項目の説明は会話を始めるにあります。

動かし続ける #

oar start は、停止するかマシンが再起動するまでリレーを動かします。ログインのたびに起動するには、oar service install で設定します。これは systemd のユーザーセッションがある Linux と Windows で使え、メニューにも項目があります。0.9.15 で追加 Windows では、oar autostart boot を使うと、代わりに誰かがサインインする前の起動時にリレーを起動します。macOS ではまだ使えないため、oar start でリレーを起動してください。

ネットワークの外から #

OAR には、ネットワークの外から HTTPS でリレーに接続するためのトンネル機能が組み込まれています。Cloudflare Tunnel と SSH トンネルです。先に OAR が公開するものを読んでください。

起動しないとき #