ローカル API の全体像

fuga-api とは

fuga-api は、ターミナルや外部のエージェント（AI）から Fuga の状態を読んだり、ゴールに依頼を送ったりするためのコマンドです。

中身は Node.js で動くコマンドラインツール（CLI）です。

基本の形

fuga-api <コマンド> [引数] [--オプション 値]

この章の fuga-api は、アプリに入っているコマンド node "/Applications/Fuga.app/Contents/Resources/app.asar.unpacked/out/main/fugaApiCli.mjs" のことです（fuga-api の場所）。

引数なしで fuga-api を実行するか、fuga-api help を実行すると、使い方の一覧が表示されます。

help は Fuga に接続せず、何も変えません。

結果の見方

help 以外の結果は JSON で表示されます。

失敗したときは ok が false になり、code（種類）、error（内容）、next（次にすること）が付きます。

用語

• 実行（run）: 1 つのタスクを進める単位です。runId で指定します。
• ゴール担当（PM）: ゴールごとの担当 AI です。作業を提案し、依頼や質問に答えます。
• コーディネーター: ゴール全体の優先度や提案を出し、人の判断が要る項目を示す AI です。

主なできること

• 状況を読む: 実行の状態、ゴールの一覧、利用量を見る。
• ゴールを作る・直す: ゴールの設定、完了条件の追加や取り下げ、ゴール担当の動きの切り替え。
• 依頼を送る: ゴール担当に依頼する、質問する、コーディネーターに相談する。
• 仕様に沿って送る（上級）: JSON を検査（validate）してから送信（submit）する。

章の読み方

「fuga-api の場所」で打ち方を確かめ、「状態を読むコマンド」から試してください。接続のしくみは「入口と接続のしくみ」にあります。

書き込みを伴うコマンドは、「使うときの注意」を読んでから使ってください。