olares-settings について
olares-settingsは、`olares-cli settings`でOlaresの設定を扱うスキルです。アカウント、アプリ、ネットワーク、バックアップ、外観、システムを対象とし、操作に必要なバージョンやロールの条件も示します。
主な機能
- 01現在のユーザーとOlaresのバージョンを確認
- 02アプリ設定の読み取りと変更
- 03ユーザーと連携アカウントの管理
- 04VPN、ネットワーク、バックアップの設定
- 05外観、検索、復元オプションの確認
- 06ロールとバージョンの制限を確認
活用シーン
- 01アクティブなプロファイルとバージョンの確認
- 02アプリのエントランスや環境設定の変更
- 03VPN、バックアップ、連携設定の確認
- 04設定が現在のバージョンで使えるか確認
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ beclab/ olares --skill olares-settingsインストール後、Claude Code で/olares-settingsを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
references/olares-settings-appearance.mdolares-settings-apps-entrance.mdolares-settings-apps.mdolares-settings-backup.mdolares-settings-cookies.mdolares-settings-integration.mdolares-settings-users.mdolares-settings-vpn.md詳細
settings(Olares Settings UI のミラー)
共通の入口: スイート内のルーティング、アクティブなプロファイルの選択、プラットフォームのエントリーポイント、認証の続行/停止ゲートについては、
../olares-shared/SKILL.mdを読み込んでください。認証リファレンスは、ログイン、プロファイルの切り替え、トークンの保存、または認証の復旧が実際に必要な場合にのみ読み込んでください。
バージョンの意味がタスクに影響する場合は、共通のプラットフォームモデルを読み込んでください。構文は olares-cli settings <area> <verb> --help を使用して確認します。
使用する場面
- Settings UI の構成を反映する場合:ユーザー、アプリのエントランス/環境変数/ドメイン/ポリシー、インテグレーション、VPN、ネットワーク、アクセラレーター、検索インデックス作成、バックアップ/復元、外観、動画、詳細ステータス。
- 現在のアイデンティティ、Olares のバージョン、更新、または SSO セッションを確認する場合。
- サポートされているインストール後の構成変更を行う場合。
基本モデル:
settingsは、Olares Settings SPA が公開する構成を扱います。つまり、インストール後のアプリごとの構成、メッシュ/VPN、バックアップ、アカウント、システムの外観です。ライフサイクルとランタイムは、別のスキルで扱います。
すぐに使える手順
| タスク | 参照先 | 最初のコマンド |
|---|---|---|
| このプロファイルのユーザーとバージョンを確認する | このファイル | olares-cli settings me version -o json |
| 1 つのアプリの構成を読み取る、または変更する | インストール後のアプリ構成 | olares-cli settings apps get <app> -o json |
| クラウドアカウントが紐付いているか確認する | インテグレーションアカウント | olares-cli settings integration accounts list -o json |
| この Olares のユーザー一覧を確認する | ユーザーのライフサイクルとパスワードの取り扱い | olares-cli settings users list -o json |
動詞インデックス
| 領域 | 動詞/リソース | トリガーされたときに読む内容 |
|---|---|---|
me | whoami、version、check-update、sso list | 他のスキルでバージョンを確認する必要がある場合は、me version で確認します |
users | me、list、get、create、delete | ユーザーのライフサイクルとパスワードの取り扱い |
apps | list/get、entrances、env、suspend/resume | インストール後のアプリ設定 |
apps(1 つのエントランス) | domain、policy、auth-level | エントランスごとの設定 |
vpn | devices、非表示の routes enable/disable、SSH、subroutes(非表示の enable/disable)、ACL、public-domain-policy | VPN と ACL の判断 |
integration | account list/get/add/delete、cookie import/list/rm/validate | 連携アカウント、Cookie ストア |
backup | plans、snapshots、password | バックアップの判断 |
appearance | get(ページ全体)、language set、widget set、wallpaper list/set/style/upload/delete、layout reset | 外観と壁紙 |
network | reverse-proxy、FRP、hosts-file、overlay gateway/app | オーバーレイへの書き込みは非同期で、アプリごとの設定ではアプリが再起動する場合があります。ゲートウェイのマスター設定と reverse-proxy の設定はオーナー専用です |
gpu / compute | 従来の GPU リスト/アクセラレーターのリスト、unbind、set-type | どちらが利用可能かはバージョンによって異なります。1.12.5 では gpu、1.12.6 以降では compute です |
video | config get | 読み取り専用です。設定できる項目はありません |
search | status、rebuild、dirs list/add/rm | インデックスの対象範囲については olares-search を参照してください |
restore | plans list/check-url/create-from-snapshot/create-from-url/cancel | 復元はここから開始しますが、復元元のスナップショットは backup の下に一覧表示されます |
advanced | status、registries、images、system/user env | 管理者専用です。環境変数を書き込む動詞は env system set と env user set です(「env update」はありません)。どちらも --var KEY=VALUE を指定し、位置引数の KEY=VALUE は拒否されます。ここにあるイメージの一覧には、olares-doctor がワークロードの参照情報を付記します |
ロールのキャッシュと管理者/一般ユーザーの基準
- ロールは
normal、admin、ownerです。アクティブなプロファイルにはロールがキャッシュされます。キャッシュがない場合やロールが変更された場合は、サーバーが正となります。 - 管理者専用の領域には、ユーザー管理、アクセラレーター管理、高度なマシン状態、特権が必要な VPN/ネットワークの読み取りが含まれます。オーバーレイゲートウェイのマスター設定の有効化/無効化と reverse-proxy の設定は、オーナー専用です。
profile whoami、settings users me、settings me whoamiは同等の ID 表示です。いずれかが他より正確であるかのように、別のコマンドへ誘導しないでください。
バージョンと非同期処理に関する判断
- Olares 1.12.5 では従来の
gpu listを使用します。1.12.6 以降ではcomputeを使用します。 - オーバーレイゲートウェイとアプリごとのオーバーレイ操作には、1.12.6 以降が必要です。
appearance widget setとappearance layout resetには、1.12.6 以降が必要です。appearance getは代わりに機能を縮退させ、ウィジェットのセクションが利用条件の対象であることを報告します。appearance language setが受け付ける 7 つのロケールのうち 5 つには、1.12.7 以降が必要です。- オーバーレイへの書き込みは非同期です。
--watchで、ゲートウェイ/アプリの状態が安定するまで監視できます。アプリごとのオーバーレイの変更では、Market を通じて実行中のアプリが再起動する場合があります。 - 検索のインデックス作成と再構築は非同期です。リクエストが成功しても、新たにインデックス化されたコンテンツがすぐに検索可能になるとは限りません。
安全とエスカレーション
- アクセストークン、SSO セッションフィールド、初期パスワード、連携の認証情報、バックアップパスワード、VPN シークレットをチャットやコマンド履歴に決して公開しないでください。
- 選択した動詞がサポートする場合は、標準入力または環境変数からシークレットを読み取ってください。
- 要求された設定変更はタスク範囲内の承認として扱ってください。その範囲内の冪等な書き込みごとに、再度確認を求めないでください。
- 破壊的な操作や、より広範な影響を伴う操作については、個別に確認してください。対象には、ユーザーの削除、ACL の置き換え、アクセラレーターのバインド解除や種類変更、アプリの再起動/停止、インデックスの再構築、ゲートウェイ全体に適用されるオーバーレイの変更が含まれます。
- アプリのライフサイクルに関する要求は、設定ではなく
olares-marketとして扱ってください。 - ログインがないためにダウンロードや収集が失敗した場合は、
olares-knowledgeの問題ではなく、ここでの Cookie のインポートです(settings integration cookie)。詳しくはcookie storeを参照してください。 - テーマを設定する動詞はありません。デスクトップのライト/ダーク状態は、SPA が上流に送信しない Cookie であるため、CLI では変更できません。動詞を探し回ったり、何も読み取らない
OLARES_USER_THEMEを書き込んだりせず、その旨を報告してください。 - 要求された動詞が登録されていない場合、ロールの権限が不足している場合、対象ユーザー/アプリ/デバイスを特定できない場合、または CLI では実行できない JWS/デバイス操作が必要な場合は、そこで停止してください。
コメント
Markdown 対応