tufty.aitufty.ai CLI
CLI

CLIの概要

tuftyのコマンド一覧と共通のルール。

コマンド

コマンド内容
tufty <tool>スタジオツールを実行します（例：tufty pet-dressup）。詳しくはツールを参照
tufty tools listすべてのツールを一覧表示
tufty tools describe <id>1つのツールの入力、オプション、料金、制限をすべて表示
tufty status <runId>実行状況を確認。--waitを付けると完了まで待機
tufty upload <file>ファイルをtuftyのストレージにアップロードし、公開URLを表示
tufty loginブラウザのデバイスコードでログイン
tufty auth set <apiKey>APIキーを保存
tufty auth get使用中のキーを表示（デフォルトはマスク表示）
tufty logout設定ファイルからキーを削除

ツールコマンドの仕組み

ツールコマンドとそのフラグは、CLIに直接書き込まれているわけではありません。CLIは実行時にサーバーのツールマニフェストを読み込み（ローカルに10分間キャッシュ）、ツールごとにコマンドを登録して、オプションの生成と値の検証を行います。サイト側でツールが追加されたり、料金やオプションが変わったりしても、CLIをアップグレードせずに追従できます。そのため、常にtufty <tool> -hの出力が正となります。

auth、login、logout、upload、statusはマニフェストに依存せず、マニフェストを取得することもありません。

共通のルール

  • 標準出力にはJSONエンベロープが1つだけ出力され、進行状況は標準エラー出力に書き出されます。詳しくは出力モードを参照してください。
  • 終了コード：0は成功、1は実行時エラーまたはAPIエラー、2は使い方の誤りです。詳しくは終了コードを参照してください。
  • 入力の数、ファイルの有無、オプションの値はアップロード前に検証されるため、入力ミスでクレジットが無駄になることはありません。
  • コマンド名を間違えるとunknown_commandが返され、details.suggestionsに近いコマンドの候補が入ります。

よく使う組み合わせ

# 使えるツールを確認
tufty tools list

# ツールの現在のフラグと料金
tufty pet-dressup -h
tufty tools describe pet-dressup

# 見積もってから実行
tufty pet-dressup --product ./sweater.jpg --model ./corgi.jpg --quality medium --dry-run
tufty pet-dressup --product ./sweater.jpg --model ./corgi.jpg --quality medium --save ./out

このセクションの内容

認証

ブラウザのデバイスコードでログインするか、APIキーを手動で保存します。

グローバルフラグ

すべてのコマンドで共通のフラグ、環境変数、ツールマニフェストのキャッシュ。

On this page

コマンド
ツールコマンドの仕組み
共通のルール
よく使う組み合わせ
このセクションの内容