CLI(コマンドライン)

ターミナルから、
YOBITSUGI AI に頼む。

yobitsugi コマンドを使うと、ブラウザを開かずに、ターミナルから依頼を送って結果とファイルを受け取れます。手元のファイルを添付したり、スクリプトやほかのツールから呼び出したりできます。AI の作業は、Web 版と同じ専用のワークスペースで行います。

# インストール(Node.js 20 以上)
npm install -g @gameagelayer/yobitsugi

# ブラウザでログイン
yobitsugi login

# 対話を始める
yobitsugi

できること

ターミナルで会話する

Web 版と同じように、会話を続けながら依頼できます。途中経過(AI が使った道具や作成したファイル)も、その場で表示します。

1 回だけ実行する

-p を付けると、依頼を 1 回だけ送り、回答だけを出力します。パイプで受け取った文章やログを渡すこともできます。

ファイルを渡して、受け取る

メッセージの中の @ファイル名 で手元のファイルを添付し、AI が作成したファイルは -o で手元のフォルダに保存できます。

ほかのツールから使う

結果を JSON で出力できるので、スクリプトや CI、ほかのアプリケーションから呼び出せます。

必要なもの

  • Node.js 20 以上(Windows・macOS・Linux)
  • YOBITSUGI AI のアカウント(Web 版と同じアカウントです。クレジットも共通です)

インストールと更新

# インストール
npm install -g @gameagelayer/yobitsugi

# 版の確認
yobitsugi --version

# 新しい版に更新
npm install -g @gameagelayer/yobitsugi@latest

# アンインストール(先に yobitsugi logout を実行してください)
npm uninstall -g @gameagelayer/yobitsugi

ログイン

yobitsugi login を実行すると、ブラウザで YOBITSUGI AI のログイン画面が開きます。ログインして「ログインする」を押すと、ターミナルに戻って完了します。パスワードを CLI に入力することはありません。

SSH で接続したサーバーなど、ブラウザが別のコンピューターにある場合は、ターミナルに表示される URL を手元のブラウザで開いてください。「ログインする」を押すとコードが表示されるので、ターミナルの「コード >」に貼り付けると完了します。yobitsugi login --no-browser では、ブラウザを開かずに URL だけを表示します。

# ログイン中のアカウントを確認
yobitsugi whoami

# ログアウト(この端末のログインを、サーバー側でも無効にします)
yobitsugi logout

ログイン中の端末は、Web 版の設定の「セキュリティ」の「ログイン中のアプリ」で確認でき、そこからログアウトさせることもできます。

使い方

# 対話を始める
yobitsugi

# 最初のメッセージを付けて対話を始める
yobitsugi "この表を集計して"

# 1 回だけ実行し、作成されたファイルを out フォルダに保存
yobitsugi -p "@売上.csv を集計してグラフにして" -o out

# 標準入力から渡す
cat error.log | yobitsugi -p "エラーの原因をまとめて"

# このフォルダで最後に使ったセッションの続きを頼む
yobitsugi -p -c "さっきの表に前年比を追加して"

# モデルを指定する(新しいセッションのとき)
yobitsugi -p -m claude-haiku-5-5 "この文を短くして"

CLI で作ったセッションは、Web 版の画面にも同じように表示されます。対話モードで /open と入力すると、いまのセッションをブラウザで開けます。

対話モードのコマンド

/new新しいセッションを始める
/sessions最近のセッションを表示する
/resume <ID>セッションを切り替える
/model [ID]モデルを表示する・変更する(次の依頼から)
/balanceクレジットの残高を表示する
/filesこのセッションのファイルを表示する
/get <パス> [保存先]マイファイルからダウンロードする
/openこのセッションをブラウザで開く
/help・/exitコマンドの一覧・終了(Ctrl+D でも終了します)
  • Ctrl+C で、実行中の依頼を停止します(-p のときも停止します)。
  • 複数行のメッセージは、そのまま貼り付けると 1 つのメッセージとして送ります。手で入力するときは、行の終わりに \(バックスラッシュ。日本語のキーボードでは ¥ のキー)を付けると、次の行に続けられます。

コマンドとオプション

