コンテンツにスキップ

obscli ユーザーマニュアル

obscli は Beak のコマンドラインクライアントです。インストールしてログインすると、以下の操作が可能です:

  1. アカウントで利用可能なすべてのワークスペース、Agent、およびタスクを表示します。
  2. 選択したワークスペースで、新しいタスクを作成するか、既存のタスクを継続します。
  3. Agent とチャットし、観測リソースを参照し、Skill を選択する。
  4. スクリプトからワンショットタスクを送信し、結果を収集する。
  5. ログインしてから、そのノードやコンテナ内のAgentとプライベートモードでチャットを行うことができます。

obscli のインストール

設定センターからのインストール(推奨)

Obsy Agent Teamsページ上で、右上隅のアバターをクリックし、個人設定 > 開発ツール > obs-cliを開きます。

  1. macOS、Linux、またはWindowsを選択してください。
  2. コマンドをコピールをクリックしてください。
  3. obscliを使用する端末で、そのコマンドを実行してください。
  4. インストール後にobscliを実行し、現在のワークスペース内にAgentsが表示されていることを確認してください。

生成されたコマンドには、接続に必要な認証情報が含まれています。個人のアクセス認証情報を手動でコピーする必要はありません。

インストーラースクリプトによるインストール

Linux および macOS

以下を実行します:

curl -fsSL https://static.guance.com/obscli/install-obscli.sh | bash -s -- \
  --release-base-url https://static.guance.com/obscli \
  --beak-server https://agent-api.guance.com \
  --login <YOUR-USER-SK>

Linux/macOS ではデフォルトで Unix パスが使用されます:

種別 デフォルトパス
インストールディレクトリ ~/.local/bin
実行ファイル ~/.local/bin/obscli
データディレクトリ ~/.obscli
ログインおよび更新設定 ~/.obscli/login.toml
ログディレクトリ ~/.obscli/log
現在のログファイル ~/.obscli/log/obscli.log

インストール後に obscli が使用できない場合は、インストールディレクトリを PATH に追加してください:

export PATH="$HOME/.local/bin:$PATH"

WSL は Linux 環境であり、同じコマンドとパスを使用します。

Windows PowerShell

以下を実行します:

iwr https://static.guance.com/obscli/install-obscli.ps1 -OutFile $env:TEMP\install-obscli.ps1
Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass -Force
& $env:TEMP\install-obscli.ps1 `
  -ReleaseBaseUrl https://static.guance.com/obscli `
  -BeakServer https://agent-api.guance.com `
  -Login <YOUR-USER-SK>

Windows では obscli はデフォルトで以下のパスにインストールされます:

%LOCALAPPDATA%\Programs\obscli\obscli.exe

インストール後、PowerShell を再度開いて以下を実行します:

obscli

PowerShell を再度開けない場合は、フルパスを直接実行してください:

& "$env:LOCALAPPDATA\Programs\obscli\obscli.exe"

Windows のデフォルトディレクトリ:

種別 デフォルトパス
インストールディレクトリ %LOCALAPPDATA%\Programs\obscli
実行ファイル %LOCALAPPDATA%\Programs\obscli\obscli.exe
データディレクトリ %USERPROFILE%\.obscli
ログインおよび更新設定 %USERPROFILE%\.obscli\login.toml
ログディレクトリ %USERPROFILE%\.obscli\log
現在のログファイル %USERPROFILE%\.obscli\log\obscli.log

Windows では PowerShell の使用を推奨します。Git Bash は独自の $HOME を使用してパスを解釈するため、Git Bash を使用する場合はインストールディレクトリを明示的に指定してください:

curl.exe -fsSL https://static.guance.com/obscli/install-obscli.sh | bash -s -- \
  --release-base-url https://static.guance.com/obscli \
  --install-dir "$HOME/bin" \
  --beak-server https://agent-api.guance.com \
  --login <YOUR-USER-SK>

オフラインパッケージによるインストール

システムに対応するパッケージをダウンロードします。例:

obscli-linux-amd64-v1.2.3.tar.gz
obscli-darwin-arm64-v1.2.3.tar.gz
obscli-windows-amd64-v1.2.3.tar.gz

検証してインストールします:

sha256sum -c obscli-linux-amd64-v1.2.3.tar.gz.sha256
bash install-obscli.sh --archive ./obscli-linux-amd64-v1.2.3.tar.gz --install-dir "$HOME/.local/bin" --yes

obscli のアンインストール

再インストール前に旧名称からの移行

旧名称の obsycli がこのマシンにインストールされている場合、obscli で直接上書きしないでください。まず旧実行ファイルと旧データディレクトリを削除してから、本ドキュメントのインストールセクションに従って新しい obscli を再インストールしてログインしてください。

Linux/macOS/WSL:

以下のいずれかのコマンドを選択してください。最初のコマンドはファイル削除前に確認を求め、2 番目のコマンドは --yes で確認をスキップします:

