DocsはじめにYeePilot の最初の一歩
ドキュメントに戻る
はじめに

YeePilot の最初の一歩

YeePilot を設定し、最初のタスクを実行し、コマンド承認、HUD、重要な設定を理解します。

最終更新: 2026年5月12日

このガイドについて

このページは、できるだけ早く使い始めたいエンドユーザー向けの導入です。開発者向けの内部説明ではなく、日常利用で必要な操作に絞っています。

開始方法

インストール後、通常は次のどちらかで起動します。

bash
yeepilot

または:

bash
yeepilot run

どちらも対話チャットを開きます。単発のタスクだけ実行して終了したい場合は次を使います。

bash
yeepilot exec "show disk usage"

初回セットアップ

初回起動ではセットアップウィザードが始まることが多く、必要ならいつでも再実行できます。

bash
yeepilot setup

一般的な流れは次の通りです。

  1. AI プロバイダーを選ぶ
  2. API キーまたは認証方法を入力する
  3. 初期モデルを選ぶ
  4. 言語と基本設定を確認する
  5. セキュリティ方針を確認する

よく使われるプロバイダー

多くのユーザーが使うのは次の 3 つです。

  • openrouter
  • openai
  • anthropic

複数モデルを柔軟に試したいなら openrouter が扱いやすく、組織で既定のプロバイダーがあるならそれに合わせるのが実務的です。

最初に試すプロンプト

具体的で自然な依頼をそのまま入力できます。

text
Show me disk usage on all mounted filesystems, sorted by usage percentage

YeePilot は、実行前に確認できるプランへ変換します。

承認フロー

コマンドや変更を実行する前に、YeePilot は次を表示します。

  • 実行される正確なコマンド
  • リスクレベル
  • 確認プロンプト

主なリスク区分は次の通りです。

  • SAFE 読み取りや確認向け
  • MODERATE 制御された変更向け
  • DANGEROUS 影響が大きい操作向け
  • BLOCKED 自動実行してはいけない操作向け

アクティブなポリシーが承認を必要とする場合、明示的に確認しない限り何も実行されません。

日常で使う 3 つの画面

エンドユーザーが覚えておくとよいのは次の 3 つです。

  • メインチャット
  • 右側の sidecar
  • セッション、設定、監査、利用状況を見る Neural HUD

Neural HUD を開く

使いやすい入口は次です。

  • プロンプトが空の状態で Esc
  • F2 で Settings
  • F3 で Keybinds
  • /settings
  • /keybinds

最初に覚えると便利なコマンド

text
/help
/plan on
/sessions
/file README.md
/vault
/update

実用的な基本フロー

  1. yeepilot で起動する
  2. 重要な作業なら /plan on を有効にする
  3. 目的を具体的に伝える
  4. プランとリスクを確認する
  5. 理解できるものだけ承認する
  6. 必要なら HUD で使用量、セッション、設定を確認する

設定ファイルの場所

メイン設定は次に保存されます。

text
~/.yeepilot/config.yml

古い環境では config.yaml が残っていることがありますが、現在の基準は config.yml です。

よく使う CLI コマンド

bash
yeepilot status
yeepilot version
yeepilot update
yeepilot diagnostics pending
yeepilot support report --message "describe the problem"

次に読むページ