login・logout・whoamiログイン・ログアウト・ログイン中のアカウントの表示
sessions・models・balanceセッションの一覧・モデルの一覧・クレジットの残高
get <パス> [保存先]マイファイルからダウンロード
-p・--print1 回だけ実行して結果を表示
-c・-r <ID>このフォルダで最後に使ったセッション・指定したセッションの続き
-m <ID>・--effort <レベル>モデルと思考の深さ(新しいセッションのとき。レベルは low・medium・high・xhigh・max)
-o <フォルダ>作成されたファイルをダウンロード(-p のとき)
--output-format <形式>text(既定)・json・stream-json(-p のとき)
--allow-secrets.env や鍵などのファイルの添付を許可
--no-browserlogin のときにブラウザを開かず、URL を表示(表示されたコードを貼り付けてログイン)

ファイルの添付とダウンロード

  • メッセージの中の @ファイル名 で、手元のファイルを添付できます(一度に 10 個まで・1 ファイル 100MB まで)。ファイル名のあとに空白を入れずに文を続けても(例: @売上.csvを集計して)添付します。
  • 見つからないファイルを指定した場合は、添付していないことを表示します。
  • .env・秘密鍵・証明書など、秘密の情報を含むおそれのあるファイルは、誤って送らないように添付を止めます。添付する場合は --allow-secrets を付けてください。
  • 作成されたファイルは、-o または /get で保存できます。同じ名前のファイルがある場合は上書きせず、番号を付けて保存します。
  • AI が手元のファイルを直接読み書きしたり、手元でコマンドを実行したりすることはありません。送るのは、@ で添付したファイルだけです。

ほかのツールから使う

--output-format json を付けると、終わったときに結果を 1 つの JSON で出力します。stream-json では、途中の出来事(回答の文・道具の利用・作成したファイルなど)を 1 行ずつ JSON で出力します。

yobitsugi -p --output-format json "@data.csv の行数を数えて"
{
  "session": "セッションの ID",
  "status": "success",
  "text": "回答の本文",
  "credits": 1.07,
  "files": ["作成されたファイルのパス"],
  "downloaded": ["-o で保存したファイル"]
}

終了コード

0成功
1依頼が完了しなかった・エラー(ログインしていない場合を含む)
2オプションの指定の誤り
3ログインの有効期限が切れた(yobitsugi login でログインし直してください)
130Ctrl+C で停止した

料金

CLI そのものは無料です。依頼に応じて、Web 版と同じようにクレジットが消費されます(料金とシミュレーション)。各依頼の消費クレジットは、ターミナルに表示されます。

-p は、-c や -r を付けない限り、毎回新しいセッションで実行します。モデルを指定しない場合は既定のモデル(yobitsugi models で * が付いているもの)を使うため、短い質問を何度も送るときは、-m で軽いモデルを選ぶか、-c で同じセッションを続けると、費用を抑えられます。

セキュリティ

  • ログインは、ブラウザでの認証(認可コード + PKCE)で行います。貼り付けるコードは 10 分間・1 回だけ有効で、ログインを始めた CLI でなければ使えません。
  • ログイン情報は、~/.config/yobitsugi/(Windows は %APPDATA%\yobitsugi\)に、本人だけが読める権限で保存します。
  • 接続先は https に限っています。AI の出力に含まれる制御文字は、表示する前に取り除きます。

よくある質問

Web 版と何が違いますか?

AI の作業の場所(専用のワークスペース)・使えるモデルとクレジットは、Web 版と同じです。CLI では、手元のファイルをそのまま添付したり、結果をファイルや JSON で受け取ったりでき、スクリプトから呼び出せます。

コマンドを打つと、手元のコンピューターで何かが実行されますか?

いいえ。AI の作業は YOBITSUGI AI のワークスペースで行います。手元から送るのは、メッセージと、@ で添付したファイルだけです。

ブラウザの無いサーバーでも使えますか?

はい。yobitsugi login --no-browser で表示される URL を手元のブラウザで開き、表示されたコードをサーバーのターミナルに貼り付けてください。

「npm」が見つからないと表示されます。

Node.js(20 以上)をインストールすると、npm も一緒に使えるようになります。インストールしたあと、ターミナルを開き直してください。

自社のシステムに組み込みたいのですが。

専用契約を締結した企業さまには、API を提供しています。お問い合わせからご相談ください。

CLI のご利用にも、YOBITSUGI AI の利用規約が適用されます。