curl -fsSL https://static.guance.com/obs-agent/uninstall-legacy.sh | sudo bash
curl -fsSL https://static.guance.com/obs-agent/uninstall-legacy.sh | sudo bash -s -- --yes

このスクリプトは beak-agent からのリネーム前の固定システムレイアウトをクリーンアップします。また、旧 obsycli の一般的な Linux/macOS インストール場所(/usr/local/bin/obsycli、/usr/bin/obsycli、~/.local/bin/obsycli、および現在の HOME と SUDO_USER ホーム配下の ~/.obsycli)も削除します。

Windows PowerShell:

Get-Command obsycli -All
Remove-Item "$env:LOCALAPPDATA\Programs\obsycli\obsycli.exe" -Force -ErrorAction SilentlyContinue
Remove-Item "$env:LOCALAPPDATA\Programs\obsycli" -Recurse -Force -ErrorAction SilentlyContinue
Remove-Item "$env:USERPROFILE\.obsycli" -Recurse -Force -ErrorAction SilentlyContinue

旧バージョンを削除した後、本ドキュメントの obscli インストールコマンドで再インストールしてください。obscli は ~/.obscli または %USERPROFILE%\.obscli を使用し、旧 obsycli のローカル設定は読み込みません。

現在のバージョンのアンインストール

Linux/macOS:

which -a obscli
rm -f ~/.local/bin/obscli
rm -rf ~/.obscli

sudo でシステムディレクトリにインストールした場合:

sudo rm -f /usr/local/bin/obscli
rm -rf ~/.obscli

Windows PowerShell:

Get-Command obscli -All
Remove-Item "$env:LOCALAPPDATA\Programs\obscli\obscli.exe" -Force -ErrorAction SilentlyContinue
Remove-Item "$env:LOCALAPPDATA\Programs\obscli" -Recurse -Force -ErrorAction SilentlyContinue
Remove-Item "$env:USERPROFILE\.obscli" -Recurse -Force -ErrorAction SilentlyContinue

obscli.exe を別のディレクトリに配置した場合は、Get-Command obscli -All で表示されるファイルを削除してください。

Windows Git Bash:

which -a obscli
rm -f "$HOME/bin/obscli.exe"
rm -rf "$HOME/.obscli"

WSL:

which -a obscli
rm -f ~/.local/bin/obscli
rm -rf ~/.obscli

ローカルデータディレクトリにはログイントークン、更新設定、およびログが含まれています。削除後は再度ログインが必要です。

Beak へのログイン

Beak の Web ページからユーザー sk をコピーし、以下を実行します:

obscli --login <YOUR-USER-SK> --beak-server https://agent-api.guance.com

テスト環境の証明書がマシンで信頼されていない場合は、以下を追加します:

obscli --login <YOUR-USER-SK> --beak-server https://agent-api.guance.com --insecure-skip-tls-verify

ログイン成功後、認証情報は以下に書き込まれます:

~/.obscli/login.toml

その後 obscli を直接実行すると、対話型チャットに入ります。

地元のAgentとプライベートでチャットする

LinuxまたはmacOSノード上で、obs-agentを実行している場合、またはそのコンテナ内では、プライベートモードではUnixソケットが使用されます。Agentは、Beak接続、Profile同期処理、ハートビート、および通常のWeb、IM、CLIセッションを保持します。

個人の認証情報でログインしてください。通常モードとプライベートモードでは、このログイン設定は共通です。プライベートモードでは、自動的にAgentや管理者の認証情報を使用しません。

obscli --login <YOUR-USER-SK> --beak-server https://agent-api.guance.com
obscli --private

ローカルな obs-agent が実行されている必要があります。デフォルトのソケットは /var/lib/obs-agent/private.sock です。ソケットがない、接続に失敗した、またはアクセスが拒否された場合、エラーが発生します。クライアントはリモートの Agent に切り替わりません。ネイティブの Windows はサポートされていません。

同じオペレーティングシステムアカウント内で、異なる個人アイデンティティ用の設定ディレクトリを別々に使用する:

obscli --login <YOUR-USER-SK> --beak-server https://agent-api.guance.com --config-dir ~/obscli-personal
obscli --private --config-dir ~/obscli-personal

通常のモードとの違い

商品/物品 通常モード プライベートモード
開始 obscli obscli --private
チャットと保存 Beakは、セッションを送信し、保存します。 ローカルソケート;セッションのアイデンティティ、タイトル、メッセージ、ツールのイベント、および履歴はノード上に保持され、Beakにアップロードされません。
/agents 通常モード:すべてのワークスペースで利用可能なAgentsを一覧表示します。プライベートモード:ローカルに保存されているAgentのみを表示します。
/tasks, /newtask, /attach 普通のBeakタスク ローカルなAgent上のプライベートタスク
協力 A2A は、権限内にあります。 A2Aおよびリモートディスカバリー機能は無効化されています。ローカルサブエージェントは、プライベートモードの制限により、引き続き利用可能です。
その他のツール Agentの機能と権限 Beakのアタッチメントの転送、スケジュールされたタスク、Agentの設定の読み取り/書き込み、および診断データのアップロードは禁止されています。ただし、ローカルファイル、コマンド、および許可された外部ツールは引き続き利用可能です。
スクリプト obscli runがサポートされています。 インタラクティブなチャットのみです。obscli runはプライベートモードをサポートしていません。

