Runetale Logo

CLIの使い方

はじめに

Runetaleではrunetaledrunetaleの2つのCLIコマンドを提供しています。このドキュメントでは、それぞれのコマンドの使い方を解説します。

2つのコマンドの違いについて

runetaledはWireGuardを使用したP2P通信の接続とネットワークの調整、サーバーからの通信をリアルタイムで受信します。 runetaleはrunetaledのAPIにアクセスすることで、機能を提供したり様々な設定を管理します。

デスクトップアプリとモバイルアプリ

デスクトップアプリとモバイルアプリでは、この2つのコマンドを内部で実行されています。

利用可能コマンド一覧

runetale

Login

runetale loginコマンドは、RunetaleのSSOログインを行うためのコマンドです。

ログインが完了している場合は、割り振られているIPアドレスが表示されます。

ログインしていない場合、ログインを行うためのログインURLが表示されます。

    sudo runetale login

Ping

runetale pingコマンドは、Runetale独自のPingを実施するためのコマンドです。 同コマンドを用いて、たとえばユーザースペースで動作しているRunetaleのノードに対してPingを送信することができます。

通常のpingコマンドは、ホストのネットワークスタックまでパケットが到達しないため、うまく動作しないことがあります。 一方、runetale pingコマンドは、プライベートインターネット空間でのみPingを送信、接続を確認することが可能となっています。

これは、Runetaleがユーザースペース空間で動いている限り、全てのネットワークトラフィックをRunetaleがキャプチャし、パケット変換しているためです。

    sudo runetale ping <target ip>

Up

runetale upコマンドはrunetaledを介さずにrunetaleを起動します。 内部的にrunetaledをrunetaleのプロセスから呼び出すことで簡単にrunetaleを起動できます。

Down

runetale downコマンドはrunetaledを介さずにrunetaleを終了します。 内部的にrunetaledをrunetaleのプロセスから終了します。

Status

runetale statusコマンドはrunetaleのノード情報を表示します。 runetaleが起動している時に使用できます。

runetaled

Up

runetaled upコマンドはrunetaledの起動を行います。

直接立ち上げることで、より詳細な出力を得られます。

Daemon

2つのコマンドの違いについて

現在runetale daemonはmacOSとLinuxのみ対応しています。 次のリリースでWindowsサブプロセスに対応するのでお待ちください。

runetaled daemon installはrunetaledのデーモンを直接インストールします。

runetaled daemon uninstallはrunetaledのデーモンを直接アンインストールします。

Last updated on

On this page