コマンドラインリファレンス
このページの内容 14セクション
- 始める前に
- 構文
- 概要
- 認証
- --authtoken
- --ephemeral-token
- サービス管理
- ヘッドレスモード
- --headless
- --authtoken-file
- --check-config
- ヘッドレスのログ
- ネットワーク選択
- --network
- --net と --ip
- 送信プロキシ
- --proxy
- --proxy-user
- プロキシ環境変数
- --http-transport
- デバイスターミナル
- --terminal
- --terminal-user
- --pairing-key
- localtonet ssh
- 診断と情報
- --debug
- --version
- --help
- 環境変数
- 終了コード
- 例
- 関連ページ
localtonet コンソールクライアントの全オプションを解説します。トークンでのサインイン、サービスとしての実行、プロンプトなしの実行、ネットワークや送信プロキシの選択、そしてデバイスターミナルのコマンドです。
始める前に #
このページでは、Windows、macOS、Linux 向けのコンソールクライアントを扱います。Docker イメージ内のクライアントと Linux パッケージも対象です。インストールはインストール概要から行ってください。トンネルはコマンドラインでは作成しません。ダッシュボード、API、またはMCPサーバーで作成、開始、停止します。クライアントはデバイスをアカウントに接続し、トラフィックを運びます。
構文 #
localtonet [options]
localtonet ssh <DEVICE> [--key <KEY>] [--stdio] [-- <COMMAND>]- オプションは任意の順序で指定できます。オプション名は大文字と小文字を区別しません。ただし
localtonet sshのオプションは区別します。 - 値はオプションの後にスペースまたは等号を挟んで指定します。
--authtoken <YOUR_TOKEN>と--authtoken=<YOUR_TOKEN>は同じ意味です。 - 値が必要なオプションで値がない場合は、
<option> requires a value.というエラーになります。 --proxy、--proxy-user、--http-transportは一度だけ指定できます。<YOUR_TOKEN>のようなプレースホルダーは、ご自身の値を表します。山括弧は付けずに入力してください。
オプションなしで起動すると、クライアントは対話モードで動作します。保存済みのトークンを使うかトークンの入力を求め、接続して、ステータス表をリアルタイムで表示します。
localtonet概要 #
| オプション | 用途 |
|---|---|
--authtoken <TOKEN> | AuthToken でサインインします。 |
--ephemeral-token | このデバイスにトークンを保存しません。 |
--install-service, --start-service, --stop-service, --status-service, --remove-service | バックグラウンドサービスを管理します。 |
--headless | プロンプトなしで、シンプルなログ行を出力して実行します。 |
--authtoken-file <PATH> | ファイルからトークンを読み込みます(ヘッドレスモード)。 |
--check-config | トークンの取得元を確認して終了します(ヘッドレスモード)。 |
--network | デバイスのネットワークインターフェースを一覧表示します。 |
--net <NAME> --ip <ADDRESS> | クライアントの全トラフィックを 1 つのネットワークインターフェース経由にします。 |
--proxy <none|env|URL>, --proxy-user <USER> | 送信プロキシ経由で Localtonet に接続します。 |
--http-transport <auto|https|raw> | プロキシ経由でサーバー接続を運ぶ方法を選びます。 |
--terminal <enable|disable|status>, --terminal-user <ACCOUNT>, --pairing-key <KEY> | このデバイスのデバイスターミナルをオンまたはオフにします。 |
ssh <DEVICE> | お使いのデバイスでシェルを開く、またはコマンドを実行します。 |
--debug | 接続の診断情報を出力します。 |
--version | バージョンを出力します。 |
--help, -h | 組み込みヘルプを出力します。 |
認証 #
--authtoken #
localtonet --authtoken <YOUR_TOKEN>マイトークンの AuthToken でデバイスをサインインさせます。トークンは 33 文字です。クライアントは現在のユーザーのプロファイルにトークンを保存するため、次回からは localtonet だけで起動できます。
--authtokenがなく、保存済みのトークンもない場合、クライアントはPlease Enter AuthToken or PINと尋ねます。トークン、またはダッシュボードがトークンに対して表示する 6 桁の PIN を入力できます。- 有効なトークンでない値には
Wrong Token!と応答し、再度入力を求めます。 - クライアントの実行中に F12 を押すと、保存済みのトークンを削除して終了します。Ctrl + C はトークンを残したまま終了します。
- ダッシュなしの従来の書き方
authtoken <YOUR_TOKEN>も引き続き使えます。
トークンは他人に見せないでください。トークンがあれば、Localtonet クライアントがこのデバイスとして接続できてしまいます。トークンはデバイスごとに 1 つ使ってください。同じトークンで 2 つ目のクライアントが接続すると、1 つ目は切断されます。
--ephemeral-token #
localtonet --authtoken <YOUR_TOKEN> --ephemeral-tokenトークンを今回の実行のみで使います。クライアントはトークンを保存設定に書き込まず、すでに保存されているトークンも変更しません。自動化や一時的なセッションに使ってください。
サービス管理 #
これらのオプションは、クライアントを Windows のサービス、macOS の launchd、Linux の systemd に登録します。管理者権限(macOS と Linux では sudo)が必要で、サービス名がトークンに基づくため、どのオプションにもトークンが必要です。詳しいガイドはサービスとして実行をご覧ください。
| オプション | 動作 | 例 |
|---|---|---|
--install-service | クライアントを起動時に開始するサービスとしてインストールし、開始します。コマンドラインの他のオプションはサービスに保存されます。 | localtonet --install-service --authtoken <YOUR_TOKEN> |
--start-service | インストール済みのサービスを開始します。 | localtonet --start-service --authtoken <YOUR_TOKEN> |
--stop-service | サービスを停止します。 | localtonet --stop-service --authtoken <YOUR_TOKEN> |
--status-service | サービスの状態を出力します。例: Running、Stopped、NotFound。 | localtonet --status-service --authtoken <YOUR_TOKEN> |
--remove-service | サービスを停止して削除します。 | localtonet --remove-service --authtoken <YOUR_TOKEN> |
サービスオプションはヘッドレスモードでは使えません。
ヘッドレスモード #
ヘッドレスモードは、コンテナー、init システム、スクリプト向けです。クライアントは質問をせず、キー入力にも反応せず、トークンを保存せず、ステータス表の代わりに変化ごとに 1 行のシンプルなログを出力します。Docker イメージと Linux および OpenWrt のパッケージは、この方式でクライアントを実行します。
--headless #
localtonet --headless --authtoken-file /etc/localtonet/auth-tokenクライアントをヘッドレスモードで起動します。環境変数 LOCALTONET_HEADLESS=1 を設定しても同じ効果があります。終了シグナルを受け取ると、クライアントは正常に停止します。
トークンは次のいずれかの取得元から読み込まれます。
| 取得元 | 備考 |
|---|---|
--authtoken-file <PATH> | トークンだけを含むファイル。前後のスペースや改行は無視されます。 |
LOCALTONET_AUTH_TOKEN_FILE | そのファイルのパスを指定する環境変数。--authtoken-file が指定されていない場合に使われます。 |
--authtoken <TOKEN> | コマンドラインで直接指定するトークン。 |
LOCALTONET_AUTH_TOKEN | トークンを指定する環境変数。--authtoken が指定されていない場合に使われます。 |
トークンファイルは、直接渡されたトークンより常に優先されます。トークンファイルが指定されていても読み込めない場合、クライアントは停止し、他の取得元にはフォールバックしません。
使用可能なトークンが見つからない場合、クライアントは Invalid Localtonet headless configuration. Check the token file or environment settings. と出力し、終了コード 2 で終了します。使用可能なトークンは 33 文字で、スペースを含みません。
--authtoken-file #
localtonet --headless --authtoken-file <PATH>コマンドラインの代わりにファイルからトークンを読み込むため、プロセス一覧やシェルの履歴にトークンが残りません。ファイルは chmod 600 などで保護してください。このオプションはヘッドレスモードでのみ読み込まれます。
--check-config #
localtonet --headless --authtoken-file /etc/localtonet/auth-token --check-config接続せずに、トークンの取得元を確認して終了します。形式が正しいトークンが見つかれば Localtonet headless configuration OK. を出力して終了コード 0 で終了し、見つからなければ上記のエラーを出力して終了コード 2 で終了します。この確認はローカルで行われ、Localtonet がそのトークンを受け入れるかどうかは分かりません。必ず --headless(または LOCALTONET_HEADLESS=1)と組み合わせてください。単独では無視されます。
ヘッドレスのログ #
| 行 | 意味 |
|---|---|
Localtonet - headless log | クライアントが起動しました。 |
Connection: … | 接続状態が変化しました。 |
AuthTokenName: … | デバイスがサインインに使ったトークンの名前です。 |
OPEN …, ADDED … | 開始時に存在した、または後から追加されたトンネルです。 |
STATUS … | トンネルのステータスが変化しました。 |
CLOSED … | トンネルがこのクライアントから削除されました。 |
Authentication failed: AuthToken was rejected. | Localtonet がトークンを受け入れませんでした。 |
最初の行以外は、すべてタイムスタンプで始まります。トークンがログに書き込まれることはありません。
ネットワーク選択 #
イーサネットとモバイルモデムなど、インターネット接続が複数あるデバイスでは、クライアントが使う接続を選べます。この機能とトンネルごとの設定については、ネットワーク選択のページで説明しています。
--network #
localtonet --network有効なネットワークインターフェースをアドレスとともにすべて一覧表示し、各 IPv4 アドレスがインターネットに到達できるかを確認して終了します。各行は、そのまま渡せるオプションの形式で出力されます。
NetworkName: Ethernet
--net Ethernet --ip 192.168.1.20 --> Internet available (public IP 203.0.113.10)
--------------------------------------------------
NetworkName: Mobile
--net Mobile --ip 10.20.30.40 --> No internet access
--------------------------------------------------IPv6 アドレスは IPv6, internet check not available と表示されます。
--net と --ip #
localtonet --authtoken <YOUR_TOKEN> --net Ethernet --ip 192.168.1.20クライアント全体を 1 つのネットワークインターフェースに固定します。--net はインターフェース名、--ip はそのインターフェースのアドレスで、--network が出力するとおりに指定します。両方を同時に指定する必要があります。スペースを含むインターフェース名は、そのままでも引用符で囲んでも指定できます。
- ペアを適用できない場合、クライアントはインターフェースが立ち上がるまで最大 30 秒待ちます。これは起動時の開始に役立ちます。それでも適用できなければ、理由を表示し、終了コード 2 で停止します。別のネットワークで続行することはありません。
- 2 つのオプションの一方だけが指定された場合、クライアントは
--net and --ip must be given together; the default network is used.と出力し、固定なしで続行します。 - Linux では、クライアントが固定したアドレス用のルーティングルールを追加します。そのため root 権限、またはパスワードなしで
ipコマンドを実行できるsudoが必要です。
| メッセージ | 意味 |
|---|---|
Network interface '…' was not found. Run 'localtonet --network' to list the interfaces. | --net の後の名前がどのインターフェースとも一致しません。 |
Network interface '…' is Down. | インターフェースは存在しますが、起動していません。 |
'…' is not an address of network interface '…'. | --ip の後のアドレスが、そのインターフェースに属していません。 |
'…' is not an IP address. | --ip の後の値が IP アドレスではありません。 |
クライアント全体ではなく 1 つのトンネルだけ別の接続を使うには、そのトンネルの引数設定に同じペアを指定します。
送信プロキシ #
デバイスがプロキシ経由でしかインターネットに到達できない場合に、これらのオプションを使います。クライアント自身の Localtonet への接続に適用されます。クライアントがローカルサービスに到達する方法は変わりません。
--proxy #
| 値 | 動作 |
|---|---|
指定なし、または none | 直接接続します。プロキシの環境変数は無視されます。 |
env | 後述のプロキシ環境変数を使います。どれも設定されていない場合や、いずれかが無効な場合、クライアントは直接接続せずにエラーで停止します。 |
| プロキシ URL | すべての通信にそのプロキシを使います。対応するスキームは http://、https://、socks5://、socks5h:// です。 |
localtonet --authtoken <YOUR_TOKEN> --proxy http://proxy.example.com:3128
localtonet --authtoken <YOUR_TOKEN> --proxy socks5h://proxy.example.com:1080
localtonet --authtoken <YOUR_TOKEN> --proxy env| スキーム | 動作 | デフォルトポート | 認証 |
|---|---|---|---|
http:// | HTTP プロキシ。CONNECT を使います。 | 80 | なし、または Basic |
https:// | まずプロキシへの検証済み TLS 接続を開き、その後 CONNECT を使います。 | 443 | なし、または Basic |
socks5:// | SOCKS5、TCP と UDP。ホスト名はお使いのデバイスで解決されます。 | 1080 | なし、またはユーザー名とパスワード |
socks5h:// | SOCKS5、TCP と UDP。ホスト名はプロキシで解決されます。 | 1080 | なし、またはユーザー名とパスワード |
プロキシのホストには、IPv4 アドレス、ホスト名、または角括弧で囲んだ IPv6 アドレスを指定できます。認証情報は user:password@host:port の形で URL に含められます。その中の特殊文字は URL エンコードしてください。デバッグ出力に認証情報が含まれることはありません。
--proxy-user #
localtonet --authtoken <YOUR_TOKEN> --proxy socks5h://proxy.example.com:1080 --proxy-user <PROXY_USER>プロキシのユーザー名を設定し、パスワードは非表示のプロンプト(Proxy password:)で尋ねるため、パスワードがコマンドラインに残りません。パスワードは保存されません。
--proxy envまたはプロキシ URL が必要で、URL 内の認証情報とは併用できません。- 対話型ターミナルでのみ動作します。ヘッドレスモードとサービスはプロンプトを出しません。認証情報をプロキシ URL に含めるか、認証情報入りのプロキシ URL とともに
--proxy envを使ってください。 --install-serviceは、サービスが保存できないため、--proxy-userとパスワード付きのプロキシ URL を受け付けません。--proxy envでサービスをインストールし、サービスの環境で変数を指定してください。
プロキシ環境変数 #
これらは --proxy env のときだけ読み込まれます。接続の種類ごとに、設定されている最初の変数が使われます。
| 接続 | 変数(優先順) |
|---|---|
| HTTP と WebSocket | http_proxy, HTTP_PROXY, all_proxy, ALL_PROXY |
| HTTPS とセキュア WebSocket | https_proxy, HTTPS_PROXY, all_proxy, ALL_PROXY |
| 生の TCP と UDP | all_proxy, ALL_PROXY, https_proxy, HTTPS_PROXY, http_proxy, HTTP_PROXY |
no_proxy(小文字が未設定なら NO_PROXY)には、直接接続するホストを列挙します。
- 項目はカンマで区切ります。ホストまたはドメインは、そのもの自身とサブドメインに一致します。照合では大文字と小文字、および先頭のドットは無視されます。
- IP アドレスは完全一致です。IPv6 アドレスは角括弧で囲んでも構いません。
*はすべてのホストでプロキシを迂回します。 - アドレス範囲(CIDR)、ポート付きの項目、部分的なワイルドカードには対応しておらず、設定エラーとして報告されます。
- プロキシ URL を渡した場合や直接接続する場合、
no_proxyは効果がありません。
--http-transport #
localtonet --authtoken <YOUR_TOKEN> --proxy http://proxy.example.com:3128 --http-transport httpsプロキシが通常のウェブトラフィックしか通さない場合に、クライアントがサーバー接続を運ぶ方法を制御します。HTTPS トランスポートでは、プロキシ経由で長時間の生の接続を開く代わりに、通常の HTTPS リクエストとして Localtonet ゲートウェイにトラフィックを送ります。
| 値 | 動作 |
|---|---|
auto(デフォルト) | HTTP または HTTPS プロキシ経由の場合、サーバーが対応していれば HTTPS トランスポートを優先し、そうでなければ CONNECT を使います。SOCKS5 プロキシ経由の場合は、まずネイティブの TCP と UDP を使い、同じプロキシ経由の HTTPS トランスポートにフォールバックすることがあります。 |
https | サーバー接続に HTTPS トランスポートを必須とします。 |
raw | HTTPS トランスポートを一切使わず、CONNECT または SOCKS のみを使います。 |
それ以外の値を指定すると、クライアントは LOCALTONET_HTTP_TRANSPORT_MODE must be auto, https or raw. と出力して停止します。
デバイスターミナル #
デバイスターミナルを使うと、ダッシュボードまたは SSH から、ご自身のデバイスでシェルを使えます。Windows、Linux、macOS で動作し、Localtonet Desktop v8.6 以降が必要です。機能の詳細はデバイスターミナルのページをご覧ください。ここではコマンドライン側の部分を説明します。
--terminal #
localtonet --terminal enable --authtoken <YOUR_TOKEN>
localtonet --terminal status --authtoken <YOUR_TOKEN>
localtonet --terminal disable --authtoken <YOUR_TOKEN>| 値 | 動作 |
|---|---|
enable | このデバイスをアカウントとペアリングします。コマンドは承認コードを表示して待機します。マイデバイスを開き、デバイスを追加を選んでコードを入力してください。コードの有効期間は 15 分です。承認後、コマンドは Terminal enabled. Shells will run as <account>. と出力します。 |
disable | このデバイスのターミナルをオフにし、アカウントからデバイスを削除します。ダッシュボードに接続できない場合でも、ターミナルはローカルでオフになり、ダッシュボードでもデバイスを削除するようコマンドが案内します。 |
status | ターミナルが有効かどうかと、どのアカウントでシェルが実行されるかを出力します。 |
3 つの形式とも、通常の起動と同様にトークンが必要です。--authtoken を渡すか、省略して保存済みのトークンを使ってください。Localtonet がデバイス上でサービスとして動いている場合は、管理者ターミナルから、または sudo でコマンドを実行してください。対話型ターミナルでは、このトークンの Localtonet がすでにデバイス上で動いていない限り、enable の後もクライアントは通常のクライアントとして動き続けます。
--terminal-user #
sudo localtonet --terminal enable --authtoken <YOUR_TOKEN> --terminal-user <ACCOUNT>root または管理者としてターミナルを有効にするとき、シェルを実行するアカウントを指定します。指定しない場合、昇格した enable は Run shells as user: と尋ねます。何も尋ねられないスクリプトでは Choose the account for shells with --terminal-user. と出力して停止します。昇格していないコマンドは、--terminal-user がなければ現在のユーザーを使います。
--pairing-key #
localtonet --terminal enable --authtoken <YOUR_TOKEN> --terminal-user <ACCOUNT> --pairing-key <PAIRING_KEY>スクリプトで構築したサーバーなど、承認コードを読み取れる人がいないデバイスをペアリングします。キーは、マイデバイスのデバイスを追加にあるワンタイムキーを作成で作成します。有効期間は 1 時間で、1 回だけ使えます。ペアリングキーを使うと、コマンドはコードを表示せず、承認も待ちません。
localtonet ssh #
localtonet ssh <DEVICE>
localtonet ssh <DEVICE> -- uptime
localtonet ssh <DEVICE> --key <ACCESS_KEY> -- uptimeお使いのデバイスでシェルを開くか、1 つのコマンドを実行してその終了コードを返します。<DEVICE> はマイデバイスに表示されるデバイス名です。ssh は localtonet の直後の最初の単語である必要があります。
| 部分 | 動作 |
|---|---|
-- <COMMAND> | シェルを開く代わりにコマンドを実行します。-- 以降がすべてコマンドです。 |
--key <ACCESS_KEY> | マイデバイスのキーで作成した、デバイスのアクセスキーです。キーを使うと、ブラウザーでの承認は不要です。 |
--stdio | シェルを開きません。標準入力と標準出力を通じて、デバイスへの生の接続を運ぶだけで、SSH クライアントの ProxyCommand として使います。 |
キーがない場合、コマンドは Approve this connection in your browser: とリンクを出力し、承認を最大 5 分間待ちます。接続が承認されなければ、The connection was not approved. で終了します。
診断と情報 #
--debug #
localtonet --debug --proxy env --authtoken <YOUR_TOKEN>標準エラーに接続診断を出力します。使用中のプロキシルートとその設定の取得元、DNS モード、ハンドシェイクの結果、UDP の状態です。認証情報とリクエスト本文は含まれません。--debug はクライアントをヘッドレスモードにも切り替えるため、プロンプトは表示されません。これはフラグで、値は取りません。
--version #
localtonet --versionクライアントのバージョン(例: v8.6)を出力して終了します。
--help #
localtonet --help組み込みヘルプを出力して終了します。-h も同じ動作です。
環境変数 #
| 変数 | 効果 |
|---|---|
LOCALTONET_HEADLESS | 1 でヘッドレスモードをオンにします。 |
LOCALTONET_AUTH_TOKEN | ヘッドレスモードでのトークンです。 |
LOCALTONET_AUTH_TOKEN_FILE | ヘッドレスモードでのトークンファイルのパスです。 |
http_proxy、https_proxy、all_proxy、no_proxy とその大文字の形式 | プロキシ設定です。--proxy env のときのみ有効です。 |
終了コード #
| コード | 意味 |
|---|---|
0 | コマンドが正常に完了しました。 |
1 | デバイスターミナルのコマンドが失敗しました。例: 承認コードの期限切れ、デバイスに到達できない場合。 |
2 | オプションが間違っているか値がない、ヘッドレスのトークンが使えない、または --net と --ip のペアを適用できませんでした。 |
localtonet ssh <DEVICE> -- <COMMAND> は、リモートコマンドの終了コードを返します。
例 #
localtonet --authtoken <YOUR_TOKEN>sudo localtonet --install-service --authtoken <YOUR_TOKEN>
sudo localtonet --status-service --authtoken <YOUR_TOKEN>docker run -d --restart unless-stopped -e LOCALTONET_AUTH_TOKEN=<YOUR_TOKEN> localtonet/localtonetlocaltonet --network
localtonet --authtoken <YOUR_TOKEN> --net Mobile --ip 10.20.30.40export all_proxy=http://proxy.example.com:3128
localtonet --authtoken <YOUR_TOKEN> --proxy env