セッションのリストは別々に保持されます。別のモードからのタスクIDは、他のモードに引き継がれません。プライベートなタスクは、モードを切り替えたり、終了したりした後もプライベートのままです。ストリーミング機能、推論機能、ツールの承認機能、キャンセル機能、再接続機能は引き続き利用可能です。プライベートな作業には、アップグレード時のアイドル保護も適用されます。

セッションの保存と復元

地元のAgentは、個人IDに基づいてプライベートなタスクを持っています。承認された作業は、obscliが退出した後も続きます。承認は再接続を待っています。同じIDでログインし、同じAgentに接続して、履歴を復元できます。Agentの再起動では、地元の履歴がロードされますが、未完了の作業は失敗になります。ツールは再実行されず、古い承認も実行されません。

AGENT_PRIVATE_DATA_DIRは、プライベートデータディレクトリを選択します。デフォルトでは、AGENT_PROFILE_CACHE_DIRと-privateの合計、例えば/var/lib/obs-agent/profile-cache-privateのようになります。

場所 内容
tasks/ セッションデータ、メッセージ、および実行イベント
transcripts/ 実行履歴
work/ プライベートなタスク用のディレクトリ
runtime.log, worker.log ローカル実行時ログ

obscliは、通常は~/.obscli/private/という設定ディレクトリ内に、private/<connection-scope-id>/という場所に別のキャッシュを保持しています。--config-dirはその場所を変更します。このクライアントのキャッシュは、Agentのデータとは別です。セッションを保持するために、Agentのプライベートデータディレクトリをバックアップします。

サービスは依然としてアクセス可能です。

最初の接続や再接続の際、AgentはBeakに個人認証とローカルAgentへのアクセスを確認させることを要求します。もしBeakにアクセスできない場合、新しい接続は失敗します。既存の接続や承認された作業は、一時的な認証の中断中に自動的に停止することはありませんが、個人用のトークンの有効期限が切れると、接続は終了します。

クライアントは、@リソースや$、SkillのリストをBeakから読み取ることができます。これらのクエリには、プライベートメッセージ、下書き、またはセッションIDは含まれていません。選択されたエントリは、メッセージと共にローカルソケートを通じて送信されます。通常のProfile同期は継続されます。プライベートな実行では、準備ができたSkillsおよびMCPの設定が使用されます。

設定されたモデルサービスや外部ツールは、依然として作業に必要な入力データを受け取ることができます。プライベートモードは、別個のオペレーティングシステムのサンドボックスではありません。オペレーティングシステムアカウントを共有するユーザーは、そのアカウントがアクセス可能なファイルを閲覧することができます。

obscli の自動更新

インストーラーでインストールした場合、obscli は起動時に新しいバージョンを確認します。新しいバージョンが利用可能な場合、以下のプロンプトが表示されます:

New obscli version available: v1.2.3 -> v1.2.4. Update now? [y/N]

y または yes を入力すると、obscli は現在のシステム用のパッケージをダウンロードし、.sha256 を検証して、ローカルの実行ファイルを置き換えます。Linux/macOS では更新後に obscli が自動的に再起動します。Windows では現在のプロセスが終了した後に置き換えが完了するため、再度 obscli を実行する必要があります。

現在の環境で起動時の更新チェックを無効にするには、以下を設定します:

export OBSCLI_NO_UPDATE_CHECK=1

よく使うコマンド

コマンド 用途
obscli 対話型クライアントに入る
obscli --private ローカルのAgentとのプライベートなインタラクティブセッションを開きます。詳細はプライベートモードをご覧ください。
/agents 通常モード:すべてのワークスペースで利用可能なAgentsを一覧表示します。プライベートモード:ローカルに保存されているAgentのみを表示します。
/tasks 通常モード:ワークスペース全体で開いているタスクを一覧表示します。プライベートモード:ローカルのプライベートタスクのみを表示します。
/newtask <number> 指定した番号の Agent で Task を作成する
/model または /model select モデルメニューを開いて、「Auto」、「Fast」、「Standard」、「Pro」、または利用可能な特定のモデルと推論設定を選択します。
/model <model-id> [on\|off\|<effort>] 現在のタスクモデルを直接設定することができます。また、特定のモデルに対しては、サポートされている推論機能やレベルを使用することができます。
/attach <number> 既存の Task を開く
/close <number> 現在の Task または指定した番号の Task を閉じる
/compact 現在のタスクで、コンパクトな古い歴史を手動で処理する。
/copy 最新の完成したLLMの最終解答を、ローカルシステムのクリップボードにコピーしてください。
/clear 画面をクリアする
/subagent <task> タスクを複数のサブエージェントに分割するよう Agent に依頼する
/statusline ステータスラインのフィールドを設定し ~/.obscli/config.toml に書き込む
/yolo YOLO/フルアクセスを切り替え、ファイルアクセス制限と承認プロンプトを解除する
/exit 終了する

表中の <number> は /agents または /tasks の # 列に表示される一時的な番号を指します。/newtask <number> は /agents の # 番号を使用し、/attach <number> および /close <number> は /tasks の # 番号を使用します。

/agentsおよび/tasksの両方には、ワークスペースの列が含まれています。/newtask <number>または/attach <number>以降では、現在のセッションは対応するワークスペースに切り替わります。メッセージ、承認、履歴、添付ファイル、@リソース、および$、Skillsは引き続きそのワークスペースを使用します。現在のタスクを閉じると、ログイン設定のデフォルトのワークスペースに戻ります。フッターでは、現在のワークスペース用のworkspace項目と、Agent/タスク用のagent_task項目が別々に表示されます。これらは/statuslineを使用して調整できます。

閉じた Task は新しいメッセージを受信できません。会話を続行するには、新しい Task を作成してください。

読み取り専用のIM検査

通常モードでは、ワークスペースの所有者やwsAdminsは、/tasksを使用して、自分の管理権限内にある通常のIMセッションやIM Botの主要な会話、サブタスクを一覧できます。/attach <number>を使用すると、メッセージ、添付ファイル、ツールの履歴を確認できます。通常のメンバーはこの機能を使用できません。プライベートモードでは、これらのセッションは含まれません。

クライアントは読み取り専用の通知を表示します。履歴を閲覧したり、セッションを切り替えることはできますが、メッセージの送信、アクションの承認、タスクのキャンセルや閉じること、モデルの変更、その他のセッション設定の変更はできません。承認やタスクのアクションは、元のIMチャットで、リクエスターの権限に基づいて処理されます。このビューでは、Web Botのインタラクションは提供されません。

モデルと推論レベルを選択してください。

/modelを実行する際には、タスクを選択して「Auto」「Fast」「Standard」「Pro」、またはAgentがサポートする特定のモデルを選びます。メニューには各モデルの説明と乗数が表示されます。推論設定があるモデルでは、サポートされているレベルや切り替え機能が提供され、デフォルトのレベルは事前に選択されています。メニューをキャンセルしても変更はされません。

また、/model Vendor/Model-A highや/model Vendor/Model-A offと入力することもできます。特定のモデルIDは大文字と小文字を区別します。メニューには、サポートされている推論レベルが表示されます。4つの固定モードでは、auto、auto:fast、auto:standard、auto:advancedを使用し、手動での推論パラメータは使用できません。

再接続により、タスクのモデルと推論設定が復元されます。新しいタスクは、現在のワークスペースでアカウントが最も最近行った明示的な選択を引き継ぎます。モデルが一時的に利用できない場合、メニューはその選択を保持し、現在のターンで自動モードが使用されていることを示します。カタログのエラーには再試行が可能であり、固定モードも利用可能です。

ステータスラインでは、例えばmodel <selected-name>(R:<levels>) -> <true-provider-name>、model MiniMax-M3.1-Flash-Preview(R:on) -> MiniMax/MiniMax-M3.1-Flash-Previewといった形式が使用されます。左側には、選択されたモデルや推論設定が表示されます。例えば、on、off、low、high、またはmaxなどです。右側には、AIHubの名前マッピング後に返される実際のプロバイダーモデルが表示されます。実際のモデル名が受け取られる前には、左側の情報のみが表示されます。(R:...)は、手動の推論設定がない場合は省略されます。

Agent のアクセス制御

/yolo はトグルです:

  • 初回使用時:フルアクセスに入ります。Agent は作業ディレクトリ外のファイルにアクセスでき、ツール呼び出しの承認が不要になります。
  • 2 回目の使用時:通常モードに戻り、ファイルアクセス制限と承認プロンプトが復元されます。

YOLO は現在の Agent と Task のコンテキストを信頼できる場合にのみ有効にしてください。

サブエージェントによる作業分割

タスクを独立した部分に分割できる場合、/subagent <task> を使用して Agent にサブエージェントの優先使用を依頼します。例:

/subagent Check error logs, slow queries, and alert events from the past hour separately, then summarize root-cause clues

obscli は各サブエージェントの開始、待機、完了ステータスを表示します。メインの Agent が最終結果をまとめます。矢印キーで入力履歴から完全なコマンドを呼び出せます。

コンパクトなタスク履歴を手動で管理する

長期にわたるタスクが、モデルコンテキストの制限に近づいた場合、Agentは自動的に古い会話やツールの相互作用を圧縮します。コンテキストスペースを早急に解放するために、現在のタスク内でこのコマンドを実行してください:

/compact

コンパクト化処理では、最近のラウンドトゥルルなやりとりを保持し、古い履歴をまとめた要約に変換します。ただし、タスクを閉じたり、セッションの全てのイベント記録を削除することはありません。obscliでは、セッションの開始と完了の状況が表示されます。もし現在の履歴が保持予算内にある場合、Agentはコンパクト化処理が不要であることを報告します。

最終的な答えをコピーしてください。

現在のタスクで/copyを実行し、最新に完成したLLMの最終回答を、生のMarkdown形式で、obscliを実行しているマシンのシステムクリップボードにコピーします。

/copy

/copyは、どのような引数も受け付けず、最終的な答えのみをコピーします。これには、思考やコメント、ツールの呼び出し、タスクの詳細、サブエージェントの引継ぎ、その他の実行時の詳細は含まれません。plan_finalも、コピ可能な最終答えとして計算されます。診断用のコンテキストを収集するために、Agentに、実行時の詳細をクリップボードを通じてエクスポートするのではなく、collect_bug_reportを使用するように指示します。

もし最新の処理が最終的な答えを出さなかった場合、obscliは以前に作成された答えをコピーし、警告を表示します。

複雑な作業の計画と実行

/plan を使用してプランモードに入ります:

/plan [prompt]

例:

/plan I want to build a dashboard. Please create a plan.

プランを受け取った後、承認、拒否、変更リクエスト、または中断が可能です:

/plan-approve
/plan-approve /subagent [instruction]
/plan-reject [reason]
/plan-revise <feedback>
/plan-interrupt [reason]
コマンド 用途
/plan プランモードに入り、計画リクエストを待つ
/plan <prompt> プランモードに入り、計画リクエストを即座に送信する
/plan-approve 最新のプランを承認する
/plan-approve /subagent [instruction] プランを承認し、サブエージェントでの分割実行を優先する
/plan-reject [reason] プランを拒否して理由を説明する
/plan-revise <feedback> 修正フィードバックを送信する
/plan-interrupt [reason] 現在のプランを中断してプランモードを離れる

通常のメッセージは自動的にプランモードに入りません。アクティブなプランがある Task を閉じると、そのプランも中断されます。

スクリプトから単一プロンプトを実行する

obscli run を使用してワンショットタスクを送信し、Agent の回答を待ってから終了します。シェルスクリプトや自動化向けに設計されています。

一時的な認証情報が必要なタスクでは、--import-credential /secure/credentials.jsonを使用してテキストやファイルをインポートできます。プロンプトは、各アップロードが確認された後にのみ送信されます。タスクを完了すると、セッションが終了し、認証情報が無効になります。フォーマットやパスについては、Private Session Credentialsを参照してください。プロンプトには秘密情報を記載しないでください。

まず、obscli --login <YOUR-USER-SK>を使用してログインしてください。runは既存のログイン設定を読み取りますので、スクリプトは認証情報を再度入力する必要がありません。

obscli -h または obscli run -h を実行すると、サポートされるすべての run オプションを確認できます。

エージェントのUUIDがわからない場合は、アカウントのワークスペース全体で利用可能なAgentsを一覧します。

obscli run --list-agents
obscli run --list-agents --json
obscli run --list-agents --workspace-uuid <WORKSPACE_UUID>

デフォルトの出力には、ワークスペース、Agent UUID、名前、およびcreating、idle、busy、またはofflineのラムダステータスが含まれます。--jsonには、スクリプト用のworkspace_uuidおよびworkspace_nameも含まれています。--workspace-uuid、obscliでは、まずアカウントレベルのリストを読み取り、クライアント内でフィルタリングが行われます。このコマンドでは、タスクは作成されません。

プロンプトを直接渡す場合:

answer="$(obscli run --agent-uuid <AGENT_UUID> --prompt 'Check errors from the past hour and summarize them briefly')"
printf '%s\n' "$answer"

デフォルトでは、タスクはログイン設定からワークスペースに作成されます。別のワークスペースで実行する場合は、そのワークスペースを明示的に指定する必要があります。

obscli run --workspace-uuid <WORKSPACE_UUID> --agent-uuid <AGENT_UUID> --prompt 'Check the current status'

タスクを作成する前に、runは、選択されたワークスペースにAgentが存在し、現在のアカウントにアクセス可能かを確認します。別のワークスペースにAgentsやAgentsがない場合は、選択を試みる際に即座にエラーが発生します。--jsonの場合、エラーコードはagent_not_foundであり、終了コードは2です。認証、ネットワーク、またはサービスの障害も、タスクの作成前に停止します。一時的にオフライン状態の登録済みのAgentsは、タスクを受け取ることができます。コマンドは、復旧と返信を待つ間、タイムアウトされます。

モデルと推論レベルを選択するには:

obscli run --agent-uuid <AGENT_UUID> --model <MODEL_ID> --reasoning high --prompt 'Analyze the current status'

--reasoningは、該当するモデルの利用可能なレベル、すなわちonおよびoffをサポートしており、特定のモデルIDが必要です。推論を省略すると、そのモデルのデフォルトの動作に従います。モデルを省略すると、サーバーは最新の明示的な完全な選択肢を使用することができます。obscli chatも同様に、--modelおよび--reasoningのオプションをサポートしています。

複数行のファイルまたは stdin を読み込む場合:

obscli run --agent-uuid <AGENT_UUID> --prompt-file ./prompt.md
printf '%s\n' 'Summarize the health of the current workspace' | \
  obscli run --agent-uuid <AGENT_UUID> --prompt-file -

標準化されたプロンプトは、デフォルトのタスクタイトルです。スクリプトは--titleを使用して、別のタイトルを設定することができます。このタイトルは、Agentに送信されるプロンプトには表示されません。

printf '%s\n' '分析最近两小时的错误日志' | \
  obscli run --agent-uuid <AGENT_UUID> --title gceval-l4-log-pattern --prompt-file -

デフォルトでは stdout にはエージェントが返す生の Markdown のみが含まれ、通常の進捗情報は stderr に書き込まれません。構造化された結果を得るには --json を使用します:

obscli run --agent-uuid <AGENT_UUID> --prompt 'Return a one-line status summary' --json

JSON 結果には回答、関連する UUID、Agent UUID、および Task 名が含まれます。利用可能な場合は使用量と添付ファイルの情報も返されます。

obscli run の既定のエンドツーエンドのタイムアウトは 2 時間で、タスクの準備、プロンプト送信、最終回答を含みます。--timeout 90s で変更できます。この制限は 1 回の run コマンドに適用され、対話チャットには適用されません。個々のモデル要求とツール実行には、それぞれのタイムアウト設定が適用されます。-v、-vv、-vvv または --verbose=1|2|3 で、異なる詳細度の診断情報を stderr に出力します。既定では、Agent が危険なツールの承認を求めると、コマンドはそのターンをキャンセルして終了コード 3 で終了します。Full access のリスクを明示的に受け入れる場合だけ --yolo を使用してください。

ワンショットタスクにサブエージェントの優先使用を指示するには、--subagent を追加します:

obscli run --agent-uuid <AGENT_UUID> --subagent \
  --prompt 'Check errors, slow queries, and alerts from the past hour separately, then summarize the evidence'

タスクを合理的に分割できない場合、Agent はその理由を説明し、直接回答します。--subagent は --list-agents と併用できません。

obscli run はプランモードをサポートしていません。プランには複数回の確認が必要なためです。プランの承認や修正には対話型の obscli を使用してください。

一般的な終了コード:

終了コード 意味
0 回答を受信し、Task が正常に完了した
1 API、メッセージストリーム、Agent 実行、または Task クリーンアップの失敗
2 無効な引数またはローカルプロンプト入力
3 ツール呼び出しに承認が必要
4 Agent が追加入力を要求したが、ワンショット Task では対話を続行できない
124 実行がタイムアウトした
130 / 143 SIGINT / SIGTERM を受信した

--json モードでは、失敗時に stdout は空のままで、stderr は error.code と error.message を含む JSON オブジェクトを返します。スクリプトは終了コードとこれらのフィールドを使用して結果を判定してください。

メッセージ内でのリソースと Skill の参照

現在のセッションのワークスペースで、観察リソースを参照するために、@と入力してください。

  • Service
  • Dashboards
  • Application
  • Hosts
  • Containers

矢印キーまたは Tab で閲覧し、Space で 1 つ以上のアイテムを選択し、Enter で確定します。入力するとリソース名と種別を検索できます。選択したリソースは @resource-name として表示され、Agent にクエリコンテキストを提供します。

単一 Agent の Task にアタッチした状態で $ を入力すると、その Agent が提供する Skill を選択できます。検索は Skill の名前と説明に一致し、スペースを無視するため、rootcause は Root cause analysis に一致します。選択方法はリソースリストと同じで、選択したすべての Skill はメッセージ全体に適用されます。

両方のリストで、Enter で確定する前に Space で選択する必要があります。検索しても既存の選択はクリアされません。

@resource-name または $skill-name の境界で、Backspace または Delete を押すと参照全体が削除されます。矢印キーや Ctrl+R でメッセージを呼び出すと、そのリソースと Skill も復元されます。

リテラルの @ または $ を入力するには、リストが開いた後に Esc を押します。貼り付けた @ と $ もプレーンテキストのままです。

Task を開いた後、メッセージを入力して Enter を押します。Task に Agent が 1 つの場合、メッセージはその Agent に送信されます。複数の Agent がいる場合、メッセージはすべての Agent にブロードキャストされます。

キーボードショートカットの使用

通常の入力では以下のショートカットが使用できます:

通常の入力:

キー 動作
Enter 現在の入力を送信する。スラッシュコマンド選択時はハイライトされたコマンドを確定する
Shift+Enter / Alt+Enter 改行を挿入する
Esc 現在の入力のキャンセル確認を表示する
Esc 2 回 現在の入力または現在のチャットをキャンセルする
↑ / ↓ 入力履歴を閲覧する。スラッシュコマンド選択時はハイライトを移動する
← / → カーソルを左右に移動する
Home / End 行の先頭または末尾に移動する
Backspace カーソル前の文字を削除する
Delete カーソル位置の文字を削除する
Tab スラッシュコマンドの共通プレフィックスを補完する
Ctrl+A / Ctrl+E 行の先頭または末尾に移動する
Ctrl+C 入力が空でない場合はクリアする。入力が空の場合は現在の対話を終了する
Ctrl+L 画面をクリアし、現在の入力を保持する
Ctrl+R 入力履歴を検索する
Ctrl+T フルスクリーンでのツールの詳細を開きます。qはチャットに戻り、ドラフトを復元します。
Ctrl+W 前の単語を削除する
テキスト直接入力 カーソル位置にテキストを挿入する

スラッシュコマンドがBeakを待っている間、Ctrl+CまたはEscを2回押して、ローカルな待ち状態を停止できます。待ち状態中に入力したテキストは「ドラフト」として残り、新しいEnterキーを押して送信する必要があります。キャンセルすると、既に完了したサーバー上の操作は元に戻りません。もし書き込みが既に実行されている場合は、再試行する前にその状態を確認してください。

認証フォームも、ネットワークの待機中にこれらのキャンセルキーをサポートしています。この待機期間中に入力されたテキストは破棄されるため、秘密情報は通常のチャットの草稿、ログ、またはキャッシュには保存されません。

ツールの詳細では、矢印キーやマウスホイールを使ってスクロールします。PageUp/PageDownを使ってページを切り替え、Home/Endを使って最初や最後に移動します。Ctrl+PやCtrl+Nを使ってコールをナビゲートします。ビュアーを開くと、最新のコールの開始位置が選択されます。入力、貼付、Enterはチャットメッセージの編集や送信には使用できません。新しい結果は、読んだ位置を保持します。スクロールして最後に移動すると、次の内容を確認できます。承認が届いた場合は、qを使ってその承認を処理します。

通常モードでは、ロードされた後、チャット内容は~/.obscli/cache/sessions/YYYY/MM/DD/<session-id>.jsonlにキャッシュされます。ツールの詳細を開くことなく、各セッションは再起動やアタッチメント時にもその元のキャッシュ日付ディレクトリを保持します。 プライベートモードでは、別のキャッシュが使用されます。詳細はセッションの保存と復元を参照してください。歴史データは、ローカルのAgentから取得されます。 通常モードでは、インタラクティブな端末では、まず最近のローカルチャットが表示され、その後、バックグラウンドで利用可能なすべてのBeakの履歴が表示されます。この時、ユーザーは引き続き入力を続けることができます。パイプやスクリプトによる入力の場合は、次のコマンドを読み取る前に履歴の読み取りが完了し、/saveや/exitなどのコマンドの順序が保持されます。 保存されたメッセージのチェックポイントから新しい履歴を再接続し、接続解除前に未完成だった「Reply Runs」も別途チェックします。既に同期されているコールの詳細は、再度ダウンロードされません。 同期化に失敗し、History sync incompleteというエラーが表示されます。ツールの詳細を再接続または開いて、未完了の履歴を再試行し、続行できない場合は、Ctrl+Tで利用可能な以前の同期化されたツールの履歴を確認できます。通常のチャットでは、最近のメッセージとツールのプレビューが表示されます。

同じセッションと Agent では、各 tool_call_id が 1 つの呼び出しを識別します。既存のローカル引数、説明、完全な結果を優先して保持します。リモート履歴は欠けている内容とオフライン中に生成された最終状態や結果を補完します。マスク済みの要約がローカルの完全なテキストを上書きすることはなく、終了状態が実行中に戻ることもありません。 通常のチャットやCtrl+Tの操作では、同じデータが読み取られます。順序がない矛盾する端末状態の場合は、以前の状態が保持されます。 SQLite側のファイルには、JSONLのオフセット、順序、重複排除、同期インデックスのみが保存されており、毎回の開放時に再構築されます。テキスト、プロヴェナンス、同期のチェックポイントはJSONLに残ります。 既存のキャッシュには、移動する必要はありません。セッションの切り替えや終了により、バックグラウンドでのリクエストはキャンセルされます。もしキャッシュが書き込み可能でない場合は、利用可能な履歴のみが表示され、その理由も表示されます。 キャッシュのアイデンティティチェックでは、サーバー、ワークスペース、ユーザー、セッションが確認されます。30日以上変更がない未使用のファイルは削除されます。

ツールの詳細は、256 KiB/コールごとに限られるものではなく、最新の50コールにも適用されます。既存のBeak形式の編集、文字の省略、参照テキストは変更されません。ビューアは、チャットツールのヘッダー、区切り記号、コマンドのハイライトを保持し、スクロールやサイズ変更中にも、JSON形式やMarkdown形式の書式設定が維持されます。進捗情報やコメントは、処理が完了した後に引き続き利用可能です。

完全な論理的論証には、新しいAgentが必要です。古いAgentsや、完全な論証が含まれていないキャッシュは、利用できないという通知が表示されます。歴史的な論証は、Beakの編集内容を保持しています。行が短縮された論証、コマンド、コメント、結果は、...+<n> lines (ctrl+t to view transcript)を使用します。

各セッションのキャッシュ内では、ツールの番号は1から始まります。番号は最初に登場した順番に従って記録され、チャットの転換やアタッチメントの間でも安定しています。通常のチャットでは、これらの番号はデフォルトで隠されます。/tool-index on|offは、保持されている履歴やアクティブなツールを即座に再描画し、show_tool_indexは~/.obscli/config.tomlに保存されます。番号は灰色の(n)として表示されます。バッチ処理用の[i/count]は別途管理されます。Ctrl+Tを押すと、常に番号が表示されます。gを押して番号を入力し、Enterキーを押してジャンプします。Escキーを押すとキャンセルされます。無効な番号は、現在の位置を保持します。ジャンプは自動的な番号の続きを停止します。Ctrl+P/Nを押すと、チャットの順序に従って番号が表示されます。番号は同じローカルキャッシュ内でのみ安定しています。利用できないキャッシュでは、代替の番号は生成されません。

ツールのヘッダーには、read_skillやread_skill_fileなどのツール名が表示され、その下にはSkillという名前とパスが記載されています。ツール名がない古い記録については、元の表示名がそのまま保持されます。

推論中の Thinking... は直近の画面 5 行を保持し、長い行を折り返して断片を即座に表示します。完了後はサイズ制限付きプレビューを残し、完全なイベントはキャッシュに保持します。非対話出力では全文を保持します。120 Unicode 文字(runes)を超える文字列値は、値ごとに head (x omitted...) tail へ短縮します。x は実際に省略した runes 数です。プレビューは 120 runes 以内に収め、先頭 60 を保持し、省略通知の長さに合わせて末尾を調整します。他の引数は完全なまま保持し、JSON オブジェクト全体を一括で切り詰めることはありません。Ctrl+T は完全な引数と結果を表示しますが、機密値は引き続き隠されます。全文がない古い保存済み要約には説明を残します。キャッシュや履歴の取得に失敗した場合は、詳細を取得できないことを明示し、他の内容は読める状態を維持します。

ポップアップ選択:

キー 動作
↑ / Ctrl+P ハイライトを上に移動する。最初のアイテムから最後のアイテムに折り返す
↓ / Tab / Ctrl+N ハイライトを下に移動する。最後のアイテムから最初のアイテムに折り返す
Shift+Tab ハイライトを上に移動する。最初のアイテムから最後のアイテムに折り返す
Space ハイライトを移動せずに現在のアイテムを切り替える。失敗したリソースタイプを再試行し、読み込み成功後に選択する
Enter 選択したすべてのアイテムを送信する。何も選択されていない場合はポップアップを開いたままにする
Esc 現在のポップアップをキャンセルする。リソースアイテムリストでは最初にタイプリストに戻る。承認ポップアップでは現在のチャットをキャンセルする
Ctrl+C ポップアップをキャンセルして現在の対話を終了する
Backspace 検索テキストの最後の文字を削除する
Ctrl+U 検索テキストをクリアする
テキスト直接入力または貼り付け リストをファジーフィルターし、ハイライトを最初のアイテムにリセットする

ターミナルで矢印キーやコントロールキーが動作しない場合は、まずターミナルがそのショートカットを外部アプリケーションにバインドしていないか確認してください。問題が解決しない場合は、~/.obscli/log/obscli.log を開き、ターミナル名、バージョン、およびキーの動作を記録してください。

ローカルファイル

obscli はデフォルトで以下のローカルパスを使用します:

Linux/macOS:

~/.obscli/login.toml
~/.obscli/log/obscli.log

Windows:

%USERPROFILE%\.obscli\login.toml
%USERPROFILE%\.obscli\log\obscli.log

ログは自動的にローテーションされます。1 つのログファイルのデフォルト最大サイズは 32 MiB です。

トラブルシューティング

ログインに失敗した場合は、以下を確認してください:

  • --beak-server が Beak サービスのアドレスを指していること。
  • インストーラー経由でログインする場合、--beak-server が Beak サービスのアドレスを指していること。
  • ユーザー sk が現在の Beak Web ページからコピーした有効な認証情報であること。
  • HTTPS テスト環境で --insecure-skip-tls-verify が必要かどうか。

チャットに入った後に Task がない場合は、以下を実行してください:

/agents
/newtask <number>

ここで <number> は /agents の # 列に表示される番号です。

地域別の診断報告書

obscli bug-report view ./report.zipを使用して、完全にオフラインの診断ビューアを開きます。--no-openを追加することで、ブラウザを起動するのを防ぎます。このサービスはランダムなループバックポートのみを通じて通信します。詳細はLocal Bug Report Viewerを参照してください。

フィードバック

このページは役に立ちましたか?