Hub Python Library documentation

Hub Python Library

You are viewing main version, which requires installation from source. If you'd like regular pip install, checkout the latest stable version (v2.4.0).

Join the Hugging Face community

and get access to the augmented documentation experience

Collaborate on models, datasets and Spaces

Faster examples with accelerated inference

Switch between documentation themes

to get started

hf

Hugging Face Hub CLI

使用方法:

$ hf [OPTIONS] [COMMAND] [ARGS]...

オプション:

--skills: hf-cli の SKILL.md を標準出力に出力します（hf skills preview の別名）。
--install-completion: 現在のシェルに補完機能をインストールします。
--show-completion: 現在のシェル用の補完を表示します。コピーしたり、インストールをカスタマイズしたりするために使用します。
--help: このメッセージを表示して終了します。

コマンド:

auth: 認証（ログイン、ログアウトなど）を管理します。
buckets: バケットを操作するためのコマンド。
cache: ローカルキャッシュディレクトリを管理します。
collections: Hub上のコレクションを操作します。
cp: ローカルパス、リポジトリ、バケット間でファイルをコピーします。
datasets: Hub上のデータセットを操作します。
discussions: Hub上のディスカッションとプルリクエストを管理します。
download: Hubからファイルをダウンロードします。
endpoints: Hugging Face Inference Endpoints を管理します。
env: 環境に関する情報を表示します。
extensions: hf CLIの拡張機能を管理します。[別名: ext]
jobs: Hub上でJobsを実行して管理します。
lfs-enable-largefiles: リポジトリを設定して、5GBを超えるファイルのアップロードを有効にします。
lfs-multipart-upload: マルチパートアップロード用の内部 git-lfs カスタム転送エージェント。
models: Hub上のモデルを操作します。
papers: Hub上の論文を操作します。
repos: Hub上のリポジトリを管理します。
sandbox: Hugging Face Jobs上で実験用のサンドボックスを実行・管理します。
skills: AIアシスタントのスキルを管理します。
spaces: Hub上のスペースとやり取りします。
sync: ローカルディレクトリとバケット間でファイルを同期します。
update: hf CLIを最新バージョンに更新します。
upload: ファイルまたはフォルダを Hub にアップロードします。
version: hf のバージョンに関する情報を表示します。
webhooks: Hub上のWebhookを管理します。

hf auth

認証（ログイン、ログアウトなど）を管理します。

使用方法:

$ hf auth [OPTIONS] COMMAND [ARGS]...

オプション:

--help: このメッセージを表示して終了します。

コマンド:

list: 保存されているアクセストークンをすべて一覧表示します。[エイリアス: ls]
login: ブラウザからログインするか、huggingface.co/settings/tokens のトークンを使用してログインします。
logout: 特定のトークンからログアウトします。
switch: アクセストークンを切り替えます。
token: 現在のアクセストークンを標準出力に出力します。
whoami: huggingface.co にログインしているアカウントを確認します。

hf auth list

保存されているすべてのアクセストークンを一覧表示します。[エイリアス: ls]

使用方法:

$ hf auth list [OPTIONS]

オプション:

--help: このメッセージを表示して終了します。

例 $ hf auth list

詳細を見るコマンドの詳細については、hf <command> --help を使用してください。ドキュメントは https://huggingface.co/docs/huggingface_hub/en/guides/cli で閲覧できます。

hf auth login

ブラウザからログインするか、huggingface.co/settings/tokensのトークンを使用してログインしてください。

使用方法:

$ hf auth login [OPTIONS]

オプション:

--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--add-to-git-credential / --no-add-to-git-credential: git credential helper に保存します。git コマンドを直接実行する予定がある場合にのみ有用です。 [デフォルト: no-add-to-git-credential]
--force / --no-force: すでにログイン済みであっても、ログインを強制します。 [デフォルト: no-force]
--help: このメッセージを表示して終了します。

例 $ hf auth login $ hf auth login —token $HF_TOKEN $ hf auth login —token $HF_TOKEN —add-to-git-credential $ hf auth login —force

hf auth logout

特定のトークンからログアウトします。

使用方法:

$ hf auth logout [OPTIONS]

オプション:

--token-name TEXT: ログアウトするトークンの名前
--help: このメッセージを表示して終了します。

例 $ hf auth logout $ hf auth logout —token-name my-token

hf auth switch

アクセストークンを切り替えます。

使用方法:

$ hf auth switch [OPTIONS]

オプション:

--token-name TEXT: 切り替えるトークンの名前
--add-to-git-credential / --no-add-to-git-credential: git credential helper に保存します。git コマンドを直接実行する予定がある場合にのみ有用です。 [デフォルト: no-add-to-git-credential]
--help: このメッセージを表示して終了します。

例 $ hf auth switch $ hf auth switch —token-name my-token

hf auth token

現在のアクセストークンを標準出力に出力します。

使用方法:

$ hf auth token [OPTIONS]

オプション:

--help: このメッセージを表示して終了します。

例 $ hf auth token $ hf auth token | xargs curl -H ‘Authorization: Bearer {}’

hf auth whoami

どのhuggingface.coアカウントでログインしているかを確認します。

使用方法:

$ hf auth whoami [OPTIONS]

オプション:

--help: このメッセージを表示して終了します。

例 $ hf auth whoami $ hf auth whoami —format json

hf buckets

バケットを操作するためのコマンド。

使用方法:

$ hf buckets [OPTIONS] COMMAND [ARGS]...

オプション:

--help: このメッセージを表示して終了します。

コマンド:

cp: ローカルパス、リポジトリ、バケット間でファイルをコピーします。
create: 新しいバケットを作成します。
delete: バケットを削除します。
info: バケットに関する情報を取得します。
list: バケット内のバケットまたはファイルをリスト表示します。[別名: ls]
move: バケットを新しい名前または名前空間に移動（名前変更）します。
remove: バケットからファイルを削除します。[別名: rm]
settings: バケット設定（公開範囲）を更新します。
sync: ローカルディレクトリとバケット間でファイルを同期します。

hf buckets cp

ローカルパス、リポジトリ、バケット間でファイルをコピーします。

アップロード（ローカル/stdin -> リポジトリ/バケット）、ダウンロード（リポジトリ/バケット -> ローカル/stdout）、およびリモート間コピー（リポジトリ/バケット -> リポジトリ/バケット）を処理します。バケットからリポジトリへのコピー、およびローカル間コピーはサポートされていません。ディレクトリの場合は、hf upload/hf download（リポジトリ）または hf buckets sync（バケット）を使用してください。リモート間コピーは、同じストレージリージョン内でのみ機能します（https://huggingface.co/docs/hub/storage-regions）。

使用方法:

$ hf buckets cp [OPTIONS] SRC [DST]

引数:

SRC: ソース: ローカルファイル、hf:// URI（リポジトリまたはバケット）、または stdin を示す -。[必須]
[DST]: 保存先: ローカルパス、hf:// URI (リポジトリまたはバケット)、または標準出力用の -。

オプション:

--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf buckets cp hf://buckets/username/my-bucket/config.json config.json $ hf buckets cp hf://buckets/username/my-bucket/data.csv data/ $ hf buckets cp hf://buckets/username/my-bucket/config.json - $ hf buckets cp model.safetensors hf://buckets/username/my-bucket/model.safetensors $ hf buckets cp config.json hf://buckets/username/my-bucket/logs/ $ hf buckets cp - hf://buckets/username/my-bucket/config.json $ hf buckets cp hf://buckets/username/my-bucket/data.csv hf://buckets/username/dest-bucket/ $ hf buckets cp hf://buckets/username/source-bucket/logs/ hf://buckets/username/dest-bucket/logs/

hf buckets create

新しいバケットを作成します。

使用方法:

$ hf buckets create [OPTIONS] BUCKET_ID

引数:

BUCKET_ID: バケット ID: bucket_name、namespace/bucket_name、または hf://buckets/namespace/bucket_name [必須]

オプション:

--private: プライベートバケットを作成します。
--region [us|eu]: バケットを作成するクラウドリージョン。‘us’ または ‘eu’ のいずれかです。Team プラン以上が必要です。
--exist-ok: バケットが既に存在する場合でも、エラーを発生させません。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf buckets create my-bucket $ hf buckets create user/my-bucket $ hf buckets create hf://buckets/user/my-bucket $ hf buckets create user/my-bucket —private $ hf buckets create user/my-bucket —exist-ok $ hf buckets create user/my-bucket —region us

hf buckets delete

バケットを削除します。

これにより、バケット全体とその中身が削除されます。個別のファイルを削除するには、hf buckets rm を使用してください。

使用方法:

$ hf buckets delete [OPTIONS] BUCKET_ID

引数:

BUCKET_ID: バケット ID: namespace/bucket_name または hf://buckets/namespace/bucket_name [必須]

オプション:

-y, --yes: 確認プロンプトをスキップします。
--missing-ok: バケットが存在しない場合でもエラーを発生させません。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf buckets delete user/my-bucket $ hf buckets delete hf://buckets/user/my-bucket $ hf buckets delete user/my-bucket —yes $ hf buckets delete user/my-bucket —missing-ok

hf buckets info

バケットに関する情報を取得します。

使用方法:

$ hf buckets info [OPTIONS] BUCKET_ID

引数:

BUCKET_ID: バケット ID: namespace/bucket_name または hf://buckets/namespace/bucket_name [必須]

オプション:

--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf buckets info user/my-bucket $ hf buckets info hf://buckets/user/my-bucket

hf buckets list

バケット内のバケットまたはファイルをリスト表示します。[エイリアス: ls]

引数なし、または名前空間を指定して呼び出された場合、バケットのリストを表示します。バケット ID（namespace/bucket_name）を指定して呼び出された場合、そのバケット内のファイルのリストを表示します。

使用方法:

$ hf buckets list [OPTIONS] [ARGUMENT]

引数:

[ARGUMENT]: バケットのリストを取得する名前空間（ユーザーまたは組織）、またはファイルのリストを取得するバケット ID（namespace/bucket_name(/prefix) または hf://buckets/…）。

オプション:

-h, --human-readable: サイズを人間が読みやすい形式で表示します。
--tree: ファイルをツリー形式で一覧表示します（ファイルの一覧表示時のみ）。
-R, --recursive: ファイルを再帰的に一覧表示します（ファイルの一覧表示のみ）。
--search TEXT: 検索クエリ。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf buckets list $ hf buckets list huggingface $ hf buckets list —search “my-prefix” $ hf buckets list user/my-bucket $ hf buckets list user/my-bucket -R $ hf buckets list user/my-bucket -h $ hf buckets list user/my-bucket —tree $ hf buckets list user/my-bucket —tree -h $ hf buckets list hf://buckets/user/my-bucket $ hf buckets list user/my-bucket/sub -R

hf buckets move

バケットを新しい名前または名前空間に移動（名前変更）します。

使用方法:

$ hf buckets move [OPTIONS] FROM_ID TO_ID

引数:

FROM_ID: ソースバケットID: namespace/bucket_name または hf://buckets/namespace/bucket_name [必須]
TO_ID: 宛先バケット ID: namespace/bucket_name または hf://buckets/namespace/bucket_name [必須]

オプション:

--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf buckets move user/old-bucket user/new-bucket $ hf buckets move user/my-bucket my-org/my-bucket $ hf buckets move hf://buckets/user/old-bucket hf://buckets/user/new-bucket

hf buckets remove

バケットからファイルを削除します。[エイリアス: rm]

バケット全体を削除するには、代わりにhf buckets deleteを使用してください。

使用方法:

$ hf buckets remove [OPTIONS] ARGUMENT

引数:

ARGUMENT: バケットパス: namespace/bucket_name/path または hf://buckets/namespace/bucket_name/path。—recursive を使用する場合、すべてのファイルを対象にするために namespace/bucket_name も受け付けます。 [必須]

オプション:

-R, --recursive: 指定されたプレフィックス配下のファイルを再帰的に削除します。
-y, --yes: 確認プロンプトをスキップします。
--dry-run: 実際に削除せずに、削除される予定の内容をプレビューします。
--include TEXT: パターンに一致するファイルのみを含みます（複数指定可能）。—recursiveが必要です。
--exclude TEXT: パターンに一致するファイルを除外します（複数指定可能）。—recursiveが必要です。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf buckets remove user/my-bucket/file.txt $ hf buckets rm hf://buckets/user/my-bucket/file.txt $ hf buckets rm user/my-bucket/logs/ —recursive $ hf buckets rm user/my-bucket —recursive —include “*.tmp” $ hf buckets rm user/my-bucket/data/ —recursive —dry-run

hf buckets settings

バケット設定（可視性）を更新します。

使用方法:

$ hf buckets settings [OPTIONS] BUCKET_ID

引数:

BUCKET_ID: バケット ID: namespace/bucket_name または hf://buckets/namespace/bucket_name [必須]

オプション:

--private: バケットをプライベートにします。
--public: バケットを公開します。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf buckets settings user/my-bucket —private $ hf buckets settings user/my-bucket —public $ hf buckets settings hf://buckets/user/my-bucket —private

hf buckets sync

ローカルディレクトリとバケット間でファイルを同期します。

使用方法:

$ hf buckets sync [OPTIONS] [SOURCE] [DEST]

引数:

[SOURCE]: ソースパス: ローカルディレクトリまたはhf://buckets/namespace/bucket_name(/prefix)
[DEST]: 宛先パス: ローカルディレクトリまたはhf://buckets/namespace/bucket_name(/prefix)

オプション:

--delete / --no-delete: ソースに存在しない宛先のファイルを削除します。 [デフォルト: no-delete]
--ignore-times: 変更時刻を無視し、サイズのみを基準としてファイルをスキップします。
--ignore-sizes: サイズを無視して、変更時刻のみに基づいてファイルをスキップします。
--plan TEXT: 実行せずに、レビュー用に同期計画をJSONLファイルに保存します。
--apply TEXT: 以前に保存したプランファイルを適用します。
--dry-run: 実行せずに、同期計画をJSONL形式で標準出力に出力します。
--include TEXT: パターンに一致するファイルを含める（複数指定可能）。
--exclude TEXT: パターンに一致するファイルを除外します（複数指定可能）。
--filter-from TEXT: ファイルからインクルード/エクスクルードのパターンを読み込みます。
--existing: 受信側で新しいファイルの作成をスキップします（既存のファイルのみを更新します）。
--ignore-existing: 受信側に既に存在するファイルの更新をスキップします（新しいファイルのみを作成します）。
-v, --verbose: 推論の詳細を含む詳細なログを表示します。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf buckets sync ./data hf://buckets/user/my-bucket $ hf buckets sync hf://buckets/user/my-bucket ./data $ hf buckets sync ./data hf://buckets/user/my-bucket —delete $ hf buckets sync hf://buckets/user/my-bucket ./data —include ”.safetensors” —exclude ”.tmp” $ hf buckets sync ./data hf://buckets/user/my-bucket —plan sync-plan.jsonl $ hf buckets sync —apply sync-plan.jsonl $ hf buckets sync ./data hf://buckets/user/my-bucket —dry-run $ hf buckets sync ./data hf://buckets/user/my-bucket —dry-run | jq .

hf cache

ローカルキャッシュディレクトリを管理します。

使用方法:

$ hf cache [OPTIONS] COMMAND [ARGS]...

オプション:

--help: このメッセージを表示して終了します。

コマンド:

list: キャッシュされたリポジトリまたはリビジョンをリスト表示します。[エイリアス: ls]
prune: キャッシュから切断されたリビジョンと不完全なダウンロードを削除します。
rm: キャッシュされたリポジトリ、リビジョン、またはファイルを削除します。
verify: キャッシュまたはローカルディレクトリから、単一のリポジトリリビジョンのチェックサムを検証します。

hf cache list

キャッシュされたリポジトリまたはリビジョンをリスト表示します。[エイリアス: ls]

使用方法:

$ hf cache list [OPTIONS]

オプション:

--cache-dir TEXT: スキャンするキャッシュディレクトリ（デフォルトは Hugging Face のキャッシュ）。
--revisions / --no-revisions: 集計されたリポジトリではなく、リビジョンを出力に含める。 [デフォルト: no-revisions]
-f, --filter TEXT: エントリをフィルタリングします（例: ‘size>1GB’、‘type=model’、‘accessed>7d’）。複数回使用できます。
--sort [accessed|accessed:asc|accessed:desc|modified|modified:asc|modified:desc|name|name:asc|name:desc|size|size:asc|size:desc]: キーに基づいてエントリをソートします。サポートされているキー: ‘accessed’、‘modified’、‘name’、‘size’。順序を明示的に設定するには ‘:asc’ または ‘:desc’ を追加します (例: ‘modified:asc’)。デフォルト: ‘accessed’、‘modified’、‘size’ は ‘desc’ (最新/最大が先頭) になります。‘name’ は ‘asc’ (アルファベット順) がデフォルトです。
--limit INTEGER: 返される結果の数を制限します。ソート後、上位 N 件のエントリのみを返します。
--show-warnings / --no-show-warnings: キャッシュの不整合に関する警告を表示します。 [デフォルト: no-show-warnings]
--help: このメッセージを表示して終了します。

例 $ hf cache ls $ hf cache ls —revisions $ hf cache ls —filter “size>1GB” —limit 20 $ hf cache ls —format json

hf cache prune

キャッシュから、切り離されたリビジョンと不完全なダウンロードを削除します。

使用方法:

$ hf cache prune [OPTIONS]

オプション:

--cache-dir TEXT: スキャンするキャッシュディレクトリ（デフォルトは Hugging Face のキャッシュ）。
-y, --yes: 確認プロンプトをスキップします。
--dry-run / --no-dry-run: 何も削除せずに削除をプレビューします。 [デフォルト: no-dry-run]
--help: このメッセージを表示して終了します。

例 $ hf cache prune $ hf cache prune —dry-run

hf cache rm

キャッシュされたリポジトリ、リビジョン、またはファイルを削除します。

使用方法:

$ hf cache rm [OPTIONS] TARGETS...

引数:

TARGETS...: 削除する1つ以上のリポジトリID（例: model/bert-base-uncased）、hf:// URI（リポジトリまたはファイル）、またはリビジョンハッシュ。 [必須]

オプション:

--cache-dir TEXT: スキャンするキャッシュディレクトリ（デフォルトは Hugging Face のキャッシュ）。
-y, --yes: 確認プロンプトをスキップします。
--dry-run / --no-dry-run: 何も削除せずに削除をプレビューします。 [デフォルト: no-dry-run]
--help: このメッセージを表示して終了します。

例 $ hf cache rm model/gpt2 $ hf cache rm hf://models/openai-community/gpt2 $ hf cache rm hf://models/openai-community/gpt2/model.safetensors $ hf cache rm <revision_hash> $ hf cache rm model/gpt2 —dry-run $ hf cache rm model/gpt2 —yes

hf cache verify

…

例:

キャッシュ内のメインリビジョンを確認します: hf cache verify gpt2
特定のリビジョンを検証します: hf cache verify gpt2 --revision refs/pr/1
データセットの検証: hf cache verify karpathy/fineweb-edu-100b-shuffle --repo-type dataset
ローカルディレクトリを確認します: hf cache verify deepseek-ai/DeepSeek-OCR --local-dir /path/to/repo

使用方法:

$ hf cache verify [OPTIONS] REPO_ID

引数:

REPO_ID: リポジトリの ID（例: username/repo-name または spaces/username/repo-name）。[必須]

オプション:

--type, --repo-type [model|dataset|space|kernel]: リポジトリの種類（model、dataset、space、kernel）。[デフォルト: model]
--revision TEXT: GitのリビジョンID。ブランチ名、タグ、またはコミットハッシュを指定できます。
--cache-dir TEXT: キャッシュからファイルを検証する際に使用するキャッシュディレクトリ（デフォルトは Hugging Face キャッシュ）。
--local-dir TEXT: 設定されている場合、キャッシュではなくこのディレクトリ配下のファイルを検証します。
--fail-on-missing-files: リモートに存在するファイルがローカルに存在しない場合、失敗します。
--fail-on-extra-files: ローカルに存在するがリモートのリビジョンに存在しないファイルがある場合、失敗します。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf cache verify gpt2 $ hf cache verify gpt2 —revision refs/pr/1 $ hf cache verify my-dataset —repo-type dataset

hf コレクション

Hub上のコレクションと対話します。

使用方法:

$ hf collections [OPTIONS] COMMAND [ARGS]...

オプション:

--help: このメッセージを表示して終了します。

コマンド:

add-item: コレクションにアイテムを追加します。
create: Hub に新しいコレクションを作成します。
delete: Hubからコレクションを削除します。
delete-item: コレクションからアイテムを削除します。
info: Hub上のコレクションに関する情報を取得します。
list: Hub上のコレクションをリスト表示します。[別名: ls]
update: Hub上のコレクションのメタデータを更新します。
update-item: コレクション内のアイテムを更新します。

hf collections add-item

コレクションにアイテムを追加します。

使用方法:

$ hf collections add-item [OPTIONS] COLLECTION_SLUG ITEM_ID ITEM_TYPE:{model|dataset|space|paper|collection|bucket}

引数:

COLLECTION_SLUG: コレクションのスラッグ（例: ‘username/collection-slug’）。[必須]
ITEM_ID: 追加するアイテムのID（リポジトリの場合はrepo_id、論文の場合は論文ID）。[必須]
ITEM_TYPE:{model|dataset|space|paper|collection|bucket}: アイテムの種類（model、dataset、space、paper、collection、または bucket）。[必須]

オプション:

--note TEXT: 項目に付加するメモ（最大500文字）。
--exists-ok / --no-exists-ok: コレクションに既にアイテムが存在する場合でもエラーを発生させません。 [デフォルト: no-exists-ok]
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf collections add-item username/my-collection moonshotai/kimi-k2 model $ hf collections add-item username/my-collection Qwen/DeepPlanning dataset —note “Useful dataset” $ hf collections add-item username/my-collection Tongyi-MAI/Z-Image space

hf collections create

Hub に新しいコレクションを作成します。

使用方法:

$ hf collections create [OPTIONS] TITLE

引数:

TITLE: コレクションのタイトル。 [必須]

オプション:

--namespace TEXT: 名前空間（ユーザー名または組織名）。デフォルトでは、認証済みユーザーが使用されます。
--description TEXT: コレクションの説明（最大150文字）。
--private / --no-private: プライベートコレクションを作成します。 [デフォルト: no-private]
--exists-ok / --no-exists-ok: コレクションが既に存在する場合でもエラーを発生させません。 [デフォルト: no-exists-ok]
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf collections create “My Models” $ hf collections create “My Models” —description “A collection of my favorite models” —private $ hf collections create “Org Collection” —namespace my-org

hf collections delete

Hubからコレクションを削除します。

使用方法:

$ hf collections delete [OPTIONS] COLLECTION_SLUG

引数:

COLLECTION_SLUG: コレクションのスラッグ（例: ‘username/collection-slug’）。[必須]

オプション:

--missing-ok / --no-missing-ok: コレクションが存在しない場合でもエラーを発生させません。 [デフォルト: no-missing-ok]
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf collections delete username/my-collection $ hf collections delete username/my-collection —missing-ok

hf collections delete-item

コレクションからアイテムを削除します。

使用方法:

$ hf collections delete-item [OPTIONS] COLLECTION_SLUG ITEM_OBJECT_ID

引数:

COLLECTION_SLUG: コレクションのスラッグ（例: ‘username/collection-slug’）。[必須]
ITEM_OBJECT_ID: コレクション内のアイテムの ID（‘hf collections info’ が返す item_object_id フィールドから取得します。[必須]

オプション:

--missing-ok / --no-missing-ok: 項目が存在しない場合でもエラーを発生させません。 [デフォルト: no-missing-ok]
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

hf collections info

Hub上のコレクションに関する情報を取得します。

使用方法:

$ hf collections info [OPTIONS] COLLECTION_SLUG

引数:

COLLECTION_SLUG: コレクションのスラッグ（例: ‘username/collection-slug’）。[必須]

オプション:

--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf collections info username/my-collection-slug

hf collections list

Hub上のコレクションをリスト表示します。[alias: ls]

使用方法:

$ hf collections list [OPTIONS]

オプション:

--owner TEXT: オーナーのユーザー名または組織でフィルタリングします。
--item TEXT: 特定のアイテム（例: “models/gpt2”、“datasets/squad”、“papers/2311.12983”）を含むコレクションをフィルタリングします。
--sort [lastModified|trending|upvotes]: 最終更新日、トレンド、またはアップボートの順で結果を並べ替えます。
--limit INTEGER: 結果の件数を制限します。 [デフォルト: 10]
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf collections ls $ hf collections ls —owner nvidia $ hf collections ls —item models/teknium/OpenHermes-2.5-Mistral-7B —limit 10

hf collections update

Hub上のコレクションのメタデータを更新します。

使用方法:

$ hf collections update [OPTIONS] COLLECTION_SLUG

引数:

COLLECTION_SLUG: コレクションのスラッグ（例: ‘username/collection-slug’）。[必須]

オプション:

--title TEXT: コレクションの新しいタイトル。
--description TEXT: コレクションの新しい説明（最大150文字）。
--position INTEGER: オーナーのリストにおけるコレクションの新しい位置。
--private / --no-private: コレクションを非公開にするかどうか。
--theme TEXT: コレクションのテーマカラー（例: ‘green’, ‘blue’）。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf collections update username/my-collection —title “New Title” $ hf collections update username/my-collection —description “Updated description” $ hf collections update username/my-collection —private —theme green

hf collections update-item

コレクション内のアイテムを更新します。

使用方法:

$ hf collections update-item [OPTIONS] COLLECTION_SLUG ITEM_OBJECT_ID

引数:

COLLECTION_SLUG: コレクションのスラッグ（例: ‘username/collection-slug’）。[必須]
ITEM_OBJECT_ID: コレクション内のアイテムのID（'item_object_id' フィールドから取得し、repo_id ではありません）。[必須]

オプション:

--note TEXT: 項目用の新しいメモ（最大500文字）。
--position INTEGER: コレクション内のアイテムの新しい位置。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf collections update-item username/my-collection ITEM_OBJECT_ID —note “Updated note” $ hf collections update-item username/my-collection ITEM_OBJECT_ID —position 0

hf cp

ローカルパス、リポジトリ、バケット間でファイルをコピーします。

使用方法:

$ hf cp [OPTIONS] SRC [DST]

引数:

SRC: ソース: ローカルファイル、hf:// URI（リポジトリまたはバケット）、または stdin を示す -。[必須]
[DST]: 保存先: ローカルパス、hf:// URI (リポジトリまたはバケット)、または標準出力用の -。

オプション:

--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf cp hf://username/my-model/config.json $ hf cp hf://username/my-model/config.json ./config.json $ hf cp hf://datasets/username/my-dataset/data.csv ./data/ $ hf cp hf://buckets/username/my-bucket/config.json - $ hf cp ./model.safetensors hf://username/my-model/model.safetensors $ hf cp ./config.json hf://buckets/username/my-bucket/logs/ $ hf cp - hf://buckets/username/my-bucket/config.json $ hf cp hf://username/source-model/ hf://username/dest-model/ $ hf cp hf://datasets/username/my-dataset/processed/ hf://buckets/username/my-bucket/processed/ $ hf cp hf://buckets/username/my-bucket/logs/ hf://buckets/username/archive-bucket/ # copies contents only

hf datasets

Hub上のデータセットと対話します。

使用方法:

$ hf datasets [OPTIONS] COMMAND [ARGS]...

オプション:

--help: このメッセージを表示して終了します。

コマンド:

card: Hub上のデータセットのデータセットカード（README）を取得します。
info: Hub上のデータセットに関する情報を取得します。
leaderboard: データセットのリーダーボードからモデルのスコアをリスト表示します。
list: Hub上のデータセット、またはデータセットリポジトリ内のファイルをリスト表示します。[別名: ls]
parquet: データセットで利用可能な Parquet ファイルの URL のリスト。
sql: DuckDB を使用して、データセットの parquet URL に対して生の SQL クエリを実行します。

hf データセットカード

Hub上のデータセットのデータセットカード（README）を取得します。

使用方法:

$ hf datasets card [OPTIONS] DATASET_ID

引数:

DATASET_ID: データセットのID（例: username/repo-name）。[必須]

オプション:

--metadata: カードのメタデータのみを出力します。
--text: メタデータなしでテキスト本文のみを出力します。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf datasets card HuggingFaceFW/fineweb $ hf datasets card HuggingFaceFW/fineweb —metadata $ hf datasets card HuggingFaceFW/fineweb —metadata —format json $ hf datasets card HuggingFaceFW/fineweb —text

hf datasets info

Hub上のデータセットに関する情報を取得します。

使用方法:

$ hf datasets info [OPTIONS] DATASET_ID

引数:

DATASET_ID: データセットのID（例: username/repo-name）。[必須]

オプション:

--revision TEXT: GitのリビジョンID。ブランチ名、タグ、またはコミットハッシュを指定できます。
--expand TEXT: 返すプロパティをカンマ区切りで指定します。使用すると、リストされたプロパティ（および id）のみが返されます。例: ‘—expand=downloads,likes,tags’。有効な値: author, cardData, citation, createdAt, description, disabled, downloads, downloadsAllTime, gated, lastModified, likes, mainSize, paperswithcode_id, private, resourceGroup, sha, siblings, tags, trendingScore, usedStorage。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf datasets info HuggingFaceFW/fineweb $ hf datasets info my-dataset —expand downloads,likes,tags

hf datasets リーダーボード

データセットのリーダーボードからモデルのスコアを一覧表示します。このコマンドは、タスクに最適なモデルを見つけたり、ベンチマークスコアでモデルを比較したりするのに役立ちます。利用可能なリーダーボードを一覧表示するには、hf datasets ls —filter benchmark:official を使用します。

使用方法:

$ hf datasets leaderboard [OPTIONS] DATASET_ID

引数:

DATASET_ID: ベンチマークのデータセットID（例: SWE-bench/SWE-bench_Verified）。[必須]

オプション:

--limit INTEGER: 結果の件数を制限します。 [デフォルト: 20]
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf datasets leaderboard SWE-bench/SWE-bench_Verified $ hf datasets leaderboard SWE-bench/SWE-bench_Verified —limit 5 —format json $ hf datasets ls —filter benchmark:official # list available leaderboards

hf datasets list

Hub上のデータセット、またはデータセットリポジトリ内のファイルをリスト表示します。[エイリアス: ls]

引数なしで呼び出された場合、Hub上のデータセットをリスト表示します。データセットIDを引数として呼び出された場合、そのデータセットリポジトリ内のファイルをリスト表示します。

使用方法:

$ hf datasets list [OPTIONS] [REPO_ID]

引数:

[REPO_ID]: ファイルの一覧を取得する Dataset ID（例: username/repo-name）。省略した場合、datasets の一覧を取得します。

オプション:

--search TEXT: 検索クエリ。
--author TEXT: 作成者または組織でフィルタリングします。
--filter TEXT: タグでフィルタリングします（例: ‘text-classification’）。複数回使用できます。
--sort [created_at|downloads|last_modified|likes|trending_score]: 結果をソートします。
--limit INTEGER: 結果の件数を制限します。 [デフォルト: 30]
--expand TEXT: 返すプロパティをカンマ区切りで指定します。使用すると、リストされたプロパティ（および id）のみが返されます。例: ‘—expand=downloads,likes,tags’。有効な値: author, cardData, citation, createdAt, description, disabled, downloads, downloadsAllTime, gated, lastModified, likes, mainSize, paperswithcode_id, private, resourceGroup, sha, siblings, tags, trendingScore, usedStorage。
-h, --human-readable: サイズを人間が読みやすい形式で表示します（ファイルの一覧表示時のみ）。
--tree: ファイルをツリー形式で一覧表示します（ファイルの一覧表示時のみ）。
-R, --recursive: ファイルを再帰的に一覧表示します（ファイルの一覧表示のみ）。
--revision TEXT: GitのリビジョンID。ブランチ名、タグ、またはコミットハッシュを指定できます。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf datasets ls $ hf datasets ls —sort downloads —limit 10 $ hf datasets ls —search “code” $ hf datasets ls —filter benchmark:official $ hf datasets ls HuggingFaceFW/fineweb $ hf datasets ls HuggingFaceFW/fineweb -R $ hf datasets ls HuggingFaceFW/fineweb —tree -h

hf datasets parquet

データセットで利用可能なparquetファイルのURLをリスト表示します。

使用方法:

$ hf datasets parquet [OPTIONS] DATASET_ID

引数:

DATASET_ID: データセットのID（例: username/repo-name）。[必須]

オプション:

--subset TEXT: サブセット/設定に基づいて parquet エントリをフィルタリングします。
--split TEXT: split によって parquet エントリをフィルタリングします。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf datasets parquet cfahlgren1/hub-stats $ hf datasets parquet cfahlgren1/hub-stats —subset models $ hf datasets parquet cfahlgren1/hub-stats —split train $ hf datasets parquet cfahlgren1/hub-stats —format json

hf datasets sql

DuckDB を使用して、データセットの parquet URL に対して生の SQL クエリを実行します。

使用方法:

$ hf datasets sql [OPTIONS] SQL

引数:

SQL: 実行する生の SQL クエリ。 [必須]

オプション:

--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf datasets sql “SELECT COUNT() AS rows FROM read_parquet(’https://huggingface.co/api/datasets/cfahlgren1/hub-stats/parquet/models/train/0.parquet’)” $ hf datasets sql “SELECT FROM read_parquet(’https://huggingface.co/api/datasets/cfahlgren1/hub-stats/parquet/models/train/0.parquet’) LIMIT 5” —format json

hf discussions

Hub上でディスカッションとプルリクエストを管理します。

使用方法:

$ hf discussions [OPTIONS] COMMAND [ARGS]...

オプション:

--help: このメッセージを表示して終了します。

コマンド:

close: ディスカッションまたはプルリクエストを閉じます。
comment: ディスカッションやプルリクエストにコメントします。
create: リポジトリに新しいディスカッションまたはプルリクエストを作成します。
diff: プルリクエストの差分を表示します。
edit: ディスカッションまたはプルリクエストの既存のコメントを編集します。
info: ディスカッションまたはプルリクエストに関する情報を取得します。
list: リポジトリ上のディスカッションとプルリクエストをリスト表示します。[エイリアス: ls]
merge: プルリクエストをマージします。
rename: ディスカッションまたはプルリクエストの名前を変更します。
reopen: 閉じられたディスカッションまたはプルリクエストを再開します。

hf discussions close

ディスカッションまたはプルリクエストを閉じます。

使用方法:

$ hf discussions close [OPTIONS] REPO_ID NUM

引数:

REPO_ID: リポジトリの ID（例: username/repo-name または spaces/username/repo-name）。[必須]
NUM: 議論またはプルリクエストの番号。[必須]

オプション:

--comment TEXT: クローズ時に投稿する任意のコメント。
-y, --yes: 確認プロンプトをスキップします。
--type, --repo-type [model|dataset|space|kernel]: リポジトリの種類（model、dataset、space、kernel）。[デフォルト: model]
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf discussions close username/my-model 5 $ hf discussions close username/my-model 5 —comment “Closing as resolved.”

hf discussions comment

ディスカッションやプルリクエストにコメントします。

使用方法:

$ hf discussions comment [OPTIONS] REPO_ID NUM

引数:

REPO_ID: リポジトリの ID（例: username/repo-name または spaces/username/repo-name）。[必須]
NUM: 議論またはプルリクエストの番号。[必須]

オプション:

--body TEXT: コメントのテキスト（Markdownに対応）。
--body-file PATH: ファイルからコメントを読み込みます。標準入力を使用するには ’-’ を指定します。
--attach TEXT: 画像、動画、または音声ファイルを、‘FILE’または‘FILE#alt text’の形式で添付します。本文内の‘’参照はアップロードされたファイルに置き換えられ、その他のファイルは末尾に追加されます。複数回使用できます。
--type, --repo-type [model|dataset|space|kernel]: リポジトリの種類（model、dataset、space、kernel）。[デフォルト: model]
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf discussions comment username/my-model 5 —body “Thanks for reporting!” $ hf discussions comment username/my-model 5 —body “LGTM!” $ hf discussions comment username/my-model 5 —body “Here is a demo:” —attach demo.mp4

hf discussions create

リポジトリで新しいディスカッションまたはプルリクエストを作成します。

使用方法:

$ hf discussions create [OPTIONS] REPO_ID

引数:

REPO_ID: リポジトリの ID（例: username/repo-name または spaces/username/repo-name）。[必須]

オプション:

--title TEXT: ディスカッションまたはプルリクエストのタイトル。 [必須]
--body TEXT: 説明（Markdownに対応）。
--body-file PATH: ファイルから説明を読み込みます。標準入力を使用するには ’-’ を指定します。
--pull-request, --pr: ディスカッションではなく、プルリクエストを作成します。
--attach TEXT: 画像、動画、または音声ファイルを、‘FILE’または‘FILE#alt text’の形式で添付します。本文内の‘’参照はアップロードされたファイルに置き換えられ、その他のファイルは末尾に追加されます。複数回使用できます。
--type, --repo-type [model|dataset|space|kernel]: リポジトリの種類（model、dataset、space、kernel）。[デフォルト: model]
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf discussions create username/my-model —title “Bug report” $ hf discussions create username/my-model —title “Feature request” —body “Please add X” $ hf discussions create username/my-model —title “Fix typo” —pull-request $ hf discussions create username/my-dataset —type dataset —title “Data quality issue” $ hf discussions create username/my-model —title “Fix rendering” —pr —attach “./before.png#Before the fix” —attach ./after.png

hf discussions diff

プルリクエストの差分を表示します。

使用方法:

$ hf discussions diff [OPTIONS] REPO_ID NUM

引数:

REPO_ID: リポジトリの ID（例: username/repo-name または spaces/username/repo-name）。[必須]
NUM: 議論またはプルリクエストの番号。[必須]

オプション:

--type, --repo-type [model|dataset|space|kernel]: リポジトリの種類（model、dataset、space、kernel）。[デフォルト: model]
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf discussions diff username/my-model 5

hf discussions 編集

ディスカッションまたはプルリクエストの既存のコメントを編集します。

使用方法:

$ hf discussions edit [OPTIONS] REPO_ID NUM COMMENT_ID

引数:

REPO_ID: リポジトリの ID（例: username/repo-name または spaces/username/repo-name）。[必須]
NUM: 議論またはプルリクエストの番号。[必須]
COMMENT_ID: 編集するコメントのID（‘hf discussions info … —format json’を参照）。[必須]

オプション:

--body TEXT: 新しいコメントのテキスト（Markdownに対応）。
--body-file PATH: ファイルから新しいコメントを読み込みます。標準入力を使用するには ’-’ を指定します。
--attach TEXT: 画像、動画、または音声ファイルを、‘FILE’または‘FILE#alt text’の形式で添付します。本文内の‘’参照はアップロードされたファイルに置き換えられ、その他のファイルは末尾に追加されます。複数回使用できます。
--type, --repo-type [model|dataset|space|kernel]: リポジトリの種類（model、dataset、space、kernel）。[デフォルト: model]
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf discussions edit username/my-model 5 abc123 —body “Updated comment.” $ hf discussions edit username/my-model 5 abc123 —body-file fixed.md $ hf discussions edit username/my-model 5 abc123 —body “Fixed: result ” —attach ./after.png

hf discussions info

ディスカッションまたはプルリクエストに関する情報を取得します。

使用方法:

$ hf discussions info [OPTIONS] REPO_ID NUM

引数:

REPO_ID: リポジトリの ID（例: username/repo-name または spaces/username/repo-name）。[必須]
NUM: 議論またはプルリクエストの番号。[必須]

オプション:

--type, --repo-type [model|dataset|space|kernel]: リポジトリの種類（model、dataset、space、kernel）。[デフォルト: model]
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf discussions info username/my-model 5 $ hf discussions info username/my-model 5 —format json

hf discussions list

リポジトリのディスカッションとプルリクエストをリスト表示します。[エイリアス: ls]

使用方法:

$ hf discussions list [OPTIONS] REPO_ID

引数:

REPO_ID: リポジトリの ID（例: username/repo-name または spaces/username/repo-name）。[必須]

オプション:

-s, --status [open|closed|merged|draft|all]: ステータス（open、closed、merged、draft、all）でフィルタリングします。 [デフォルト: open]
-k, --kind [all|discussion|pull_request]: 種類（discussion、pull_request、all）でフィルタリングします。 [デフォルト: all]
--author TEXT: 作成者または組織でフィルタリングします。
--limit INTEGER: 結果の件数を制限します。 [デフォルト: 30]
--type, --repo-type [model|dataset|space|kernel]: リポジトリの種類（model、dataset、space、kernel）。[デフォルト: model]
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf discussions list username/my-model $ hf discussions list username/my-model —kind pull_request —status merged $ hf discussions list username/my-dataset —type dataset —status closed $ hf discussions list username/my-model —author alice —format json

hf discussions merge

プルリクエストをマージします。

使用方法:

$ hf discussions merge [OPTIONS] REPO_ID NUM

引数:

REPO_ID: リポジトリの ID（例: username/repo-name または spaces/username/repo-name）。[必須]
NUM: 議論またはプルリクエストの番号。[必須]

オプション:

--comment TEXT: マージ時に投稿する任意のコメント。
-y, --yes: 確認プロンプトをスキップします。
--type, --repo-type [model|dataset|space|kernel]: リポジトリの種類（model、dataset、space、kernel）。[デフォルト: model]
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf discussions merge username/my-model 5 $ hf discussions merge username/my-model 5 —comment “Merging, thanks!”

hf discussions 名前変更

ディスカッションまたはプルリクエストの名前を変更します。

使用方法:

$ hf discussions rename [OPTIONS] REPO_ID NUM NEW_TITLE

引数:

REPO_ID: リポジトリの ID（例: username/repo-name または spaces/username/repo-name）。[必須]
NUM: 議論またはプルリクエストの番号。[必須]
NEW_TITLE: 新しいタイトル。[必須]

オプション:

--type, --repo-type [model|dataset|space|kernel]: リポジトリの種類（model、dataset、space、kernel）。[デフォルト: model]
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf discussions rename username/my-model 5 “Updated title”

hf discussions 再開

クローズされたディスカッションまたはプルリクエストを再開します。

使用方法:

$ hf discussions reopen [OPTIONS] REPO_ID NUM

引数:

REPO_ID: リポジトリの ID（例: username/repo-name または spaces/username/repo-name）。[必須]
NUM: 議論またはプルリクエストの番号。[必須]

オプション:

--comment TEXT: 再開時に投稿する任意のコメント。
-y, --yes: 確認プロンプトをスキップします。
--type, --repo-type [model|dataset|space|kernel]: リポジトリの種類（model、dataset、space、kernel）。[デフォルト: model]
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf discussions reopen username/my-model 5 $ hf discussions reopen username/my-model 5 —comment “Reopening for further investigation.”

hf download

Hubからファイルをダウンロードします。

使用方法:

$ hf download [OPTIONS] REPO_ID [FILENAMES]...

引数:

REPO_ID: リポジトリの ID（例: username/repo-name または spaces/username/repo-name）。[必須]
[FILENAMES]...: ダウンロードするファイル（例: config.json、data/metadata.jsonl）。

オプション:

--type, --repo-type [model|dataset|space|kernel]: リポジトリの種類（model、dataset、space、kernel）。[デフォルト: (model)]
--revision TEXT: GitのリビジョンID。ブランチ名、タグ、またはコミットハッシュを指定できます。
--include TEXT: ダウンロード対象のファイルに含めるための Glob パターン。例: *.json
--exclude TEXT: ダウンロード対象のファイルから除外する Glob パターン。
--cache-dir TEXT: ファイルを保存するディレクトリ。
--local-dir TEXT: 設定されている場合、ダウンロードされたファイルはこのディレクトリ以下に配置されます。詳細は https://huggingface.co/docs/huggingface_hub/guides/download#download-files-to-a-local-folder を参照してください。
--force-download / --no-force-download: True の場合、ファイルがすでにキャッシュされていてもダウンロードされます。 [デフォルト: no-force-download]
--dry-run / --no-dry-run: True の場合、ファイルをダウンロードせずにドライランを実行します。 [デフォルト: no-dry-run]
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--max-workers INTEGER: ファイルのダウンロードに使用するワーカーの最大数。デフォルトは 8 です。 [default: 8]
--help: このメッセージを表示して終了します。

例 $ hf download meta-llama/Llama-3.2-1B-Instruct $ hf download meta-llama/Llama-3.2-1B-Instruct config.json tokenizer.json $ hf download meta-llama/Llama-3.2-1B-Instruct —include ”.safetensors” —exclude ”.bin” $ hf download meta-llama/Llama-3.2-1B-Instruct —local-dir ./models/llama $ hf download HuggingFaceM4/FineVision art/ —repo-type dataset $ hf download hf://datasets/HuggingFaceH4/ultrachat_200k

hf endpoints

Hugging Face Inference Endpoints を管理します。

使用方法:

$ hf endpoints [OPTIONS] COMMAND [ARGS]...

オプション:

--help: このメッセージを表示して終了します。

コマンド:

catalog: Inference Endpointsのカタログを操作します。
delete: Inference Endpoint を完全に削除します。
deploy: HubリポジトリからInference Endpointをデプロイします。
describe: 既存のエンドポイントに関する情報を取得します。
hardware: Inference Endpoint のデプロイに使用可能なハードウェアをリストします。
list: 指定された namespace 内のすべての Inference Endpoints を一覧表示します。[alias: ls]
list-catalog: Model Catalog で利用可能なモデルをリスト表示します。
pause: Inference Endpointを一時停止します。
resume: Inference Endpointを再開します。
scale-to-zero: Inference Endpointをゼロにスケーリングします。
update: 既存のエンドポイントを更新します。

hf エンドポイントカタログ

Inference Endpointsカタログと対話します。

使用方法:

$ hf endpoints catalog [OPTIONS] COMMAND [ARGS]...

オプション:

--help: このメッセージを表示して終了します。

コマンド:

deploy: Model CatalogからInference Endpointをデプロイします。
list: Model Catalog で利用可能なモデルをリスト表示します。[別名: ls]

hf endpoints catalog deploy

モデルカタログから推論エンドポイントをデプロイします。

Catalog models are deployed through a recipe: a hardware and engine combination that has been tested for them. Pass —repo to deploy the default recipe of a model, optionally narrowed down with —accelerator and —gguf-file, or pass —recipe to deploy an exact recipe listed by hf endpoints catalog ls.

使用方法:

$ hf endpoints catalog deploy [OPTIONS]

オプション:

--repo TEXT: Inference Endpointに関連付けられたモデルリポジトリの名前（例: ‘openai/gpt-oss-120b’）。デフォルトのレシピをデプロイします。—recipeと排他です。
--recipe TEXT: デプロイするカタログレシピのIDです。‘hf endpoints catalog ls’で一覧表示されるものと同じです。—repoとは排他的です。
--name TEXT: エンドポイント名。
--accelerator [cpu|gpu|neuron]: 推論に使用するハードウェアアクセラレーターです。—repo のみで利用可能です。
--gguf-file TEXT: 1つの量子化ごとに1つのレシピを持つモデルの場合、デプロイするGGUFファイル。—repoとのみ使用可能。
--namespace TEXT: Inference Endpointに関連付けられる名前空間。デフォルトでは、現在のユーザーの名前空間が使用されます。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf endpoints catalog deploy —repo meta-llama/Llama-3.2-1B-Instruct $ hf endpoints catalog deploy —recipe sizzling-biryani-g4xsi1ac

hf endpoints catalog list

Model Catalog で利用可能なモデルをリスト表示します。 [alias: ls]

レシピごとに1行、つまりモデルのデプロイ方法のテスト済み1つごとに1行です。hf endpoints catalog deploy --recipe <RECIPE_ID> を使用してデプロイします。

使用方法:

$ hf endpoints catalog list [OPTIONS]

オプション:

--accelerator [cpu|gpu|neuron]: このアクセラレーターで実行されるレシピのみを表示します。
--engine [llamacpp|sglang|tei|vllm]: この推論エンジンで実行されるレシピのみを表示します。
--license TEXT: このライセンス（例: ‘Apache 2.0’）の下にあるモデルのみを表示します。
--task TEXT: このタスク（例: ‘text-generation’）のモデルのみを表示します。
--search TEXT: 検索クエリ。
--limit INTEGER: 返すモデルの数を制限します。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf endpoints catalog ls $ hf endpoints catalog ls —engine vllm

hf endpoints delete

Inference Endpointを完全に削除します。

使用方法:

$ hf endpoints delete [OPTIONS] NAME

引数:

NAME: エンドポイント名。[必須]

オプション:

--namespace TEXT: Inference Endpointに関連付けられる名前空間。デフォルトでは、現在のユーザーの名前空間が使用されます。
--yes: 確認プロンプトをスキップします。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf endpoints delete my-endpoint

hf endpoints deploy

HubリポジトリからInference Endpointをデプロイします。

hf endpoints hardware を実行すると、有効な --vendor、--region、--accelerator、--instance-type および --instance-size の組み合わせがリスト表示されます。

使用方法:

$ hf endpoints deploy [OPTIONS] NAME

引数:

NAME: エンドポイント名。[必須]

オプション:

--repo TEXT: Inference Endpointに関連付けられたモデルリポジトリの名前（例: ‘openai/gpt-oss-120b’）。[必須]
--framework TEXT: モデルに使用される機械学習フレームワーク（例: ‘vllm’）。 [必須]
--accelerator TEXT: 推論に使用するハードウェアアクセラレータ（例: ‘cpu’）。 [必須]
--instance-size TEXT: モデルをホストするために使用するインスタンスのサイズまたはタイプ（例: ‘x4’）。[必須]
--instance-type TEXT: Inference Endpoint がデプロイされるクラウドインスタンスのタイプ（例: ‘intel-icl’）。[必須]
--region TEXT: Inference Endpoint が作成されるクラウドリージョン（例: ‘us-east-1’）。[必須]
--vendor TEXT: Inference Endpointがホストされるクラウドプロバイダーまたはベンダー（例: ‘aws’）。[必須]
--namespace TEXT: Inference Endpointに関連付けられる名前空間。デフォルトでは、現在のユーザーの名前空間が使用されます。
--task TEXT: モデルをデプロイするタスク（例: ‘text-classification’）。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--min-replica INTEGER: Inference Endpoint で稼働させ続けるレプリカ（インスタンス）の最小数。 [デフォルト: 1]
--max-replica INTEGER: Inference Endpoint をスケーリングする際のレプリカ（インスタンス）の最大数。 [デフォルト: 1]
--scale-to-zero-timeout INTEGER: 非アクティブなエンドポイントがゼロにスケーリングされるまでの時間（分）。
--scaling-metric [pendingRequests|hardwareUsage]: スケーリングの指標参照。
--scaling-threshold FLOAT: スケールアップをトリガーするために使用されるスケーリングメトリクスの閾値です。スケーリングメトリクスが指定されていない場合は無視されます。
--revision TEXT: GitのリビジョンID。ブランチ名、タグ、またはコミットハッシュを指定できます。
--custom-image TEXT: 実行するコンテナ用のDockerイメージのURL（例: ‘nexagi/sglang:v0.5.12’）。「—framework custom」が必要です。
--engine [custom|hf-serve|llamacpp|sglang|tei|tgi|tgi-neuron|vllm|vllm-neuron]: 実行するマネージドエンジンイメージ — custom-image と（例: ‘vllm’）と組み合わせて使用します。デフォルトでは、任意のコンテナが使用されます。
--health-route TEXT: コンテナが公開するヘルスチェック用のルート（例: ‘/health’）。—custom-image の指定が必要です。
--port INTEGER: コンテナがリッスンするポート（例: 30000）。—custom-imageが必要です。
--container-registry-username TEXT: —custom-image をホストするレジストリへの認証に使用されるユーザー名。
--container-registry-password TEXT: —custom-image をホストするレジストリへの認証に使用する任意のパスワード。
--tensor-parallel-size INTEGER: 単一のモデルコピーを分割して配置するアクセラレータの数（vLLMおよびSGLangエンジンのみ）。
--data-parallel-size INTEGER: アクセラレータごとに1つずつ実行するモデルのコピー数（vLLM エンジンのみ）。
--container-command TEXT: コンテナのエントリポイントを、トークンに分割された引用符付き文字列として上書きします（例: “python -m sglang.launch_server”）。
--container-args TEXT: コンテナのエントリポイントに追加される引数。トークンに分割される引用符付きの文字列です（例: “—tp 8 —reasoning-parser qwen3”）。
-e, --env TEXT: 環境変数を設定します。例: —env ENV=value
--env-file TEXT: 環境変数を含むファイルを読み込みます。- を使用すると、stdin から読み込むことができます。
-s, --secrets TEXT: シークレット環境変数を設定します。環境から値を読み込むには --secrets SECRET を優先してください（例: Hugging Face トークンを渡すには --secrets HF_TOKEN）。--secrets SECRET=value は値をシェル履歴に記録してしまいます。
--secrets-file TEXT: シークレット環境変数を含むファイルを読み込みます。- を使用すると、stdin から読み込むことができます。
--type [public|authenticated|private]: エンドポイントのアクセスタイプ。デフォルトは ‘authenticated’（トークンによるゲート制御、パブリックに到達可能）です。
--help: このメッセージを表示して終了します。

例 $ hf endpoints deploy my-endpoint —repo gpt2 —framework pytorch … $ hf endpoints deploy my-endpoint —repo openai/gpt-oss-120b —framework custom —engine vllm —custom-image vllm/vllm-openai:v0.23.0 —tensor-parallel-size 8 …

hf endpoints describe

既存のエンドポイントに関する情報を取得します。

使用方法:

$ hf endpoints describe [OPTIONS] NAME

引数:

NAME: エンドポイント名。[必須]

オプション:

--namespace TEXT: Inference Endpointに関連付けられる名前空間。デフォルトでは、現在のユーザーの名前空間が使用されます。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf endpoints describe my-endpoint

hf endpoints ハードウェア

Inference Endpoint のデプロイに使用できるハードウェアをリスト表示します。

現在、その名前空間がデプロイできるハードウェアのみがリストされます。利用可能なステータスと、1つのレプリカ分のアクセラレータ割当が十分に残っていることを示します。APIが返すすべての組み合わせをリストするには、--allを使用してください。

Quotaはnamespaceごとに管理されるため、hf endpoints deployに渡すのと同じ--namespaceを指定してください。料金はUSDで、レプリカ1つあたり1時間あたりの金額です。

使用方法:

$ hf endpoints hardware [OPTIONS]

オプション:

--namespace TEXT: Inference Endpointに関連付けられる名前空間。デフォルトでは、現在のユーザーの名前空間が使用されます。
--vendor TEXT: このクラウドプロバイダー（例：‘aws’）がホストするハードウェアのみを表示します。
--region TEXT: このクラウドリージョンで利用可能なハードウェアのみを表示します（例: ‘us-east-1’）。
--accelerator TEXT: このアクセラレーター（例: ‘cpu’、‘gpu’、‘neuron’）を持つハードウェアのみを表示します。
--instance-type TEXT: このインスタンスタイプのハードウェアのみを表示します（例: ‘nvidia-l4’）。
-a, --all: 現在デプロイできないハードウェア（利用不可、非推奨、またはクォータ超過）も表示します。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf endpoints hardware $ hf endpoints hardware —vendor aws —accelerator gpu

hf endpoints list

指定された名前空間のすべてのInference Endpointsをリスト表示します。[alias: ls]

使用方法:

$ hf endpoints list [OPTIONS]

オプション:

--namespace TEXT: Inference Endpointに関連付けられる名前空間。デフォルトでは、現在のユーザーの名前空間が使用されます。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf endpoints ls $ hf endpoints ls —namespace my-org

hf endpoints list-catalog

Model Catalog で利用可能なモデルをリスト表示します。

レシピごとに1行、つまりモデルのデプロイ方法のテスト済み1つごとに1行です。hf endpoints catalog deploy --recipe <RECIPE_ID> を使用してデプロイします。

使用方法:

$ hf endpoints list-catalog [OPTIONS]

オプション:

--accelerator [cpu|gpu|neuron]: このアクセラレーターで実行されるレシピのみを表示します。
--engine [llamacpp|sglang|tei|vllm]: この推論エンジンで実行されるレシピのみを表示します。
--license TEXT: このライセンス（例: ‘Apache 2.0’）の下にあるモデルのみを表示します。
--task TEXT: このタスク（例: ‘text-generation’）のモデルのみを表示します。
--search TEXT: 検索クエリ。
--limit INTEGER: 返すモデルの数を制限します。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

hf endpoints pause

Inference Endpointを一時停止します。

使用方法:

$ hf endpoints pause [OPTIONS] NAME

引数:

NAME: エンドポイント名。[必須]

オプション:

--namespace TEXT: Inference Endpointに関連付けられる名前空間。デフォルトでは、現在のユーザーの名前空間が使用されます。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf endpoints pause my-endpoint

hf endpoints resume

Inference Endpointを再開します。

使用方法:

$ hf endpoints resume [OPTIONS] NAME

引数:

NAME: エンドポイント名。[必須]

オプション:

--namespace TEXT: Inference Endpointに関連付けられる名前空間。デフォルトでは、現在のユーザーの名前空間が使用されます。
--fail-if-already-running: Trueの場合、Inference Endpointが既に実行中の場合は、このメソッドがエラーを送出します。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf endpoints resume my-endpoint

hf endpoints scale-to-zero

Inference Endpointをゼロにスケールします。

使用方法:

$ hf endpoints scale-to-zero [OPTIONS] NAME

引数:

NAME: エンドポイント名。[必須]

オプション:

--namespace TEXT: Inference Endpointに関連付けられる名前空間。デフォルトでは、現在のユーザーの名前空間が使用されます。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf endpoints scale-to-zero my-endpoint

hf endpoints update

既存のエンドポイントを更新します。

使用方法:

$ hf endpoints update [OPTIONS] NAME

引数:

NAME: エンドポイント名。[必須]

オプション:

--namespace TEXT: Inference Endpointに関連付けられる名前空間。デフォルトでは、現在のユーザーの名前空間が使用されます。
--repo TEXT: Inference Endpointに関連付けられたモデルリポジトリの名前（例: ‘openai/gpt-oss-120b’）。
--accelerator TEXT: 推論に使用するハードウェアアクセラレータ（例: ‘cpu’）。
--instance-size TEXT: モデルをホスティングするために使用するインスタンスのサイズまたはタイプ（例: ‘x4’）。
--instance-type TEXT: Inference Endpoint がデプロイされるクラウドインスタンスのタイプ（例: ‘intel-icl’）。
--framework TEXT: モデルに使用される機械学習フレームワーク（例: ‘custom’）。
--revision TEXT: Inference Endpoint にデプロイする特定のモデルのリビジョン（例: ‘6c0e6080953db56375760c0471a8c5f2929baf11’）。
--task TEXT: モデルをデプロイするタスク（例: ‘text-classification’）。
--custom-image TEXT: 実行するコンテナのDockerイメージURL（例: ‘nexagi/sglang:v0.5.12’）。エンドポイントに現在設定されているイメージをパッチ適用するのではなく置き換えるため、保持したいエンジンおよびコンテナの設定を一緒に渡す必要があります。それらの設定を確認するには、先に ‘hf endpoints describe NAME’ を実行してください。
--engine [custom|hf-serve|llamacpp|sglang|tei|tgi|tgi-neuron|vllm|vllm-neuron]: 実行するマネージドエンジンイメージ — custom-image と（例: ‘vllm’）と組み合わせて使用します。デフォルトでは、任意のコンテナが使用されます。
--health-route TEXT: コンテナが公開するヘルスチェック用のルート（例: ‘/health’）。—custom-image の指定が必要です。
--port INTEGER: コンテナがリッスンするポート（例: 30000）。—custom-imageが必要です。
--tensor-parallel-size INTEGER: 単一のモデルコピーを分割して配置するアクセラレータの数（vLLMおよびSGLangエンジンのみ）。
--data-parallel-size INTEGER: アクセラレータごとに1つずつ実行するモデルのコピー数（vLLM エンジンのみ）。
--container-command TEXT: コンテナのエントリポイントを、トークンに分割された引用符付き文字列として上書きします（例: “python -m sglang.launch_server”）。現在の値を置き換えます。クリアするには空文字列を渡します。
--container-args TEXT: コンテナのエントリポイントに追加される引数です。トークンに分割される引用符付きの文字列として指定します（例: “—enable-auto-tool-choice —tool-call-parser lfm2”）。エンドポイントに現在設定されている引数を上書きするもので、追加ではありません。そのため、保持したい引数もすべて含める必要があります。現在の設定を確認するには、まず ‘hf endpoints describe NAME’ を実行してください。空の文字列を渡すと、引数がクリアされます。
--min-replica INTEGER: Inference Endpointで稼働させ続けるレプリカ（インスタンス）の最小数。
--max-replica INTEGER: Inference Endpointのスケーリング先となるレプリカ（インスタンス）の最大数。
--scale-to-zero-timeout INTEGER: 非アクティブなエンドポイントがゼロにスケーリングされるまでの時間（分）。
--scaling-metric [pendingRequests|hardwareUsage]: スケーリングの指標参照。
--scaling-threshold FLOAT: スケールアップをトリガーするために使用されるスケーリングメトリクスの閾値です。スケーリングメトリクスが指定されていない場合は無視されます。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf endpoints update my-endpoint —min-replica 2 $ hf endpoints update my-endpoint —tensor-parallel-size 8 $ hf endpoints update my-endpoint —container-args “—enable-auto-tool-choice —tool-call-parser lfm2”

hf env

環境に関する情報を出力します。

使用方法:

$ hf env [OPTIONS]

オプション:

--help: このメッセージを表示して終了します。

hf extensions

hf CLIの拡張機能を管理します。[エイリアス: ext]

セキュリティ警告: extensionsはサードパーティの実行ファイルまたはPythonパッケージです。信頼できるソースからのみインストールしてください。

使用方法:

$ hf extensions [OPTIONS] COMMAND [ARGS]...

オプション:

--help: このメッセージを表示して終了します。

コマンド:

exec: インストール済みの拡張機能を実行します。
install: 公開されている GitHub リポジトリから拡張機能をインストールします。
list: インストールされた拡張コマンドをリスト表示します。[エイリアス: ls]
remove: インストール済みの拡張機能を削除します。[別名: rm]
search: GitHubで利用可能な拡張機能（‘hf-extension’トピックでタグ付けされているもの）を検索します。
update: インストール済みの拡張機能を最新バージョンに更新します。

hf extensions exec

インストール済みの拡張機能を実行します。

使用方法:

$ hf extensions exec [OPTIONS] NAME

引数:

NAME: 拡張機能の名前（hf-プレフィックスの有無を問わず）。[必須]

オプション:

--help: このメッセージを表示して終了します。

例 $ hf extensions exec claude — —help $ hf extensions exec claude —model zai-org/GLM-5

hf extensions install

公開GitHubリポジトリから拡張機能をインストールします。

セキュリティ警告: これはサードパーティの実行ファイルまたはPythonパッケージをインストールします。信頼できるソースからのみインストールしてください。

使用方法:

$ hf extensions install [OPTIONS] REPO_ID

引数:

REPO_ID: [OWNER/]hf-<name> 形式の GitHub 拡張リポジトリ。 [必須]

オプション:

--force: すでにインストールされている場合は上書きします。
--help: このメッセージを表示して終了します。

例 $ hf extensions install hf-claude $ hf extensions install hanouticelina/hf-claude $ hf extensions install alvarobartt/hf-mem

hf extensions list

インストールされた拡張コマンドをリスト表示します。[alias: ls]

使用方法:

$ hf extensions list [OPTIONS]

オプション:

--help: このメッセージを表示して終了します。

例 $ hf extensions list

hf extensions remove

インストール済みの拡張機能を削除します。[エイリアス: rm]

使用方法:

$ hf extensions remove [OPTIONS] NAME

引数:

NAME: 削除する拡張機能の名前（hf-プレフィックスの有無を問わず）。[必須]

オプション:

--help: このメッセージを表示して終了します。

例 $ hf extensions remove claude

hf extensions search

GitHubで利用可能な拡張機能（‘hf-extension’トピックでタグ付けされているもの）を検索します。

使用方法:

$ hf extensions search [OPTIONS]

オプション:

--help: このメッセージを表示して終了します。

例 $ hf extensions search

hf extensions update

インストール済みの拡張機能を最新バージョンに更新します。

使用方法:

$ hf extensions update [OPTIONS] [NAME]

引数:

[NAME]: 更新する拡張機能（hf-プレフィックスの有無を問わず、OWNER/hf-<name>の形式で指定することも可能）。省略した場合、インストール済みのすべての拡張機能がチェックされ、古いものが更新されます。

オプション:

--help: このメッセージを表示して終了します。

例 $ hf extensions update $ hf extensions update hf-claude $ hf extensions update alvarobartt/hf-mem

hf jobs

Hub上でジョブを実行して管理します。

使用方法:

$ hf jobs [OPTIONS] COMMAND [ARGS]...

オプション:

--help: このメッセージを表示して終了します。

コマンド:

cancel: ジョブをキャンセルします
expose: 実行中のJobで公開されているポートを置き換えます。
hardware: Jobsで利用可能なハードウェアオプションをリスト表示します
inspect: 1つ以上のJobの詳細情報を表示します
labels: Jobのラベルを更新します。
list: ジョブのリストを表示します。[別名: ls, ps]
logs: Jobのログを取得します。
rerun: 既存のJobのspecを使用して、新しいJobを実行します。
run: Job を実行します。
scheduled: Hub上でスケジュールされたJobを作成・管理します。
ssh: 実行中のJobにSSH接続します。
stats: Jobsのリソース使用状況の統計情報とメトリクスを取得します。
uv: HFインフラ上でUVスクリプト（インライン依存関係付きのPython）を実行します。
wait: 1 つ以上の Job が終端状態に達するまで待機します。

hf jobs cancel

ジョブのキャンセル

使用方法:

$ hf jobs cancel [OPTIONS] JOB_ID

引数:

JOB_ID: ジョブ ID（または ‘namespace/job_id’） [必須]

オプション:

--namespace TEXT: ジョブが実行される名前空間です。デフォルトでは、現在のユーザーの名前空間が使用されます。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf jobs cancel <job_id>

hf jobs expose

実行中のJobで公開されているポートを置き換えます。

使用方法:

$ hf jobs expose [OPTIONS] JOB_ID [PORTS]...

引数:

JOB_ID: ジョブ ID（または ‘namespace/job_id’） [必須]
[PORTS]...: ジョブプロキシ経由で公開するポート。アクセスには、そのジョブのネームスペースに対する読み取りアクセス権限を持つ HF トークンが必要です。

オプション:

--public INTEGER: 認証なしでポートを公開します。複数のポートを公開する場合は、このフラグを繰り返し指定します。ポートを位置引数として指定する必要はありません。
--clear: 公開されているすべてのポートを閉じます。
--namespace TEXT: ジョブが実行される名前空間です。デフォルトでは、現在のユーザーの名前空間が使用されます。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf jobs expose <job_id> 8000 $ hf jobs expose <job_id> 8000 —public 9000 $ hf jobs expose <job_id> —clear

hf jobs hardware

Jobsで利用可能なハードウェアオプションをリスト表示

使用方法:

$ hf jobs hardware [OPTIONS]

オプション:

--help: このメッセージを表示して終了します。

例 $ hf jobs hardware

hf jobs inspect

1つ以上のJobの詳細情報を表示します

使用方法:

$ hf jobs inspect [OPTIONS] JOB_IDS...

引数:

JOB_IDS...: 確認するジョブ ID（または ‘namespace/job_id’） [必須]

オプション:

--namespace TEXT: ジョブが実行される名前空間です。デフォルトでは、現在のユーザーの名前空間が使用されます。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf jobs inspect <job_id>

hf jobs labels

Jobのラベルを更新します。—labelを渡すと、既存のラベルがすべて置き換えられます。—nameのみを渡すと、ラベルは保持されます。

使用方法:

$ hf jobs labels [OPTIONS] JOB_ID

引数:

JOB_ID: ジョブ ID（または ‘namespace/job_id’） [必須]

オプション:

--name TEXT: Job の名前を指定します。name ラベルとして保存されます。名前の一意性は必須ではありません。デフォルトでは、イメージまたはスクリプトの名前と、解決された起動設定の短いハッシュ値が使用されます。
-l, --label TEXT: ラベルを設定します。例: —label KEY=VALUE または —label LABEL
--clear: ジョブからすべてのラベルを削除します。
--namespace TEXT: ジョブが実行される名前空間です。デフォルトでは、現在のユーザーの名前空間が使用されます。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf jobs labels <job_id> —name training-v2 $ hf jobs labels <job_id> —label env=prod —label team=ml $ hf jobs labels <job_id> —clear

hf jobs list | ls | ps

ジョブのリスト表示

--status を使用してステータスでフィルタリングし（可能な値は JobStage を参照）、--label を使用して key=value のラベルでフィルタリングします。Job はすべてのフィルタに一致した場合のみリストに表示されます。

使用方法:

$ hf jobs list | ls | ps [OPTIONS]

オプション:

-a, --all: すべての Jobs を表示します（デフォルトでは running と scheduling のみ表示されます）。—status と併用することはできません。
--status [COMPLETED|CANCELED|ERROR|DELETED|SCHEDULING|RUNNING]: 指定したステータスを持つ Job のみを表示します。カンマ区切りまたは繰り返し指定で、例: --status running,scheduling。
-l, --label TEXT: 指定されたkey=valueラベルを持つJobsのみを表示します。複数のラベルを指定するには、例えば--label env=prod --label team=mlのように繰り返し使用します。
--name TEXT: 指定した名前のJobsのみを表示します（--label name=NAMEのショートカット）。
--limit INTEGER: 表示する Job の最大数。0 に設定するとすべて表示されます（制限なし）。 [デフォルト: 100]
--namespace TEXT: ジョブが実行される名前空間です。デフォルトでは、現在のユーザーの名前空間が使用されます。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf jobs ls $ hf jobs ls -a $ hf jobs ls —status running,scheduling $ hf jobs ls —name training-v2 $ hf jobs ls —label env=prod —label team=ml $ hf jobs ls —all —label hf-sandbox=1

hf jobs logs

Jobのログを取得します。

By default, prints currently available logs and exits (non-blocking). Use —follow/-f to stream logs in real-time until the job completes. Use —tail/-n to limit the number of lines returned (server-side when supported).

注: ログストリームが終了すると、ジョブが成功したか失敗したかに関わらず、このコマンドは終了します。最終的なステータスを確認するには、hf jobs inspect <job_id> を実行してください。

使用方法:

$ hf jobs logs [OPTIONS] JOB_ID

引数:

JOB_ID: ジョブ ID（または ‘namespace/job_id’） [必須]

オプション:

-f, --follow: ログ出力を追跡します（ジョブが完了するまでストリーミングします）。このフラグを指定しない場合、現在利用可能なログのみが表示されます。
-n, --tail INTEGER: ログの末尾から表示する行数。—follow と組み合わせて使用すると、最後の N 行からストリーミングを開始します。
--namespace TEXT: ジョブが実行される名前空間です。デフォルトでは、現在のユーザーの名前空間が使用されます。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf jobs logs <job_id> $ hf jobs logs -f <job_id> $ hf jobs logs —tail 20 <job_id> $ hf jobs logs -f —tail 100 <job_id>

hf jobs rerun

既存のJobのspecを使用して新しいJobを実行します。

使用方法:

$ hf jobs rerun [OPTIONS] JOB_ID

引数:

JOB_ID: ジョブ ID（または ‘namespace/job_id’） [必須]

オプション:

-d, --detach: Job をバックグラウンドで実行し、Job ID を出力します。
--namespace TEXT: ジョブが実行される名前空間です。デフォルトでは、現在のユーザーの名前空間が使用されます。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf jobs rerun <job_id> $ hf jobs rerun —detach <job_id>

hf jobs run

ジョブを実行します。

使用方法:

$ hf jobs run [OPTIONS] IMAGE COMMAND...

引数:

IMAGE: 使用する Docker イメージ。[必須]
COMMAND...: 実行するコマンド。[必須]

オプション:

-e, --env TEXT: 環境変数を設定します。例: —env ENV=value
-s, --secrets TEXT: シークレット環境変数を設定します。環境から値を読み込むには --secrets SECRET を優先してください（例: Hugging Face トークンを渡すには --secrets HF_TOKEN）。--secrets SECRET=value は値をシェル履歴に記録してしまいます。
--name TEXT: Job の名前を指定します。name ラベルとして保存されます。名前の一意性は必須ではありません。デフォルトでは、イメージまたはスクリプトの名前と、解決された起動設定の短いハッシュ値が使用されます。
-l, --label TEXT: ラベルを設定します。例: —label KEY=VALUE または —label LABEL
-v, --volume TEXT: 1 つ以上のボリュームをマウントします。形式: hf://[TYPE/]SOURCE:/MOUNT_PATH[:ro|:rw] または LOCAL_DIR:/MOUNT_PATH[:ro|:rw]。TYPE は models、datasets、spaces、buckets のいずれかです。TYPE を省略した場合、デフォルトで models になります。models、datasets、spaces は常に読み取り専用でマウントされます。buckets はデフォルトで読み書き可能です。ローカルディレクトリをソースとする場合、まず bucket に同期され、デフォルトでは読み取り専用でマウントされます。例: -v hf://datasets/org/ds:/data または -v hf://buckets/org/b:/mnt:ro または -v ./inputs:/inputs
--env-file TEXT: 環境変数を含むファイルを読み込みます。- を使用すると、stdin から読み込むことができます。
--secrets-file TEXT: シークレット環境変数を含むファイルを読み込みます。- を使用すると、stdin から読み込むことができます。
--flavor [cpu-basic|cpu-upgrade|cpu-performance|cpu-xl|t4-small|t4-medium|l4x1|l4x4|l40sx1|l40sx4|l40sx8|a10g-small|a10g-large|a10g-largex2|a10g-largex4|a100-large|a100x4|a100x8|h200|h200x2|h200x4|h200x8|rtx-pro-6000|rtx-pro-6000x2|rtx-pro-6000x4|rtx-pro-6000x8]: ハードウェアの Flavor を指定します。利用可能な Flavor の一覧を確認するには、‘hf jobs hardware’ を実行してください。デフォルト値は cpu-basic です。
--timeout TEXT: 最大持続時間: s（秒、デフォルト）、m（分）、h（時間）、d（日）付きの int。
--attempts INTEGER RANGE: 最大試行回数（初回実行を含む）。デフォルトは1です。 [x>=1]
-d, --detach: Job をバックグラウンドで実行し、Job ID を出力します。
--dry-run: Jobを送信せずに、解決されたJobの設定を出力します。
--expose INTEGER: jobs プロキシを介してコンテナのポートを公開します。複数のポートを公開する場合は、フラグを繰り返し指定します（例: --expose 8000 --expose 8001）。公開された各ポートは、パブリックな jobs ドメインからアクセスできます。アクセスには、そのジョブの namespace に対する読み取りアクセス権限を持つ HF トークンが必要です。
--expose-public INTEGER: 認証なしで、ジョブのプロキシを介してコンテナのポートを公開します。複数のポートを公開する場合は、このフラグを繰り返し指定します。--exposeでポートを指定する必要はありません。
--ssh: ジョブのコンテナを SSH 経由で接続可能にします。hf jobs ssh <job_id> を使用して接続します。https://huggingface.co/settings/keys に SSH 公開鍵を登録している必要があります。
--network-group TEXT: ネットワークグループに参加します。同じ namespace と resource group を共有し、同じグループに属するジョブは一緒に配置され、すべてのポートで相互に到達できます。各メンバー内で、$HF_NETWORK_GROUP_HOSTNAME はすべてのメンバーに解決されます。小文字の英数字とダッシュのみ使用可能で、最大 46 文字です。
--network-alias TEXT: ネットワークグループ内でエイリアスを確保します。メンバーは、${HF_NETWORK_GROUP_PREFIX}<alias> を介して、このエイリアスを確保したジョブにアクセスできます。複数のエイリアスを指定するには、このフラグを繰り返し使用します。小文字の英数字とダッシュのみ使用でき、最大34文字、ジョブ内で一意である必要があります。--network-group の指定が必要です。
--resource-group-id TEXT: ジョブを作成するリソースグループのIDです。組織内のリソースへのアクセス制御や、コストの帰属/支出制限機能に使用されます。
--namespace TEXT: ジョブが実行される名前空間です。デフォルトでは、現在のユーザーの名前空間が使用されます。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--format [agent|auto|human|json|quiet]: 出力形式。デフォルトは ‘auto’ で、ターミナルに基づいて ‘agent’ または ‘human’ を選択します。
--json: JSON出力。「—format json」と同等です。
-q, --quiet: 出力を静かにします（1行に1つのID）。‘—format quiet’ と同等です。
--help: このメッセージを表示して終了します。

例 $ hf jobs run —name hello-world python:3.12 python -c ‘print(“Hello!”)’ $ hf jobs run —detach python:3.12 python script.py $ hf jobs run -e FOO=foo python:3.12 python script.py $ hf jobs run —secrets HF_TOKEN python:3.12 python script.py $ hf jobs run -v hf://org/my-model:/data -v hf://buckets/org/b:/mnt python:3.12 python script.py

hf jobs scheduled

Hub上でスケジュールされたJobsを作成・管理します。

使用方法:

$ hf jobs scheduled [OPTIONS] COMMAND [ARGS]...

オプション:

--help: このメッセージを表示して終了します。

コマンド:

delete: スケジュールされた Job を削除します。
inspect: 1つ以上のスケジュール済みJobの詳細情報を表示します
labels: スケジュールされたJobのラベルを更新します。
list: スケジュールされたジョブをリスト表示します。[別名: ls, ps]
reschedule: スケジュールされた Job の実行時刻を変更します。
resume: スケジュールされたJobを再開（一時停止解除）します。
run: ジョブをスケジュールします。
suspend: スケジュールされたJobを停止（一時停止）します。
trigger: 予定された Job を即座に実行するトリガー（スケジュールは変更されません）。
uv: HFインフラ上でUVスクリプトをスケジュールします。

hf jobs scheduled delete

スケジュールされたJobを削除します。

使用方法:

$ hf jobs scheduled delete [OPTIONS] SCHEDULED_JOB_ID

引数:

SCHEDULED_JOB_ID: スケジュールジョブID（または ‘namespace/scheduled_job_id’） [必須]

オプション:

--namespace TEXT: ジョブが実行される名前空間です。デフォルトでは、現在のユーザーの名前空間が使用されます。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf jobs scheduled delete <id>

hf jobs scheduled inspect

スケジュールされた1つ以上のJobの詳細情報を表示します

使用方法:

$ hf jobs scheduled inspect [OPTIONS] SCHEDULED_JOB_IDS...

引数:

SCHEDULED_JOB_IDS...: 確認する Scheduled Job の ID（または ‘namespace/scheduled_job_id’） [必須]

オプション:

--namespace TEXT: ジョブが実行される名前空間です。デフォルトでは、現在のユーザーの名前空間が使用されます。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf jobs scheduled inspect <id>

hf jobs スケジュールラベル

スケジュールされたJobのラベルを更新します。—labelを渡すと、既存のラベルがすべて置き換えられます。—nameのみを渡すと、ラベルは保持されます。

使用方法:

$ hf jobs scheduled labels [OPTIONS] SCHEDULED_JOB_ID

引数:

SCHEDULED_JOB_ID: スケジュールジョブID（または ‘namespace/scheduled_job_id’） [必須]

オプション:

--name TEXT: Job の名前を指定します。name ラベルとして保存されます。名前の一意性は必須ではありません。デフォルトでは、イメージまたはスクリプトの名前と、解決された起動設定の短いハッシュ値が使用されます。
-l, --label TEXT: ラベルを設定します。例: —label KEY=VALUE または —label LABEL
--clear: スケジュールされたジョブからすべてのラベルを削除します。
--namespace TEXT: ジョブが実行される名前空間です。デフォルトでは、現在のユーザーの名前空間が使用されます。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf jobs scheduled labels <id> —name daily-script $ hf jobs scheduled labels <id> —label env=prod —label team=ml $ hf jobs scheduled labels <id> —clear

hf jobs scheduled list | ls | ps

スケジュールされたJobsのリストを表示します。

--status を使用してステータス（active または suspended）でフィルタリングし、--label を使用して key=value のラベルでフィルタリングできます。スケジュールされた Job は、すべてのフィルタに一致した場合にのみ一覧に表示されます。

使用方法:

$ hf jobs scheduled list | ls | ps [OPTIONS]

オプション:

-a, --all: 予定されているすべての Job を表示します（デフォルトでは停止中の Job は非表示です）。—status と併用することはできません。
--status [active|suspended]: 指定したステータスを持つスケジュール済み Job のみを表示します。カンマ区切りまたは繰り返し指定で、例: --status suspended。
-l, --label TEXT: 指定されたkey=valueラベルを持つスケジュール済みJobのみを表示します。複数のラベルを指定するには、例えば--label env=prod --label team=mlのように繰り返し使用します。
--name TEXT: 指定された名前のスケジュール済みJobのみを表示します（--label name=NAMEのショートカット）。
--namespace TEXT: ジョブが実行される名前空間です。デフォルトでは、現在のユーザーの名前空間が使用されます。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf jobs scheduled ls $ hf jobs scheduled ls -a $ hf jobs scheduled ls —status suspended $ hf jobs scheduled ls —name daily-script $ hf jobs scheduled ls —label env=prod —label team=ml

hf jobs scheduled reschedule

スケジュールされたJobの実行時刻を変更します。

使用方法:

$ hf jobs scheduled reschedule [OPTIONS] SCHEDULED_JOB_ID SCHEDULE

引数:

SCHEDULED_JOB_ID: スケジュールジョブID（または ‘namespace/scheduled_job_id’） [必須]
SCHEDULE: @annually、@yearly、@monthly、@weekly、@daily、@hourly のいずれか、または CRON スケジュール式。[必須]

オプション:

--namespace TEXT: ジョブが実行される名前空間です。デフォルトでは、現在のユーザーの名前空間が使用されます。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf jobs scheduled reschedule <id> “0 9 * * 1”

hf jobs scheduled resume

スケジュールされたJobを再開(一時停止解除)します。

使用方法:

$ hf jobs scheduled resume [OPTIONS] SCHEDULED_JOB_ID

引数:

SCHEDULED_JOB_ID: スケジュールジョブID（または ‘namespace/scheduled_job_id’） [必須]

オプション:

--namespace TEXT: ジョブが実行される名前空間です。デフォルトでは、現在のユーザーの名前空間が使用されます。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf jobs scheduled resume <id>

hf jobs scheduled run

ジョブをスケジュールします。

使用方法:

$ hf jobs scheduled run [OPTIONS] SCHEDULE IMAGE COMMAND...

引数:

SCHEDULE: @annually、@yearly、@monthly、@weekly、@daily、@hourly のいずれか、または CRON スケジュール式。[必須]
IMAGE: 使用する Docker イメージ。[必須]
COMMAND...: 実行するコマンド。[必須]

オプション:

--suspend / --no-suspend: スケジュールされた Job を停止（一時停止）します
--concurrency / --no-concurrency: このJobの複数のインスタンスが並行して実行されることを許可します
-e, --env TEXT: 環境変数を設定します。例: —env ENV=value
-s, --secrets TEXT: シークレット環境変数を設定します。環境から値を読み込むには --secrets SECRET を優先してください（例: Hugging Face トークンを渡すには --secrets HF_TOKEN）。--secrets SECRET=value は値をシェル履歴に記録してしまいます。
--name TEXT: Job の名前を指定します。name ラベルとして保存されます。名前の一意性は必須ではありません。デフォルトでは、イメージまたはスクリプトの名前と、解決された起動設定の短いハッシュ値が使用されます。
-l, --label TEXT: ラベルを設定します。例: —label KEY=VALUE または —label LABEL
-v, --volume TEXT: 1 つ以上のボリュームをマウントします。形式: hf://[TYPE/]SOURCE:/MOUNT_PATH[:ro|:rw] または LOCAL_DIR:/MOUNT_PATH[:ro|:rw]。TYPE は models、datasets、spaces、buckets のいずれかです。TYPE を省略した場合、デフォルトで models になります。models、datasets、spaces は常に読み取り専用でマウントされます。buckets はデフォルトで読み書き可能です。ローカルディレクトリをソースとする場合、まず bucket に同期され、デフォルトでは読み取り専用でマウントされます。例: -v hf://datasets/org/ds:/data または -v hf://buckets/org/b:/mnt:ro または -v ./inputs:/inputs
--env-file TEXT: 環境変数を含むファイルを読み込みます。- を使用すると、stdin から読み込むことができます。
--secrets-file TEXT: シークレット環境変数を含むファイルを読み込みます。- を使用すると、stdin から読み込むことができます。
--flavor [cpu-basic|cpu-upgrade|cpu-performance|cpu-xl|t4-small|t4-medium|l4x1|l4x4|l40sx1|l40sx4|l40sx8|a10g-small|a10g-large|a10g-largex2|a10g-largex4|a100-large|a100x4|a100x8|h200|h200x2|h200x4|h200x8|rtx-pro-6000|rtx-pro-6000x2|rtx-pro-6000x4|rtx-pro-6000x8]: ハードウェアの Flavor を指定します。利用可能な Flavor の一覧を確認するには、‘hf jobs hardware’ を実行してください。デフォルト値は cpu-basic です。
--timeout TEXT: 最大持続時間: s（秒、デフォルト）、m（分）、h（時間）、d（日）付きの int。
--attempts INTEGER RANGE: 最大試行回数（初回実行を含む）。デフォルトは1です。 [x>=1]
--dry-run: Jobを送信せずに、解決されたJobの設定を出力します。
--expose INTEGER: jobs プロキシを介してコンテナのポートを公開します。複数のポートを公開する場合は、フラグを繰り返し指定します（例: --expose 8000 --expose 8001）。公開された各ポートは、パブリックな jobs ドメインからアクセスできます。アクセスには、そのジョブの namespace に対する読み取りアクセス権限を持つ HF トークンが必要です。
--expose-public INTEGER: 認証なしで、ジョブのプロキシを介してコンテナのポートを公開します。複数のポートを公開する場合は、このフラグを繰り返し指定します。--exposeでポートを指定する必要はありません。
--resource-group-id TEXT: ジョブを作成するリソースグループのIDです。組織内のリソースへのアクセス制御や、コストの帰属/支出制限機能に使用されます。
--namespace TEXT: ジョブが実行される名前空間です。デフォルトでは、現在のユーザーの名前空間が使用されます。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--format [agent|auto|human|json|quiet]: 出力形式。デフォルトは ‘auto’ で、ターミナルに基づいて ‘agent’ または ‘human’ を選択します。
--json: JSON出力。「—format json」と同等です。
-q, --quiet: 出力を静かにします（1行に1つのID）。‘—format quiet’ と同等です。
--help: このメッセージを表示して終了します。

例 $ hf jobs scheduled run “0 0 * * *” —name daily-script python:3.12 python script.py

hf jobs scheduled suspend

スケジュールされたJobを停止（一時停止）します。

使用方法:

$ hf jobs scheduled suspend [OPTIONS] SCHEDULED_JOB_ID

引数:

SCHEDULED_JOB_ID: スケジュールジョブID（または ‘namespace/scheduled_job_id’） [必須]

オプション:

--namespace TEXT: ジョブが実行される名前空間です。デフォルトでは、現在のユーザーの名前空間が使用されます。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf jobs scheduled suspend <id>

hf jobs scheduled trigger

スケジュールされたJobを即座に実行します（スケジュールは変更されません）。

使用方法:

$ hf jobs scheduled trigger [OPTIONS] SCHEDULED_JOB_ID

引数:

SCHEDULED_JOB_ID: スケジュールジョブID（または ‘namespace/scheduled_job_id’） [必須]

オプション:

--namespace TEXT: ジョブが実行される名前空間です。デフォルトでは、現在のユーザーの名前空間が使用されます。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf jobs scheduled trigger <id>

hf jobs scheduled uv

HFインフラストラクチャ上でUVスクリプトをスケジュールします。

使用方法:

$ hf jobs scheduled uv [OPTIONS] COMMAND [ARGS]...

オプション:

--help: このメッセージを表示して終了します。

コマンド:

run: HFインフラ上でUVスクリプト（ローカルファイルまたはURL）を実行します

hf jobs scheduled uv run

HFインフラストラクチャ上でUVスクリプト（ローカルファイルまたはURL）を実行する

使用方法:

$ hf jobs scheduled uv run [OPTIONS] SCHEDULE SCRIPT [SCRIPT_ARGS]...

引数:

SCHEDULE: @annually、@yearly、@monthly、@weekly、@daily、@hourly のいずれか、または CRON スケジュール式。[必須]
SCRIPT: 実行する UV スクリプト（ローカルファイルまたは URL） [必須]
[SCRIPT_ARGS]...: スクリプトの引数

オプション:

--suspend / --no-suspend: スケジュールされた Job を停止（一時停止）します
--concurrency / --no-concurrency: このJobの複数のインスタンスが並行して実行されることを許可します
--image TEXT: uvがインストールされたカスタムDockerイメージを使用します。
--flavor [cpu-basic|cpu-upgrade|cpu-performance|cpu-xl|t4-small|t4-medium|l4x1|l4x4|l40sx1|l40sx4|l40sx8|a10g-small|a10g-large|a10g-largex2|a10g-largex4|a100-large|a100x4|a100x8|h200|h200x2|h200x4|h200x8|rtx-pro-6000|rtx-pro-6000x2|rtx-pro-6000x4|rtx-pro-6000x8]: ハードウェアの Flavor を指定します。利用可能な Flavor の一覧を確認するには、‘hf jobs hardware’ を実行してください。デフォルト値は cpu-basic です。
-e, --env TEXT: 環境変数を設定します。例: —env ENV=value
-s, --secrets TEXT: シークレット環境変数を設定します。環境から値を読み込むには --secrets SECRET を優先してください（例: Hugging Face トークンを渡すには --secrets HF_TOKEN）。--secrets SECRET=value は値をシェル履歴に記録してしまいます。
--name TEXT: Job の名前を指定します。name ラベルとして保存されます。名前の一意性は必須ではありません。デフォルトでは、イメージまたはスクリプトの名前と、解決された起動設定の短いハッシュ値が使用されます。
-l, --label TEXT: ラベルを設定します。例: —label KEY=VALUE または —label LABEL
-v, --volume TEXT: 1 つ以上のボリュームをマウントします。形式: hf://[TYPE/]SOURCE:/MOUNT_PATH[:ro|:rw] または LOCAL_DIR:/MOUNT_PATH[:ro|:rw]。TYPE は models、datasets、spaces、buckets のいずれかです。TYPE を省略した場合、デフォルトで models になります。models、datasets、spaces は常に読み取り専用でマウントされます。buckets はデフォルトで読み書き可能です。ローカルディレクトリをソースとする場合、まず bucket に同期され、デフォルトでは読み取り専用でマウントされます。例: -v hf://datasets/org/ds:/data または -v hf://buckets/org/b:/mnt:ro または -v ./inputs:/inputs
--env-file TEXT: 環境変数を含むファイルを読み込みます。- を使用すると、stdin から読み込むことができます。
--secrets-file TEXT: シークレット環境変数を含むファイルを読み込みます。- を使用すると、stdin から読み込むことができます。
--timeout TEXT: 最大持続時間: s（秒、デフォルト）、m（分）、h（時間）、d（日）付きの int。
--attempts INTEGER RANGE: 最大試行回数（初回実行を含む）。デフォルトは1です。 [x>=1]
--dry-run: Jobを送信せずに、解決されたJobの設定を出力します。
--expose INTEGER: jobs プロキシを介してコンテナのポートを公開します。複数のポートを公開する場合は、フラグを繰り返し指定します（例: --expose 8000 --expose 8001）。公開された各ポートは、パブリックな jobs ドメインからアクセスできます。アクセスには、そのジョブの namespace に対する読み取りアクセス権限を持つ HF トークンが必要です。
--expose-public INTEGER: 認証なしで、ジョブのプロキシを介してコンテナのポートを公開します。複数のポートを公開する場合は、このフラグを繰り返し指定します。--exposeでポートを指定する必要はありません。
--resource-group-id TEXT: ジョブを作成するリソースグループのIDです。組織内のリソースへのアクセス制御や、コストの帰属/支出制限機能に使用されます。
--namespace TEXT: ジョブが実行される名前空間です。デフォルトでは、現在のユーザーの名前空間が使用されます。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--with TEXT: 指定したパッケージをインストールして実行します
-p, --python TEXT: 実行環境に使用する Python インタープリター
--format [agent|auto|human|json|quiet]: 出力形式。デフォルトは ‘auto’ で、ターミナルに基づいて ‘agent’ または ‘human’ を選択します。
--json: JSON出力。「—format json」と同等です。
-q, --quiet: 出力を静かにします（1行に1つのID）。‘—format quiet’ と同等です。
--help: このメッセージを表示して終了します。

例 $ hf jobs scheduled uv run “0 0 * * ” —name daily-script script.py $ hf jobs scheduled uv run “0 0 * *” script.py —with pandas

hf jobs ssh

実行中のJobにSSH接続します。

Job がまだ実行されていない場合、RUNNING 状態になるまで待ってから接続します。Job は SSH を有効にして開始されている必要があります（hf jobs run --ssh ...）。また、SSH 公開鍵が https://huggingface.co/settings/keys に登録されている必要があります。

使用方法:

$ hf jobs ssh [OPTIONS] JOB_ID

引数:

JOB_ID: ジョブ ID（または ‘namespace/job_id’） [必須]

オプション:

-i, --identity-file PATH: SSH 認証ファイルへのパス（ssh -i に転送されます）。
--dry-run: 実行する代わりに、SSH コマンドを出力します。
--namespace TEXT: ジョブが実行される名前空間です。デフォルトでは、現在のユーザーの名前空間が使用されます。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf jobs ssh <job_id> $ hf jobs ssh <job_id> —dry-run $ hf jobs ssh <job_id> -i ~/.ssh/id_ed25519

hf jobs stats

Jobsのリソース使用状況の統計情報とメトリクスを取得します。

デフォルトでは、現在の統計のスナップショットを表示して終了します（非ブロッキング）。 —follow/-f を使用すると、Jobs が完了するまでライブ統計を表示します。

使用方法:

$ hf jobs stats [OPTIONS] [JOB_IDS]...

引数:

[JOB_IDS]...: Job ID（または ‘namespace/job_id’）

オプション:

-f, --follow: 統計情報の出力をフォローします（Jobsが完了するまでのライブビュー）。このフラグを指定しない場合、スナップショットが1回だけ出力されます。
--namespace TEXT: ジョブが実行される名前空間です。デフォルトでは、現在のユーザーの名前空間が使用されます。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf jobs stats $ hf jobs stats <job_id> $ hf jobs stats -f <job_id>

hf jobs uv

HFインフラストラクチャ上でUVスクリプト（インライン依存関係付きのPython）を実行します。

使用方法:

$ hf jobs uv [OPTIONS] COMMAND [ARGS]...

オプション:

--help: このメッセージを表示して終了します。

コマンド:

run: HFインフラ上でUVスクリプト（ローカルファイルまたはURL）を実行します

hf jobs uv run

HFインフラストラクチャ上でUVスクリプト（ローカルファイルまたはURL）を実行する

使用方法:

$ hf jobs uv run [OPTIONS] SCRIPT [SCRIPT_ARGS]...

引数:

SCRIPT: 実行する UV スクリプト（ローカルファイルまたは URL） [必須]
[SCRIPT_ARGS]...: スクリプトの引数

オプション:

--image TEXT: uvがインストールされたカスタムDockerイメージを使用します。
--flavor [cpu-basic|cpu-upgrade|cpu-performance|cpu-xl|t4-small|t4-medium|l4x1|l4x4|l40sx1|l40sx4|l40sx8|a10g-small|a10g-large|a10g-largex2|a10g-largex4|a100-large|a100x4|a100x8|h200|h200x2|h200x4|h200x8|rtx-pro-6000|rtx-pro-6000x2|rtx-pro-6000x4|rtx-pro-6000x8]: ハードウェアの Flavor を指定します。利用可能な Flavor の一覧を確認するには、‘hf jobs hardware’ を実行してください。デフォルト値は cpu-basic です。
-e, --env TEXT: 環境変数を設定します。例: —env ENV=value
-s, --secrets TEXT: シークレット環境変数を設定します。環境から値を読み込むには --secrets SECRET を優先してください（例: Hugging Face トークンを渡すには --secrets HF_TOKEN）。--secrets SECRET=value は値をシェル履歴に記録してしまいます。
--name TEXT: Job の名前を指定します。name ラベルとして保存されます。名前の一意性は必須ではありません。デフォルトでは、イメージまたはスクリプトの名前と、解決された起動設定の短いハッシュ値が使用されます。
-l, --label TEXT: ラベルを設定します。例: —label KEY=VALUE または —label LABEL
-v, --volume TEXT: 1 つ以上のボリュームをマウントします。形式: hf://[TYPE/]SOURCE:/MOUNT_PATH[:ro|:rw] または LOCAL_DIR:/MOUNT_PATH[:ro|:rw]。TYPE は models、datasets、spaces、buckets のいずれかです。TYPE を省略した場合、デフォルトで models になります。models、datasets、spaces は常に読み取り専用でマウントされます。buckets はデフォルトで読み書き可能です。ローカルディレクトリをソースとする場合、まず bucket に同期され、デフォルトでは読み取り専用でマウントされます。例: -v hf://datasets/org/ds:/data または -v hf://buckets/org/b:/mnt:ro または -v ./inputs:/inputs
--env-file TEXT: 環境変数を含むファイルを読み込みます。- を使用すると、stdin から読み込むことができます。
--secrets-file TEXT: シークレット環境変数を含むファイルを読み込みます。- を使用すると、stdin から読み込むことができます。
--timeout TEXT: 最大持続時間: s（秒、デフォルト）、m（分）、h（時間）、d（日）付きの int。
--attempts INTEGER RANGE: 最大試行回数（初回実行を含む）。デフォルトは1です。 [x>=1]
-d, --detach: Job をバックグラウンドで実行し、Job ID を出力します。
--dry-run: Jobを送信せずに、解決されたJobの設定を出力します。
--expose INTEGER: jobs プロキシを介してコンテナのポートを公開します。複数のポートを公開する場合は、フラグを繰り返し指定します（例: --expose 8000 --expose 8001）。公開された各ポートは、パブリックな jobs ドメインからアクセスできます。アクセスには、そのジョブの namespace に対する読み取りアクセス権限を持つ HF トークンが必要です。
--expose-public INTEGER: 認証なしで、ジョブのプロキシを介してコンテナのポートを公開します。複数のポートを公開する場合は、このフラグを繰り返し指定します。--exposeでポートを指定する必要はありません。
--ssh: ジョブのコンテナを SSH 経由で接続可能にします。hf jobs ssh <job_id> を使用して接続します。https://huggingface.co/settings/keys に SSH 公開鍵を登録している必要があります。
--network-group TEXT: ネットワークグループに参加します。同じ namespace と resource group を共有し、同じグループに属するジョブは一緒に配置され、すべてのポートで相互に到達できます。各メンバー内で、$HF_NETWORK_GROUP_HOSTNAME はすべてのメンバーに解決されます。小文字の英数字とダッシュのみ使用可能で、最大 46 文字です。
--network-alias TEXT: ネットワークグループ内でエイリアスを確保します。メンバーは、${HF_NETWORK_GROUP_PREFIX}<alias> を介して、このエイリアスを確保したジョブにアクセスできます。複数のエイリアスを指定するには、このフラグを繰り返し使用します。小文字の英数字とダッシュのみ使用でき、最大34文字、ジョブ内で一意である必要があります。--network-group の指定が必要です。
--resource-group-id TEXT: ジョブを作成するリソースグループのIDです。組織内のリソースへのアクセス制御や、コストの帰属/支出制限機能に使用されます。
--namespace TEXT: ジョブが実行される名前空間です。デフォルトでは、現在のユーザーの名前空間が使用されます。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--with TEXT: 指定したパッケージをインストールして実行します
-p, --python TEXT: 実行環境に使用する Python インタープリター
--format [agent|auto|human|json|quiet]: 出力形式。デフォルトは ‘auto’ で、ターミナルに基づいて ‘agent’ または ‘human’ を選択します。
--json: JSON出力。「—format json」と同等です。
-q, --quiet: 出力を静かにします（1行に1つのID）。‘—format quiet’ と同等です。
--help: このメッセージを表示して終了します。

例 $ hf jobs uv run —name my-script my_script.py $ hf jobs uv run —detach my_script.py $ hf jobs uv run —flavor a10g-small ml_training.py $ hf jobs uv run —with transformers train.py $ hf jobs uv run -v hf://org/my-model:/data -v hf://buckets/org/b:/mnt script.py $ hf jobs uv run —dry-run script.py

hf jobs wait

1つ以上のJobが終端状態に達するまで待機します。

すべての Job が完了するまでブロックし、すべての Job が正常に完了した場合は終了コード 0 で終了します。一方、いずれかの Job がキャンセル、エラー、削除された場合は、ゼロ以外の終了コードで終了します。

すべての Jobs は同じ namespace に属していなければなりません。

使用方法:

$ hf jobs wait [OPTIONS] JOB_IDS...

引数:

JOB_IDS...: 待機するジョブの ID（または ‘namespace/job_id’）。[必須]

オプション:

--timeout TEXT: 最大待機時間: s（秒、デフォルト）、m（分）、h（時間）、d（日）付きの int。
--namespace TEXT: ジョブが実行される名前空間です。デフォルトでは、現在のユーザーの名前空間が使用されます。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf jobs wait <job_id> $ hf jobs wait <job_id_1> <job_id_2> $ hf jobs ls -q | xargs hf jobs wait

hf lfs-enable-largefiles

リポジトリを設定して、5GBを超えるファイルのアップロードを有効にしてください。

このコマンドは、git-lfsがカスタムのマルチパート転送エージェントを使用するように設定します。これにより、大規模なファイルをチャンク単位で効率的にアップロードできるようになります。

使用方法:

$ hf lfs-enable-largefiles [OPTIONS] PATH

引数:

PATH: 設定するリポジトリのローカルパス。 [必須]

オプション:

--help: このメッセージを表示して終了します。

hf lfs-multipart-upload

マルチパートアップロード用の内部git-lfsカスタム転送エージェント。

この関数は、git-lfsのマルチパートアップロード用のカスタム転送プロトコルを実装します。 Hugging Face Hubへの大規模ファイルのチャンク分割アップロードを処理します。

使用方法:

$ hf lfs-multipart-upload [OPTIONS]

オプション:

--help: このメッセージを表示して終了します。

hf models

Hub上のモデルと対話します。

使用方法:

$ hf models [OPTIONS] COMMAND [ARGS]...

オプション:

--help: このメッセージを表示して終了します。

コマンド:

card: Hub上のモデルのモデルカード（README）を取得します。
info: Hub上のモデルに関する情報を取得します。
list: Hub上のモデル、またはモデルリポジトリ内のファイルをリスト表示します。[別名: ls]

hf models card

Hub上のモデルのモデルカード（README）を取得します。

使用方法:

$ hf models card [OPTIONS] MODEL_ID

引数:

MODEL_ID: モデルのID（例: username/repo-name）。[必須]

オプション:

--metadata: カードのメタデータのみを出力します。
--text: メタデータなしでテキスト本文のみを出力します。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf models card google/gemma-4-31B-it $ hf models card google/gemma-4-31B-it —metadata $ hf models card google/gemma-4-31B-it —metadata —format json $ hf models card google/gemma-4-31B-it —text

hf models info

Hub上のモデルに関する情報を取得します。

使用方法:

$ hf models info [OPTIONS] MODEL_ID

引数:

MODEL_ID: モデルのID（例: username/repo-name）。[必須]

オプション:

--revision TEXT: GitのリビジョンID。ブランチ名、タグ、またはコミットハッシュを指定できます。
--expand TEXT: 返すプロパティをカンマ区切りで指定します。使用すると、リストされたプロパティ（および id）のみが返されます。例: ‘—expand=downloads,likes,tags’。有効な値: author, baseModels, cardData, childrenModelCount, config, createdAt, disabled, downloads, downloadsAllTime, evalResults, gated, gguf, inference, inferenceProviderMapping, lastModified, library_name, likes, mask_token, model-index, pipeline_tag, private, resourceGroup, safetensors, sha, siblings, spaces, tags, transformersInfo, trendingScore, usedStorage, widgetData。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf models info meta-llama/Llama-3.2-1B-Instruct $ hf models info Qwen/Qwen3.5-9B —expand downloads,likes,tags

hf models list

Hub上のモデル、またはモデルリポジトリ内のファイルをリスト表示します。[alias: ls]

引数なしで呼び出された場合、Hub上のモデルをリスト表示します。モデルIDを引数として呼び出された場合、そのモデルリポジトリ内のファイルをリスト表示します。

使用方法:

$ hf models list [OPTIONS] [REPO_ID]

引数:

[REPO_ID]: ファイルの一覧を取得するモデル ID（例: username/repo-name）。省略した場合、モデルの一覧を取得します。

オプション:

--search TEXT: 検索クエリ。
--author TEXT: 作成者または組織でフィルタリングします。
--filter TEXT: タグでフィルタリングします（例: ‘text-classification’）。複数回使用できます。
--pipeline-tag TEXT: パイプラインタグ（正規化タスク）でフィルタリングします。例: ‘summarization’。
--gated / --no-gated: ゲーティング状態によってフィルタリングします。‘—gated’はゲーティング対象のみ、‘—no-gated’はゲーティング対象外のみを表示します。
--apps TEXT: モデルを実行できるアプリでフィルタリングします。例: ‘ollama’ または ‘vllm’。
--num-parameters TEXT: パラメータ数でフィルタリングします。例: ‘min:6B,max:128B’。
--inference-provider [baseten|cerebras|cohere|deepinfra|fal-ai|featherless-ai|fireworks-ai|groq|hf-inference|novita|nscale|openai|ovhcloud|publicai|replicate|scaleway|together|wavespeed|zai-org]: モデルを提供している推論プロバイダーでフィルタリングします。例: ‘fireworks-ai’。
--warm: 少なくとも1つの推論プロバイダーによって現在提供されているモデルのみをリスト表示します。
--sort [created_at|downloads|last_modified|likes|trending_score]: 結果をソートします。
--limit INTEGER: 結果の件数を制限します。 [デフォルト: 30]
--expand TEXT: 返すプロパティをカンマ区切りで指定します。使用すると、リストされたプロパティ（および id）のみが返されます。例: ‘—expand=downloads,likes,tags’。有効な値: author, baseModels, cardData, childrenModelCount, config, createdAt, disabled, downloads, downloadsAllTime, evalResults, gated, gguf, inference, inferenceProviderMapping, lastModified, library_name, likes, mask_token, model-index, pipeline_tag, private, resourceGroup, safetensors, sha, siblings, spaces, tags, transformersInfo, trendingScore, usedStorage, widgetData。
-h, --human-readable: サイズを人間が読みやすい形式で表示します（ファイルの一覧表示時のみ）。
--tree: ファイルをツリー形式で一覧表示します（ファイルの一覧表示時のみ）。
-R, --recursive: ファイルを再帰的に一覧表示します（ファイルの一覧表示のみ）。
--revision TEXT: GitのリビジョンID。ブランチ名、タグ、またはコミットハッシュを指定できます。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf models ls —sort downloads —limit 10 $ hf models ls —search “llama” —author meta-llama $ hf models ls —pipeline-tag text-generation —warm $ hf models ls —num-parameters min:6B,max:128B —sort likes $ hf models ls —no-gated —author google $ hf models ls —apps llama.cpp —apps vllm $ hf models ls —inference-provider fireworks-ai —sort downloads $ hf models ls —warm —search llama $ hf models ls meta-llama/Llama-3.2-1B-Instruct $ hf models ls meta-llama/Llama-3.2-1B-Instruct -R $ hf models ls meta-llama/Llama-3.2-1B-Instruct —tree -h

hf papers

Hub上の論文と対話します。

使用方法:

$ hf papers [OPTIONS] COMMAND [ARGS]...

オプション:

--help: このメッセージを表示して終了します。

コマンド:

info: Hub上の論文に関する情報を取得します。
list: Hub上の日次ペーパーをリスト表示します。[別名: ls]
read: Markdown形式で論文を読み込みます。
search: Hub上の論文を検索します。

hf papers info

Hub上の論文に関する情報を取得します。

使用方法:

$ hf papers info [OPTIONS] PAPER_ID

引数:

PAPER_ID: arXiv の論文 ID（例: ‘2502.08025’）。[必須]

オプション:

--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf papers info 2601.15621

hf papers list

Hub上の日次ペーパーをリスト表示します。[alias: ls]

使用方法:

$ hf papers list [OPTIONS]

オプション:

--date TEXT: ISO形式（YYYY-MM-DD）の日付または‘today’。
--week TEXT: 絞り込みに使用する ISO 週。例: ‘2025-W09’。
--month TEXT: ISO形式（YYYY-MM）で指定する月。例：‘2025-02’。
--submitter TEXT: サブミッターのユーザー名でフィルタリングします。
--sort [publishedAt|trending]: 結果をソートします。
--limit INTEGER: 結果の件数を制限します。 [デフォルト: 50]
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf papers ls $ hf papers ls —sort trending $ hf papers ls —date 2025-01-23 $ hf papers ls —week 2025-W09 $ hf papers ls —submitter akhaliq $ hf papers ls —format json

hf papers read

論文をMarkdownとして読み取ります。

使用方法:

$ hf papers read [OPTIONS] PAPER_ID

引数:

PAPER_ID: arXiv の論文 ID（例: ‘2502.08025’）。[必須]

オプション:

--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf papers read 2601.15621

hf papers search

Hubで論文を検索します。

使用方法:

$ hf papers search [OPTIONS] QUERY

引数:

QUERY: 検索クエリ文字列。 [必須]

オプション:

--limit INTEGER: 結果の件数を制限します。 [デフォルト: 20]
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf papers search “vision language” $ hf papers search “attention mechanism” —limit 10 $ hf papers search “diffusion” —format json

hf リポジトリ

Hub上のリポジトリを管理します。

使用方法:

$ hf repos [OPTIONS] COMMAND [ARGS]...

オプション:

--help: このメッセージを表示して終了します。

コマンド:

branch: Hub上のリポジトリのブランチを管理します。
cp: ローカルパス、リポジトリ、バケット間でファイルをコピーします。
create: Hub に新しいリポジトリを作成します。
delete: Hubからリポジトリを削除します。
delete-files: Hub上のリポジトリからファイルを削除します。
duplicate: Hub上のリポジトリ（モデル、データセット、またはSpace）を複製します。
list: ストレージ情報付きで、すべてのリポジトリ（モデル、データセット、スペース、バケット）をリスト表示します。[別名: ls]
move: リポジトリを別の名前空間に移動します。
settings: リポジトリの設定を更新します。
tag: Hub上のリポジトリのタグを管理します。

hf repos branch

Hub上のリポジトリのブランチを管理します。

使用方法:

$ hf repos branch [OPTIONS] COMMAND [ARGS]...

オプション:

--help: このメッセージを表示して終了します。

コマンド:

create: Hub上のリポジトリに新しいブランチを作成します。
delete: Hub上のリポジトリからブランチを削除します。

hf repos branch create

Hub上のリポジトリに新しいブランチを作成します。

使用方法:

$ hf repos branch create [OPTIONS] REPO_ID BRANCH

引数:

REPO_ID: リポジトリの ID（例: username/repo-name または spaces/username/repo-name）。[必須]
BRANCH: 作成するブランチの名前。[必須]

オプション:

--revision TEXT: GitのリビジョンID。ブランチ名、タグ、またはコミットハッシュを指定できます。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--type, --repo-type [model|dataset|space|kernel]: リポジトリの種類（model、dataset、space、kernel）。[デフォルト: model]
--exist-ok / --no-exist-ok: True に設定すると、ブランチが既に存在していてもエラーを発生させません。 [デフォルト: no-exist-ok]
--help: このメッセージを表示して終了します。

例 $ hf repos branch create my-model dev $ hf repos branch create my-model dev —revision abc123

hf repos branch delete

Hub上のリポジトリからブランチを削除します。

使用方法:

$ hf repos branch delete [OPTIONS] REPO_ID BRANCH

引数:

REPO_ID: リポジトリの ID（例: username/repo-name または spaces/username/repo-name）。[必須]
BRANCH: 削除するブランチの名前。 [必須]

オプション:

--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--type, --repo-type [model|dataset|space|kernel]: リポジトリの種類（model、dataset、space、kernel）。[デフォルト: model]
--help: このメッセージを表示して終了します。

例 $ hf repos branch delete my-model dev

hf repos cp

ローカルパス、リポジトリ、バケット間でファイルをコピーします。

使用方法:

$ hf repos cp [OPTIONS] SRC [DST]

引数:

SRC: ソース: ローカルファイル、hf:// URI（リポジトリまたはバケット）、または stdin を示す -。[必須]
[DST]: 保存先: ローカルパス、hf:// URI (リポジトリまたはバケット)、または標準出力用の -。

オプション:

--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf repos cp hf://username/my-model/config.json config.json $ hf repos cp hf://datasets/username/my-dataset/data.csv data/ $ hf repos cp hf://username/my-model/config.json - $ hf repos cp model.safetensors hf://username/my-model/model.safetensors $ hf repos cp config.json hf://username/my-model/logs/ $ hf repos cp - hf://username/my-model/config.json $ hf repos cp hf://username/source-model/config.json hf://username/dest-model/config.json $ hf repos cp hf://datasets/username/my-dataset/processed/ hf://datasets/username/dest-dataset/processed/ $ hf repos cp hf://username/my-model/logs/ hf://username/archive-model/logs/

hf repos create

Hub に新しいリポジトリを作成します。

使用方法:

$ hf repos create [OPTIONS] REPO_ID

引数:

REPO_ID: リポジトリの ID（例: username/repo-name または spaces/username/repo-name）。[必須]

オプション:

--type, --repo-type [model|dataset|space|kernel]: リポジトリの種類（model、dataset、space、kernel）。[デフォルト: model]
--sdk, --space-sdk TEXT: Hugging Face Spaces SDK の種類です。—type が ‘space’ に設定されている場合は必須です。
--template TEXT: 公式テンプレートからSpaceを作成します。テンプレートのリポジトリID（例: ‘SpacesExamples/jupyterlab’）またはその短縮名（例: ‘JupyterLab’）を渡します。利用可能なテンプレートのリストはhf spaces templatesで表示できます。Spaces専用です。
--private / --no-private: Hub にリポジトリが存在しない場合に、プライベートリポジトリを作成するかどうか。リポジトリが既に存在する場合は無視されます。
--public: リポジトリを公開にするかどうか。リポジトリが既に存在する場合、無視されます。
--protected: Space を保護するかどうか（Spaces のみ）。リポジトリが既に存在する場合は無視されます。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--exist-ok / --no-exist-ok: リポジトリが既に存在する場合でもエラーを発生させません。 [デフォルト: no-exist-ok]
--resource-group-id TEXT: リポジトリを作成するリソースグループ。リソースグループは、Enterprise Hub の組織でのみ利用可能です。
--region [us|eu]: リポジトリを作成するクラウドリージョン。‘us’ または ‘eu’ のいずれかです。Team プラン以上が必要です。
--flavor [cpu-basic|cpu-upgrade|zero-a10g|t4-small|t4-medium|l4x1|l4x4|l40sx1|l40sx4|l40sx8|a10g-small|a10g-large|a10g-largex2|a10g-largex4|a100-large|a100x4|a100x8|rtx-pro-6000|rtx-pro-6000x2|rtx-pro-6000x4|rtx-pro-6000x8]: Spaceのハードウェアフレーバー（例: ‘cpu-basic’、‘t4-medium’、‘l4x4’）。Spaces専用です。
--sleep-time INTEGER: Spaceがスリープ状態に入るまでの無操作の秒数。-1 を使用すると無効になります。Spaces のみ対象です。
-s, --secrets TEXT: シークレット環境変数を設定します。環境から値を読み込むには --secrets SECRET を優先してください（例: Hugging Face トークンを渡すには --secrets HF_TOKEN）。--secrets SECRET=value は値をシェル履歴に記録してしまいます。
--secrets-file TEXT: シークレット環境変数を含むファイルを読み込みます。- を使用すると、stdin から読み込むことができます。
-e, --env TEXT: 環境変数を設定します。例: —env ENV=value
--env-file TEXT: 環境変数を含むファイルを読み込みます。- を使用すると、stdin から読み込むことができます。
-v, --volume TEXT: 1 つ以上のボリュームをマウントします。形式: hf://[TYPE/]SOURCE:/MOUNT_PATH[:ro]。TYPE は models、datasets、spaces、buckets のいずれかです。TYPE を省略した場合、デフォルトで models になります。models、datasets、spaces は常に読み取り専用でマウントされます。buckets はデフォルトで読み書き可能です。例: -v hf://org/m:/data または -v hf://datasets/org/ds:/data または -v hf://buckets/org/b:/mnt:ro
--help: このメッセージを表示して終了します。

例 $ hf repos create my-model $ hf repos create my-dataset —repo-type dataset —private $ hf repos create my-space —type space —sdk gradio —flavor t4-medium —secrets HF_TOKEN -e THEME=dark —protected $ hf repos create my-jupyterlab —type space —template SpacesExamples/jupyterlab $ hf repos create my-space —type space —sdk gradio -v hf://org/my-model:/models -v hf://buckets/org/b:/data $ hf repos create my-model —region us

hf repos delete

Hubからリポジトリを削除します。この操作は元に戻せません。

使用方法:

$ hf repos delete [OPTIONS] REPO_ID

引数:

REPO_ID: リポジトリの ID（例: username/repo-name または spaces/username/repo-name）。[必須]

オプション:

--type, --repo-type [model|dataset|space|kernel]: リポジトリの種類（model、dataset、space、kernel）。[デフォルト: model]
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--missing-ok / --no-missing-ok: True に設定すると、リポジトリが存在しない場合でもエラーを発生させません。 [デフォルト: no-missing-ok]
-y, --yes: プロンプトに対して自動的に Yes と応答します。
--help: このメッセージを表示して終了します。

例 $ hf repos delete my-model

hf repos delete-files

Hub上のリポジトリからファイルを削除します。

使用方法:

$ hf repos delete-files [OPTIONS] REPO_ID PATTERNS...

引数:

REPO_ID: リポジトリの ID（例: username/repo-name または spaces/username/repo-name）。[必須]
PATTERNS...: 削除するファイルに一致させるための Glob パターン。fnmatch に基づいており、’*’ は再帰的にファイルに一致します。 [必須]

オプション:

--type, --repo-type [model|dataset|space|kernel]: リポジトリの種類（model、dataset、space、kernel）。[デフォルト: model]
--revision TEXT: GitのリビジョンID。ブランチ名、タグ、またはコミットハッシュを指定できます。
--commit-message TEXT: 生成されるコミットのサマリー / タイトル / 最初の行。
--commit-description TEXT: 生成されるコミットの説明。
--create-pr / --no-create-pr: これらの変更に対して新しい Pull Request を作成するかどうか。 [デフォルト: no-create-pr]
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf repos delete-files my-model file.txt $ hf repos delete-files my-model “*.json” $ hf repos delete-files my-model folder/

hf repos duplicate

Hub上のリポジトリ（モデル、データセット、またはSpace）を複製します。

使用方法:

$ hf repos duplicate [OPTIONS] FROM_ID [TO_ID]

引数:

FROM_ID: リポジトリの ID（例: username/repo-name または spaces/username/repo-name）。[必須]
[TO_ID]: 宛先のリポジトリID（例: myorg/my-copy）。デフォルトでは、同じリポジトリ名であなたの名前空間が使用されます。

オプション:

--type, --repo-type [model|dataset|space|kernel]: リポジトリの種類（model、dataset、space、kernel）。[デフォルト: model]
--private / --no-private: Hub にリポジトリが存在しない場合に、プライベートリポジトリを作成するかどうか。リポジトリが既に存在する場合は無視されます。
--public: リポジトリを公開にするかどうか。リポジトリが既に存在する場合、無視されます。
--protected: Space を保護するかどうか（Spaces のみ）。リポジトリが既に存在する場合は無視されます。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--exist-ok / --no-exist-ok: リポジトリが既に存在する場合でもエラーを発生させません。 [デフォルト: no-exist-ok]
--resource-group-id TEXT: 新しいリポジトリを作成するリソースグループ。リソースグループは、Enterprise Hub の組織でのみ利用可能です。
--flavor [cpu-basic|cpu-upgrade|zero-a10g|t4-small|t4-medium|l4x1|l4x4|l40sx1|l40sx4|l40sx8|a10g-small|a10g-large|a10g-largex2|a10g-largex4|a100-large|a100x4|a100x8|rtx-pro-6000|rtx-pro-6000x2|rtx-pro-6000x4|rtx-pro-6000x8]: Spaceのハードウェアフレーバー（例: ‘cpu-basic’、‘t4-medium’、‘l4x4’）。Spaces専用です。
--sleep-time INTEGER: Spaceがスリープ状態に入るまでの無操作の秒数。-1 を使用すると無効になります。Spaces のみ対象です。
-s, --secrets TEXT: シークレット環境変数を設定します。環境から値を読み込むには --secrets SECRET を優先してください（例: Hugging Face トークンを渡すには --secrets HF_TOKEN）。--secrets SECRET=value は値をシェル履歴に記録してしまいます。
--secrets-file TEXT: シークレット環境変数を含むファイルを読み込みます。- を使用すると、stdin から読み込むことができます。
-e, --env TEXT: 環境変数を設定します。例: —env ENV=value
--env-file TEXT: 環境変数を含むファイルを読み込みます。- を使用すると、stdin から読み込むことができます。
-v, --volume TEXT: 1 つ以上のボリュームをマウントします。形式: hf://[TYPE/]SOURCE:/MOUNT_PATH[:ro]。TYPE は models、datasets、spaces、buckets のいずれかです。TYPE を省略した場合、デフォルトで models になります。models、datasets、spaces は常に読み取り専用でマウントされます。buckets はデフォルトで読み書き可能です。例: -v hf://org/m:/data または -v hf://datasets/org/ds:/data または -v hf://buckets/org/b:/mnt:ro
--help: このメッセージを表示して終了します。

例 $ hf repos duplicate openai/gdpval —type dataset $ hf repos duplicate multimodalart/dreambooth-training my-dreambooth —type space —flavor l4x4 —secrets HF_TOKEN —private $ hf repos duplicate org/my-space my-space —type space -v hf://org/my-model:/models -v hf://buckets/org/b:/data

hf repos list

ストレージ情報付きで、すべてのリポジトリ（モデル、データセット、スペース、バケット）をリスト表示します。[エイリアス: ls]

使用方法:

$ hf repos list [OPTIONS]

オプション:

--namespace TEXT: 組織名。指定しない場合、認証済みユーザーのリポジトリをリスト表示します。
--type, --repo-type [model|dataset|space|bucket]: リポジトリの種類（model、dataset、space、または bucket）でフィルタリングします。
--search TEXT: 検索クエリ。
--limit INTEGER: 結果の件数を制限します。 [デフォルト: 30]
--explore: リポジトリをインタラクティブな3Dシティとして探索します。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf repos ls $ hf repos ls —explore $ hf repos ls —namespace my-org —search bert

hf repos move

リポジトリを1つの名前空間から別の名前空間に移動します。

使用方法:

$ hf repos move [OPTIONS] FROM_ID TO_ID

引数:

FROM_ID: リポジトリの ID（例: username/repo-name または spaces/username/repo-name）。[必須]
TO_ID: リポジトリの ID（例: username/repo-name または spaces/username/repo-name）。[必須]

オプション:

--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--type, --repo-type [model|dataset|space|kernel]: リポジトリの種類（model、dataset、space、kernel）。[デフォルト: model]
--help: このメッセージを表示して終了します。

例 $ hf repos move old-namespace/my-model new-namespace/my-model

hf repos settings

リポジトリの設定を更新します。

使用方法:

$ hf repos settings [OPTIONS] REPO_ID

引数:

REPO_ID: リポジトリの ID（例: username/repo-name または spaces/username/repo-name）。[必須]

オプション:

--gated [auto|manual|false]: リポジトリのゲート状態。
--private / --no-private: Hub にリポジトリが存在しない場合に、プライベートリポジトリを作成するかどうか。リポジトリが既に存在する場合は無視されます。
--public: リポジトリを公開にするかどうか。リポジトリが既に存在する場合、無視されます。
--protected: Space を保護するかどうか（Spaces のみ）。リポジトリが既に存在する場合は無視されます。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--type, --repo-type [model|dataset|space|kernel]: リポジトリの種類（model、dataset、space、kernel）。[デフォルト: model]
--help: このメッセージを表示して終了します。

例 $ hf repos settings my-model —private $ hf repos settings my-model —gated auto $ hf repos settings my-space —repo-type space —protected

hf repos tag

Hub上のリポジトリのタグを管理します。

使用方法:

$ hf repos tag [OPTIONS] COMMAND [ARGS]...

オプション:

--help: このメッセージを表示して終了します。

コマンド:

create: リポジトリにタグを作成します。
delete: リポジトリのタグを削除します。
list: リポジトリのタグをリスト表示します。[別名: ls]

hf repos tag create

リポジトリにタグを作成します。

使用方法:

$ hf repos tag create [OPTIONS] REPO_ID TAG

引数:

REPO_ID: リポジトリの ID（例: username/repo-name または spaces/username/repo-name）。[必須]
TAG: 作成するタグの名前。 [必須]

オプション:

-m, --message TEXT: 作成するタグの説明。
--revision TEXT: GitのリビジョンID。ブランチ名、タグ、またはコミットハッシュを指定できます。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--type, --repo-type [model|dataset|space|kernel]: リポジトリの種類（model、dataset、space、kernel）。[デフォルト: model]
--help: このメッセージを表示して終了します。

例 $ hf repos tag create my-model v1.0 $ hf repos tag create my-model v1.0 -m “First release”

hf repos tag delete

リポジトリのタグを削除します。

使用方法:

$ hf repos tag delete [OPTIONS] REPO_ID TAG

引数:

REPO_ID: リポジトリの ID（例: username/repo-name または spaces/username/repo-name）。[必須]
TAG: 削除するタグの名前。 [必須]

オプション:

-y, --yes: プロンプトに対して自動的に Yes と応答します
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--type, --repo-type [model|dataset|space|kernel]: リポジトリの種類（model、dataset、space、kernel）。[デフォルト: model]
--help: このメッセージを表示して終了します。

例 $ hf repos tag delete my-model v1.0

hf repos tag list

リポジトリのタグをリスト表示します。[エイリアス: ls]

使用方法:

$ hf repos tag list [OPTIONS] REPO_ID

引数:

REPO_ID: リポジトリの ID（例: username/repo-name または spaces/username/repo-name）。[必須]

オプション:

--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--type, --repo-type [model|dataset|space|kernel]: リポジトリの種類（model、dataset、space、kernel）。[デフォルト: model]
--help: このメッセージを表示して終了します。

例 $ hf repos tag list my-model

hf sandbox

Hugging Face Jobs上で実験用サンドボックスを実行・管理します。

使用方法:

$ hf sandbox [OPTIONS] COMMAND [ARGS]...

オプション:

--help: このメッセージを表示して終了します。

コマンド:

cp: ローカルマシンとサンドボックス（dockerスタイル）間でファイルをコピーします。
create: サンドボックスを作成します。デフォルトでは専用の VM が使用されますが、--pool を指定すると低コストの共有 VM が使用されます。
exec: サンドボックス内でコマンドを実行し、出力をストリーミングします。
kill: サンドボックス、共有ホスト全体、またはすべて（—all）を終了します。
pool: ホストVMプールをウォーム状態に保ち、同じ信頼境界内のワークロード用に実験的な共有サンドボックスを生成します。
process: サンドボックス内で実行されているバックグラウンドプロセスを一覧表示して停止します。
spawn: 長時間実行されるコマンドをバックグラウンドで開始し、その pid を返します（待機しません）。

hf sandbox cp

ローカルマシンとサンドボックス（dockerスタイル）の間にファイルをコピーします。

使用方法:

$ hf sandbox cp [OPTIONS] SRC DST

引数:

SRC: ソース: ローカルパスまたは<sandbox_id>:<path>。 [必須]
DST: 転送先: ローカルパスまたは<sandbox_id>:<path>。 [必須]

オプション:

--namespace TEXT: ジョブが実行される名前空間です。デフォルトでは、現在のユーザーの名前空間が使用されます。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf sandbox cp data.csv <sandbox_id>:/data/data.csv $ hf sandbox cp <sandbox_id>:/app/result.json result.json

hf sandbox create

サンドボックスを作成します。デフォルトでは専用のVMが使用されますが、--pool を使用すると低コストの共有VMを使用できます。

Env と idle-timeout は、両方のモードでサンドボックスに適用されます。--pool を使用する場合、イメージとフレーバーはプールから取得されるため、ここでそれらを指定するとエラーになります。--secrets も拒否されます。プールのサンドボックスには暗号化シークレットのチャネルがないためです（--env を使用してください）。まず hf sandbox pool create でプールを定義してください。

使用方法:

$ hf sandbox create [OPTIONS] [IMAGE]

引数:

[IMAGE]: Dockerイメージ（/bin/shが必要です）。

オプション:

--pool TEXT: このプール（hf sandbox pool createで作成したもの）から、低コストの共有サンドボックスを生成します。
--flavor [cpu-basic|cpu-upgrade|cpu-performance|cpu-xl|t4-small|t4-medium|l4x1|l4x4|l40sx1|l40sx4|l40sx8|a10g-small|a10g-large|a10g-largex2|a10g-largex4|a100-large|a100x4|a100x8|h200|h200x2|h200x4|h200x8|rtx-pro-6000|rtx-pro-6000x2|rtx-pro-6000x4|rtx-pro-6000x8]: ハードウェアの Flavor を指定します。利用可能な Flavor の一覧を確認するには、‘hf jobs hardware’ を実行してください。デフォルト値は cpu-basic です。
--idle-timeout TEXT: この時間だけ非アクティブな状態が続くと、サンドボックスを自動的に終了します（例: ‘10m’）。デフォルトは 10m です。
-e, --env TEXT: 環境変数を設定します。例: —env ENV=value
-s, --secrets TEXT: シークレット環境変数を設定します。環境から値を読み込むには --secrets SECRET を優先してください（例: Hugging Face トークンを渡すには --secrets HF_TOKEN）。--secrets SECRET=value は値をシェル履歴に記録してしまいます。
-l, --label TEXT: ラベルを設定します。例: —label KEY=VALUE または —label LABEL
--env-file TEXT: 環境変数を含むファイルを読み込みます。- を使用すると、stdin から読み込むことができます。
--secrets-file TEXT: シークレット環境変数を含むファイルを読み込みます。- を使用すると、stdin から読み込むことができます。
-v, --volume TEXT: 1 つ以上のボリュームをマウントします。形式: hf://[TYPE/]SOURCE:/MOUNT_PATH[:ro]。TYPE は models、datasets、spaces、buckets のいずれかです。TYPE を省略した場合、デフォルトで models になります。models、datasets、spaces は常に読み取り専用でマウントされます。buckets はデフォルトで読み書き可能です。例: -v hf://org/m:/data または -v hf://datasets/org/ds:/data または -v hf://buckets/org/b:/mnt:ro
--namespace TEXT: ジョブが実行される名前空間です。デフォルトでは、現在のユーザーの名前空間が使用されます。
--forward-hf-token: HF_TOKEN として HF トークンをサンドボックスに注入します。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf sandbox create $ hf sandbox create ubuntu:24.04 $ hf sandbox create —flavor a10g-small $ hf sandbox create —label controller-run=run-42 $ hf sandbox create —pool pool-ab12cd34ef56 —env LOG_LEVEL=debug

hf sandbox exec

サンドボックス内でコマンドを実行し、出力をストリーミングします。コマンドの終了コードで終了します。

待機せずにバックグラウンドで長時間実行されるコマンドを開始するには、hf sandbox spawnを使用します。

使用方法:

$ hf sandbox exec [OPTIONS] SANDBOX_ID COMMAND...

引数:

SANDBOX_ID: hf sandbox create によって出力されるサンドボックス ID。 [必須]
COMMAND...: 実行するコマンド。[必須]

オプション:

-w, --workdir TEXT: 作業ディレクトリ。
-e, --env TEXT: 環境変数を設定します。例: —env ENV=value
--env-file TEXT: 環境変数を含むファイルを読み込みます。- を使用すると、stdin から読み込むことができます。
--timeout FLOAT: この秒数後にコマンドを強制終了します。
--namespace TEXT: ジョブが実行される名前空間です。デフォルトでは、現在のユーザーの名前空間が使用されます。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf sandbox exec <sandbox_id> — python -c “print(42)” $ hf sandbox exec -w /app <sandbox_id> — pytest -x

hf sandbox kill

—all を指定して、サンドボックス全体、共有ホスト全体、またはすべてを終了します。

使用方法:

$ hf sandbox kill [OPTIONS] [SANDBOX_ID]

引数:

[SANDBOX_ID]: 終了するサンドボックスまたはホストの ID。

オプション:

--all: namespace内のすべてのサンドボックスとホストを終了します。
-y, --yes: プロンプトに対して自動的に「はい」と応答します。
--namespace TEXT: ジョブが実行される名前空間です。デフォルトでは、現在のユーザーの名前空間が使用されます。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf sandbox kill <sandbox_id> $ hf sandbox kill <host_id> # kills a whole shared host (all its sandboxes) $ hf sandbox kill —all

hf sandbox pool

信頼境界内のワークロードに対して、ホストVMプールをウォーム状態に保ち、実験的な共有サンドボックスを生成します。

使用方法:

$ hf sandbox pool [OPTIONS] COMMAND [ARGS]...

オプション:

--help: このメッセージを表示して終了します。

コマンド:

create: プールのウォームアップ: 1台のホストVMを今すぐ起動し、後でプールIDによって検索できるようにタグ付けします。
delete: プールのすべてのホストVMを終了します（これにより、そのプール内のすべてのサンドボックスも終了します）。[別名: rm]
ls: 実行中のサンドボックスプールをホストVMからグループ化して一覧表示します。[別名: list]

hf sandbox pool create

プールのウォームアップ: 1台のホストVMを起動し、後でプールIDによって検索できるようにタグ付けします。

使用方法:

$ hf sandbox pool create [OPTIONS] [IMAGE]

引数:

[IMAGE]: ホスト用のDockerイメージ（/bin/shが必要です）。

オプション:

--flavor [cpu-basic|cpu-upgrade|cpu-performance|cpu-xl|t4-small|t4-medium|l4x1|l4x4|l40sx1|l40sx4|l40sx8|a10g-small|a10g-large|a10g-largex2|a10g-largex4|a100-large|a100x4|a100x8|h200|h200x2|h200x4|h200x8|rtx-pro-6000|rtx-pro-6000x2|rtx-pro-6000x4|rtx-pro-6000x8]: ハードウェアの Flavor を指定します。利用可能な Flavor の一覧を確認するには、‘hf jobs hardware’ を実行してください。デフォルト値は cpu-basic です。
--per-host INTEGER RANGE: 1つのホストVMにパッキングされるサンドボックスの数（デフォルトは50）。 [default: 50; x>=1]
--max-hosts INTEGER RANGE: ホストVMの数の上限を任意で指定します。 [x>=1]
--idle-timeout TEXT: この時間（例：‘10m’）にわたってサンドボックスが存在しなかった場合、ホストをシャットダウンします。デフォルト値は 10m です。
--namespace TEXT: ジョブが実行される名前空間です。デフォルトでは、現在のユーザーの名前空間が使用されます。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf sandbox pool create $ hf sandbox pool create python:3.12 —flavor cpu-basic $ hf sandbox pool create —per-host 50 —idle-timeout 30m

hf sandbox pool delete

プールのすべてのホストVM(したがって、そのすべてのサンドボックス)を終了します。[別名: rm]

使用方法:

$ hf sandbox pool delete [OPTIONS] POOL_ID

引数:

POOL_ID: 削除するプールのID。 [必須]

オプション:

-y, --yes: プロンプトに対して自動的に「はい」と応答します。
--namespace TEXT: ジョブが実行される名前空間です。デフォルトでは、現在のユーザーの名前空間が使用されます。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf sandbox pool delete <pool_id>

hf sandbox pool ls

実行中のサンドボックスプールをリスト表示します（ホストVMからグループ化）。[エイリアス: list]

使用方法:

$ hf sandbox pool ls [OPTIONS]

オプション:

--namespace TEXT: ジョブが実行される名前空間です。デフォルトでは、現在のユーザーの名前空間が使用されます。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf sandbox pool ls

hf sandbox process

サンドボックス内で実行されているバックグラウンドプロセスをリスト表示して停止します。

使用方法:

$ hf sandbox process [OPTIONS] COMMAND [ARGS]...

オプション:

--help: このメッセージを表示して終了します。

コマンド:

kill: サンドボックス内で実行されているバックグラウンドプロセスを停止します。
ls: サンドボックス内で実行中のバックグラウンドプロセス（hf sandbox spawnで開始されたもの）をリスト表示します。[エイリアス: list]

hf sandbox process kill

サンドボックス内で実行されているバックグラウンドプロセスを停止します。

使用方法:

$ hf sandbox process kill [OPTIONS] SANDBOX_ID PID

引数:

SANDBOX_ID: hf sandbox create によって出力されるサンドボックス ID。 [必須]
PID: hf sandbox process lsで表示されるpidです。 [必須]

オプション:

--namespace TEXT: ジョブが実行される名前空間です。デフォルトでは、現在のユーザーの名前空間が使用されます。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf sandbox process kill <sandbox_id> <pid>

hf sandbox process ls

サンドボックス内で実行されているバックグラウンドプロセス（hf sandbox spawnで開始されたもの）をリスト表示します。[エイリアス: list]

使用方法:

$ hf sandbox process ls [OPTIONS] SANDBOX_ID

引数:

SANDBOX_ID: hf sandbox create によって出力されるサンドボックス ID。 [必須]

オプション:

--namespace TEXT: ジョブが実行される名前空間です。デフォルトでは、現在のユーザーの名前空間が使用されます。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf sandbox process ls <sandbox_id>

hf sandbox spawn

バックグラウンドで長時間実行されるコマンドを開始し、そのpidを返します（待機しません）。

hf sandbox process ls でサンドボックスのプロセスをリスト表示し、hf sandbox process kill でプロセスを停止します。

使用方法:

$ hf sandbox spawn [OPTIONS] SANDBOX_ID COMMAND...

引数:

SANDBOX_ID: hf sandbox create によって出力されるサンドボックス ID。 [必須]
COMMAND...: バックグラウンドで実行するコマンド。[必須]

オプション:

-w, --workdir TEXT: 作業ディレクトリ。
-e, --env TEXT: 環境変数を設定します。例: —env ENV=value
--env-file TEXT: 環境変数を含むファイルを読み込みます。- を使用すると、stdin から読み込むことができます。
--namespace TEXT: ジョブが実行される名前空間です。デフォルトでは、現在のユーザーの名前空間が使用されます。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf sandbox spawn <sandbox_id> — python -m http.server 8000 $ hf sandbox spawn -w /app <sandbox_id> — uvicorn app:app

hf スキル

AIアシスタントのスキルを管理します。

使用方法:

$ hf skills [OPTIONS] COMMAND [ARGS]...

オプション:

--help: このメッセージを表示して終了します。

コマンド:

add: AIアシスタント用の Hugging Face スキルをインストールします。
list: Hugging Face マーケットプレイスから利用可能なスキルをリスト表示します。[エイリアス: ls]
preview: 生成されたhf-cli SKILL.mdを標準出力に出力します。
update: インストール済みの Hugging Face マーケットプレイスのスキルを更新します。

hf skills add

AIアシスタント用のHugging Faceスキルをインストールします。

デフォルトの hf-cli スキルは、インストールされている CLI のバージョンからローカルで生成されます。その他のスキルは、Hugging Face マーケットプレイスからダウンロードされます。デフォルトの保存場所は、カレントディレクトリ (.agents/skills) またはユーザーレベル (~/.agents/skills) です。スキルは、--dest が使用されない限り、Claude Code のスキルディレクトリ (.claude/skills または ~/.claude/skills、設定されている場合は CLAUDE_CONFIG_DIR を優先) にもシンボリックリンクされます。

使用方法:

$ hf skills add [OPTIONS] [NAME]

引数:

[NAME]: マーケットプレイスのスキル名。

オプション:

-g, --global: 現在のプロジェクトディレクトリではなく、グローバル（ユーザーレベル）にインストールします。
--dest PATH: カスタムのインストール先（skills ディレクトリへのパス）にインストールします。
--force: 宛先にある既存のスキルを上書きします。
--help: このメッセージを表示して終了します。

例 $ hf skills add $ hf skills add huggingface-gradio —dest=~/my-skills $ hf skills add —global $ hf skills add huggingface-gradio —global

hf skills list

Hugging Face マーケットプレイスから利用可能なスキルをリスト表示します。[alias: ls]

使用方法:

$ hf skills list [OPTIONS]

オプション:

--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf skills list $ hf skills list —format json

hf skills プレビュー

生成されたhf-cli SKILL.mdを標準出力に出力します。

使用方法:

$ hf skills preview [OPTIONS]

オプション:

--help: このメッセージを表示して終了します。

hf skills update

インストール済みのHugging Faceマーケットプレイスのスキルを更新します。

使用方法:

$ hf skills update [OPTIONS] [NAME]

引数:

[NAME]: 更新するオプションのインストール済みスキル名。

オプション:

-g, --global: 現在のプロジェクトではなく、グローバルなスキルディレクトリを使用します。
--dest PATH: カスタムのスキルディレクトリ内のスキルを更新します。
--help: このメッセージを表示して終了します。

例 $ hf skills update $ hf skills update hf-cli $ hf skills update huggingface-gradio —dest=~/my-skills $ hf skills update -g

hf spaces

Hub上のスペースと対話します。

使用方法:

$ hf spaces [OPTIONS] COMMAND [ARGS]...

オプション:

--help: このメッセージを表示して終了します。

コマンド:

card: Hub上のSpaceのSpaceカード（README）を取得します。
dev-mode: Space 上で開発モードを有効または無効にします。
hardware: Spacesで利用可能なハードウェアオプションのリスト。
hot-reload: SpaceのPythonファイルをフルリビルドや再起動なしでホットリロードします。
info: Hub上のスペースに関する情報を取得します。
list: Hub上のスペース、またはスペースリポジトリ内のファイルをリスト表示します。[別名: ls]
logs: Spaceの実行またはビルドのログを取得します。
pause: Spaceを一時停止します。
restart: Spaceを再起動します。
search: Hub上のスペースをセマンティック検索で検索します。
secrets: Hub上のSpaceのシークレットを管理します。
settings: Space の設定を更新します。
ssh: Space の Dev Mode コンテナに SSH 接続します。
templates: 利用可能な Space テンプレートのリストを表示します。
variables: Hub上のSpaceの環境変数を管理します。
volumes: Hub上のSpaceのボリュームを管理します。
wait: Space のビルド/起動が完了するまで待機します。
zero-gpu: Hub での ZeroGPU の使用状況进行管理します。

hf spaces カード

Hub上のSpaceのSpaceカード（README）を取得します。

使用方法:

$ hf spaces card [OPTIONS] SPACE_ID

引数:

SPACE_ID: スペースの ID（例: username/repo-name）。[必須]

オプション:

--metadata: カードのメタデータのみを出力します。
--text: メタデータなしでテキスト本文のみを出力します。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf spaces card mteb/leaderboard $ hf spaces card mteb/leaderboard —metadata $ hf spaces card mteb/leaderboard —metadata —format json $ hf spaces card mteb/leaderboard —text

hf spaces dev-mode

Spaceで開発モードを有効化または無効化します。

Spaces Dev Mode は、Space コンテナ自体を停止せずにアプリケーションを再起動できるため、アプリケーションのデバッグを容易にし、Spaces の反復開発を高速化します。Dev Mode を有効にするには、PRO または Team & Enterprise プランが必要です。無効化（--stop）は常に許可されています。

ドキュメントを参照してください: https://huggingface.co/docs/hub/spaces-dev-mode

使用方法:

$ hf spaces dev-mode [OPTIONS] SPACE_ID

引数:

SPACE_ID: スペースの ID（例: username/repo-name）。[必須]

オプション:

--stop / --no-stop: 開発モードを停止します。 [デフォルト: no-stop]
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf spaces dev-mode my-user-name/deepsite

hf spaces ハードウェア

Spacesで利用可能なハードウェアオプションをリスト表示します。

使用方法:

$ hf spaces hardware [OPTIONS]

オプション:

--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf spaces hardware

hf spaces hot-reload

SpaceのPythonファイルは、フルリビルドや再起動なしでホットリロードできます。

⚠ この機能は実験的です ⚠

Gradio SDK (6.1+)でのみ動作します。 -local-file/-fが指定されていない場合、インタラクティブなエディターが開きます。

このコマンドは、https://github.com/breuleux/jurigged（ASTベースの差分比較、関数のインプレース更新など）を使用して実行中のPythonプロセスをパッチ適用し、Gradioのネイティブなホットリロード機能と統合されています（Gradioのデモオブジェクトの変更がUIに反映されることを意味します）。

このコマンドはリモートコミットを作成します。ローカルクローンから作業している場合は、その後でgit pull --autostashを実行して、コミットを取り込み、ローカルのgit状態を同期させてください。

使用方法:

$ hf spaces hot-reload [OPTIONS] SPACE_ID [FILENAME]

引数:

SPACE_ID: スペースの ID（例: username/repo-name）。[必須]
[FILENAME]: Space リポジトリ内の Python ファイルへのパス。—local-file が指定され、リポジトリ内のパスが一致する場合、省略できます。

オプション:

-f, --local-file PATH: ローカルファイルのパス。指定しない場合は対話的なエディタモードになります
--skip-checks / --no-skip-checks: ホットリロードの互換性チェックをスキップします。 [デフォルト: no-skip-checks]
--skip-summary / --no-skip-summary: ホットリロードがトリガーされた後のサマリー表示をスキップします [デフォルト: no-skip-summary]
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf spaces hot-reload username/repo-name app.py # Open an interactive editor to the remote app.py file $ hf spaces hot-reload username/repo-name -f app.py # Take local version from ./app.py and patch app.py remotely $ hf spaces hot-reload username/repo-name app.py -f src/app.py # Take local version from ./src/app.py

hf spaces info

Hub上のスペースに関する情報を取得します。

使用方法:

$ hf spaces info [OPTIONS] SPACE_ID

引数:

SPACE_ID: スペースの ID（例: username/repo-name）。[必須]

オプション:

--revision TEXT: GitのリビジョンID。ブランチ名、タグ、またはコミットハッシュを指定できます。
--expand TEXT: 返すプロパティをカンマ区切りで指定します。使用すると、リストされたプロパティ（および id）のみが返されます。例: ‘—expand=likes,tags’。有効な値: author, cardData, createdAt, datasets, disabled, lastModified, likes, models, private, region, resourceGroup, runtime, sdk, sha, siblings, subdomain, tags, trendingScore, usedStorage, visibility。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf spaces info enzostvs/deepsite $ hf spaces info gradio/theme_builder —expand sdk,runtime,likes

hf spaces list

Hub上のスペース、またはスペースリポジトリ内のファイルをリスト表示します。[エイリアス: ls]

引数なしで呼び出された場合、Hub上のスペースをリスト表示します。スペースIDを引数として呼び出された場合、そのスペースリポジトリ内のファイルをリスト表示します。

使用方法:

$ hf spaces list [OPTIONS] [REPO_ID]

引数:

[REPO_ID]: Space ID (例: username/repo-name)。この ID を指定すると、その Space からファイルの一覧を取得します。省略すると、Space の一覧を取得します。

オプション:

--search TEXT: 検索クエリ。
--author TEXT: 作成者または組織でフィルタリングします。
--filter TEXT: タグでフィルタリングします（例: ‘text-classification’）。複数回使用できます。
--sort [created_at|last_modified|likes|trending_score]: 結果をソートします。
--limit INTEGER: 結果の件数を制限します。 [デフォルト: 30]
--expand TEXT: 返すプロパティをカンマ区切りで指定します。使用すると、リストされたプロパティ（および id）のみが返されます。例: ‘—expand=likes,tags’。有効な値: author, cardData, createdAt, datasets, disabled, lastModified, likes, models, private, region, resourceGroup, runtime, sdk, sha, siblings, subdomain, tags, trendingScore, usedStorage, visibility。
-h, --human-readable: サイズを人間が読みやすい形式で表示します（ファイルの一覧表示時のみ）。
--tree: ファイルをツリー形式で一覧表示します（ファイルの一覧表示時のみ）。
-R, --recursive: ファイルを再帰的に一覧表示します（ファイルの一覧表示のみ）。
--revision TEXT: GitのリビジョンID。ブランチ名、タグ、またはコミットハッシュを指定できます。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf spaces ls —limit 10 $ hf spaces ls —search “chatbot” —author huggingface $ hf spaces ls victor/deepsite $ hf spaces ls victor/deepsite -R $ hf spaces ls victor/deepsite —tree -h

hf spaces logs

Spaceの実行ログまたはビルドログを取得します。

デフォルトでは、現在利用可能な実行ログを出力して終了します（docker logsと同様に非ブロッキングです）。サーバーがストリームを閉じるまでストリーミング表示するには、—follow/-f を使用してください。代わりにコンテナのビルドログを表示するには、—build を使用します（Space が BUILD_ERROR で停止している場合に便利です）。

使用方法:

$ hf spaces logs [OPTIONS] SPACE_ID

引数:

SPACE_ID: スペースの ID（例: username/repo-name）。[必須]

オプション:

--build: 実行ログではなく、コンテナのビルドログを取得します。SpaceがBUILD_ERRORで停止している場合に便利です。
-f, --follow: ログ出力をフォローします（サーバーがストリームを閉じるまでストリーミングします）。このフラグを指定しない場合、現在利用可能なログのみが表示されます。
-n, --tail INTEGER: ログの末尾から表示する行数。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf spaces logs username/my-space $ hf spaces logs username/my-space —build $ hf spaces logs -f username/my-space $ hf spaces logs -n 50 username/my-space

hf spaces pause

Spaceを一時停止します。

使用方法:

$ hf spaces pause [OPTIONS] SPACE_ID

引数:

SPACE_ID: スペースの ID（例: username/repo-name）。[必須]

オプション:

--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf spaces pause username/my-space

hf spaces restart

Spaceを再起動します。

使用方法:

$ hf spaces restart [OPTIONS] SPACE_ID

引数:

SPACE_ID: スペースの ID（例: username/repo-name）。[必須]

オプション:

--factory-reboot: ビルドキャッシュを使用せずに、Spaceを最初から再構築します。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf spaces restart username/my-space $ hf spaces restart username/my-space —factory-reboot

hf spaces search

Hub上でセマンティック検索を使用して検索スペースを検索します。

使用方法:

$ hf spaces search [OPTIONS] QUERY

引数:

QUERY: 検索クエリ。[必須]

オプション:

--filter TEXT: タグでフィルタリングします（例: ‘text-classification’）。複数回使用できます。
--sdk TEXT: SDKでフィルタリングします（例: gradio, docker, static）。
--include-non-running / --no-include-non-running: 結果に実行されていないスペースを含めるかどうか。 [デフォルト: no-include-non-running]
--description / --no-description: AI によって生成された説明を表示します。 [デフォルト: no-description]
--limit INTEGER: 結果の件数を制限します。 [デフォルト: 10]
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf spaces search “generate image” $ hf spaces search “identify objects in pictures” —sdk gradio —limit 5 $ hf spaces search “remove background from photo” —description —json

hf spaces secrets

Hub上のSpaceのシークレットを管理します。

使用方法:

$ hf spaces secrets [OPTIONS] COMMAND [ARGS]...

オプション:

--help: このメッセージを表示して終了します。

コマンド:

add: Spaceのシークレットを追加または更新します。
delete: Spaceからシークレットを削除します。
list: Space のシークレットをリスト表示します。[エイリアス: ls]

hf spaces secrets add

Spaceのシークレットを追加または更新します。

使用方法:

$ hf spaces secrets add [OPTIONS] SPACE_ID

引数:

SPACE_ID: スペースの ID（例: username/repo-name）。[必須]

オプション:

-s, --secrets TEXT: シークレット環境変数を設定します。環境から値を読み込むには --secrets SECRET を優先してください（例: Hugging Face トークンを渡すには --secrets HF_TOKEN）。--secrets SECRET=value は値をシェル履歴に記録してしまいます。
--secrets-file TEXT: シークレット環境変数を含むファイルを読み込みます。- を使用すると、stdin から読み込むことができます。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf spaces secrets add username/my-space -s HF_TOKEN $ hf spaces secrets add username/my-space -s OPENAI_API_KEY=sk-… -s ANTHROPIC_API_KEY=sk-… $ hf spaces secrets add username/my-space —secrets-file .env.secrets

hf spaces secrets delete

Spaceからシークレットを削除します。

使用方法:

$ hf spaces secrets delete [OPTIONS] SPACE_ID KEY

引数:

SPACE_ID: スペースの ID（例: username/repo-name）。[必須]
KEY: 削除するシークレットの名前。 [必須]

オプション:

-y, --yes: プロンプトに対して自動的に Yes と応答します。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf spaces secrets delete username/my-space HF_TOKEN $ hf spaces secrets delete username/my-space HF_TOKEN —yes

hf spaces secrets list

Spaceのシークレットをリスト表示します。シークレットの値は書き込み専用であり、返されません。[alias: ls]

使用方法:

$ hf spaces secrets list [OPTIONS] SPACE_ID

引数:

SPACE_ID: スペースの ID（例: username/repo-name）。[必須]

オプション:

--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf spaces secrets ls username/my-space

hf spaces 設定

Spaceの設定を更新します。

使用方法:

$ hf spaces settings [OPTIONS] SPACE_ID

引数:

SPACE_ID: スペースの ID（例: username/repo-name）。[必須]

オプション:

--sleep-time INTEGER: Space がスリープ状態に移行するまでのアイドル時間（秒）。-1 を使用すると、スリープ状態にはなりません。アップグレードされたハードウェアでのみ利用可能です。
--hardware [cpu-basic|cpu-upgrade|zero-a10g|t4-small|t4-medium|l4x1|l4x4|l40sx1|l40sx4|l40sx8|a10g-small|a10g-large|a10g-largex2|a10g-largex4|a100-large|a100x4|a100x8|rtx-pro-6000|rtx-pro-6000x2|rtx-pro-6000x4|rtx-pro-6000x8]: Spaceのハードウェア構成（例: ‘cpu-basic’、‘t4-medium’、‘l4x4’）。利用可能なオプションの一覧を確認するには、‘hf spaces hardware’を実行してください。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf spaces settings username/my-space —sleep-time 300 $ hf spaces settings username/my-space —hardware t4-medium

hf spaces ssh

SpaceのDev ModeコンテナにSSH接続します。

SpaceでDev Modeが実行されていること、およびSSH公開鍵がhttps://huggingface.co/settings/keysに登録されていることが必要です。

参照: https://huggingface.co/docs/hub/spaces-dev-mode

使用方法:

$ hf spaces ssh [OPTIONS] SPACE_ID

引数:

SPACE_ID: スペースの ID（例: username/repo-name）。[必須]

オプション:

-i, --identity-file PATH: SSH 認証ファイルへのパス（ssh -i に転送されます）。
--dry-run: 実行する代わりに、SSH コマンドを出力します。
--auto: 有効化されていない場合、プロンプトなしで Dev Mode を有効にします。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf spaces ssh username/my-space $ hf spaces ssh username/my-space —dry-run $ hf spaces ssh username/my-space -i ~/.ssh/id_ed25519 $ hf spaces ssh username/my-space —auto

hf spaces テンプレート

利用可能なSpaceテンプレートのリストを表示します。

テンプレートのrepo_id（またはname）をhf repos create --template ...に渡すことで、そのテンプレートから新しいSpaceを作成できます。

使用方法:

$ hf spaces templates [OPTIONS]

オプション:

--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf spaces templates

hf spaces 変数

Hub上のSpaceの環境変数を管理します。

使用方法:

$ hf spaces variables [OPTIONS] COMMAND [ARGS]...

オプション:

--help: このメッセージを表示して終了します。

コマンド:

add: Space の環境変数を追加または更新します。
delete: Spaceから環境変数を削除します。
list: Space の環境変数をリスト表示します。[alias: ls]

hf spaces variables add

Spaceの環境変数を追加または更新します。

使用方法:

$ hf spaces variables add [OPTIONS] SPACE_ID

引数:

SPACE_ID: スペースの ID（例: username/repo-name）。[必須]

オプション:

-e, --env TEXT: 環境変数を設定します。例: —env ENV=value
--env-file TEXT: 環境変数を含むファイルを読み込みます。- を使用すると、stdin から読み込むことができます。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf spaces variables add username/my-space -e DEBUG=1 $ hf spaces variables add username/my-space -e MODEL_ID=gpt2 -e MAX_TOKENS=512 $ hf spaces variables add username/my-space —env-file .env

hf spaces variables delete

Spaceから環境変数を削除します。

使用方法:

$ hf spaces variables delete [OPTIONS] SPACE_ID KEY

引数:

SPACE_ID: スペースの ID（例: username/repo-name）。[必須]
KEY: 削除する変数の名前。 [必須]

オプション:

-y, --yes: プロンプトに対して自動的に Yes と応答します。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf spaces variables delete username/my-space DEBUG $ hf spaces variables delete username/my-space DEBUG —yes

hf spaces variables list

Space の環境変数をリスト表示します。[alias: ls]

使用方法:

$ hf spaces variables list [OPTIONS] SPACE_ID

引数:

SPACE_ID: スペースの ID（例: username/repo-name）。[必須]

オプション:

--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf spaces variables ls username/my-space

hf spaces volumes

Hub上のSpaceのボリュームを管理します。

使用方法:

$ hf spaces volumes [OPTIONS] COMMAND [ARGS]...

オプション:

--help: このメッセージを表示して終了します。

コマンド:

delete: Spaceからすべてのボリュームを削除します。
list: Spaceにマウントされているボリュームのリストを表示します。[別名: ls]
set: Space のボリュームを設定（置き換え）します。

hf spaces volumes delete

Spaceからすべてのボリュームを削除します。

使用方法:

$ hf spaces volumes delete [OPTIONS] SPACE_ID

引数:

SPACE_ID: スペースの ID（例: username/repo-name）。[必須]

オプション:

-y, --yes: プロンプトに対して自動的に Yes と応答します。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf spaces volumes delete username/my-space $ hf spaces volumes delete username/my-space —yes

hf spaces volumes list

Spaceにマウントされているボリュームをリスト表示します。[alias: ls]

使用方法:

$ hf spaces volumes list [OPTIONS] SPACE_ID

引数:

SPACE_ID: スペースの ID（例: username/repo-name）。[必須]

オプション:

--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf spaces volumes ls username/my-space

hf spaces volumes set

Spaceのボリュームを設定（置き換え）します。

使用方法:

$ hf spaces volumes set [OPTIONS] SPACE_ID

引数:

SPACE_ID: スペースの ID（例: username/repo-name）。[必須]

オプション:

-v, --volume TEXT: 1 つ以上のボリュームをマウントします。形式: hf://[TYPE/]SOURCE:/MOUNT_PATH[:ro]。TYPE は models、datasets、spaces、buckets のいずれかです。TYPE を省略した場合、デフォルトで models になります。models、datasets、spaces は常に読み取り専用でマウントされます。buckets はデフォルトで読み書き可能です。例: -v hf://org/m:/data または -v hf://datasets/org/ds:/data または -v hf://buckets/org/b:/mnt:ro
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf spaces volumes set username/my-space -v hf://models/username/my-model:/models $ hf spaces volumes set username/my-space -v hf://buckets/username/my-bucket:/data -v hf://datasets/username/my-dataset:/datasets:ro

hf spaces wait

Spaceのビルド/起動が完了するまで待機します。

Space が中間段階（BUILDING、APP_STARTING など）を離れ、安定した段階に達するまでブロックします。Space が RUNNING の場合は終了コード 0 で終了し、それ以外の場合は非ゼロの終了コードで終了します（例：BUILD_ERROR、RUNTIME_ERROR）。

使用方法:

$ hf spaces wait [OPTIONS] SPACE_ID

引数:

SPACE_ID: スペースの ID（例: username/repo-name）。[必須]

オプション:

--timeout TEXT: 最大待機時間: s（秒、デフォルト）、m（分）、h（時間）、d（日）付きの int。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf spaces wait username/my-space $ hf spaces wait username/my-space —timeout 5m

hf spaces zero-gpu

Hub上でZeroGPUの使用状況を確認します。

使用方法:

$ hf spaces zero-gpu [OPTIONS] COMMAND [ARGS]...

オプション:

--help: このメッセージを表示して終了します。

コマンド:

quota: ZeroGPU のクォータ（残りの GPU 時間とリセット日）を表示します。

hf spaces zero-gpu quota

ZeroGPUのクォータ（残りのGPU時間とリセット日）を表示します。

値はGPU秒単位です。--quietを指定すると、残りのGPU秒のみが表示されます。

使用方法:

$ hf spaces zero-gpu quota [OPTIONS]

オプション:

--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf spaces zero-gpu quota $ hf spaces zero-gpu quota —format json

hf sync

ローカルディレクトリとバケット間でファイルを同期します。

使用方法:

$ hf sync [OPTIONS] [SOURCE] [DEST]

引数:

[SOURCE]: ソースパス: ローカルディレクトリまたはhf://buckets/namespace/bucket_name(/prefix)
[DEST]: 宛先パス: ローカルディレクトリまたはhf://buckets/namespace/bucket_name(/prefix)

オプション:

--delete / --no-delete: ソースに存在しない宛先のファイルを削除します。 [デフォルト: no-delete]
--ignore-times: 変更時刻を無視し、サイズのみを基準としてファイルをスキップします。
--ignore-sizes: サイズを無視して、変更時刻のみに基づいてファイルをスキップします。
--plan TEXT: 実行せずに、レビュー用に同期計画をJSONLファイルに保存します。
--apply TEXT: 以前に保存したプランファイルを適用します。
--dry-run: 実行せずに、同期計画をJSONL形式で標準出力に出力します。
--include TEXT: パターンに一致するファイルを含める（複数指定可能）。
--exclude TEXT: パターンに一致するファイルを除外します（複数指定可能）。
--filter-from TEXT: ファイルからインクルード/エクスクルードのパターンを読み込みます。
--existing: 受信側で新しいファイルの作成をスキップします（既存のファイルのみを更新します）。
--ignore-existing: 受信側に既に存在するファイルの更新をスキップします（新しいファイルのみを作成します）。
-v, --verbose: 推論の詳細を含む詳細なログを表示します。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

hf update

hf CLIを最新バージョンに更新してください。

使用方法:

$ hf update [OPTIONS]

オプション:

--help: このメッセージを表示して終了します。

hf upload

ファイルをフォルダをHubにアップロードします。

多くのファイルを含むフォルダは、複数のコミットに分割されます。フォルダのアップロードが中断された場合は、同じコマンドを再実行して再開してください。

使用方法:

$ hf upload [OPTIONS] REPO_ID [LOCAL_PATH] [PATH_IN_REPO]

引数:

REPO_ID: リポジトリの ID（例: username/repo-name または spaces/username/repo-name）。[必須]
[LOCAL_PATH]: アップロードするファイルまたはフォルダーのローカルパスです。ワイルドカードパターンがサポートされています。デフォルトでは、現在のディレクトリが使用されます。
[PATH_IN_REPO]: リポジトリ内のファイルまたはフォルダのパス。デフォルトでは、ファイルまたはフォルダの相対パスが使用されます。

オプション:

--type, --repo-type [model|dataset|space|kernel]: リポジトリの種類（model、dataset、space、kernel）。[デフォルト: (model)]
--revision TEXT: GitのリビジョンID。ブランチ名、タグ、またはコミットハッシュを指定できます。
--private / --no-private: Hub にリポジトリが存在しない場合に、プライベートリポジトリを作成するかどうか。リポジトリが既に存在する場合は無視されます。
--include TEXT: アップロードするファイルに一致させる Glob パターン。
--exclude TEXT: アップロード対象のファイルから除外する Glob パターン。
--delete TEXT: コミット時にリポジトリから削除するファイルのGlobパターン。
--commit-message TEXT: 生成されるコミットのサマリー / タイトル / 最初の行。
--commit-description TEXT: 生成されるコミットの説明。
--create-pr / --no-create-pr: 内容を新しい Pull Request としてアップロードするかどうか。 [デフォルト: no-create-pr]
--every FLOAT: 設定されている場合、every 分ごとにコミットを作成するバックグラウンドジョブがスケジュールされます。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf upload my-cool-model . . $ hf upload Wauplin/my-cool-model ./models/model.safetensors $ hf upload Wauplin/my-cool-dataset ./data /train —repo-type=dataset $ hf upload Wauplin/my-cool-model ./models . —commit-message=“Epoch 34/50” —commit-description=“Val accuracy: 68%” $ hf upload bigcode/the-stack . . —repo-type dataset —create-pr

hf バージョン

hfのバージョンに関する情報を表示します。

使用方法:

$ hf version [OPTIONS]

オプション:

--help: このメッセージを表示して終了します。

hf webhooks

HubでWebhookを管理します。

使用方法:

$ hf webhooks [OPTIONS] COMMAND [ARGS]...

オプション:

--help: このメッセージを表示して終了します。

コマンド:

create: 新しいWebhookを作成します。
delete: Webhookを完全に削除します。
disable: アクティブなWebhookを無効にします。
enable: 無効化された Webhook を有効にします。
info: 単一のWebhookの詳細をすべて表示します。
list: 現在のユーザーのすべての Webhook を一覧表示します。[エイリアス: ls]
update: 既存のWebhookを更新します。

hf webhooks create

新しいWebhookを作成します。

—url（リモートサーバーにpingを送信する場合）または —job-id（Jobをトリガーする場合）のいずれか一方を指定してください。両方を指定することはできません。ソースJobのシークレットはWebhookにコピーされません。—secrets / —secrets-file を使用して再度渡してください。

使用方法:

$ hf webhooks create [OPTIONS]

オプション:

--watch TEXT: 監視するアイテム。「type:name」形式（例: ‘model:bert-base-uncased’）で指定します。繰り返し指定可能です。 [必須]
--url TEXT: Webhookペイロードを送信するURL。—job-id とは排他的です。
--job-id TEXT: URLへのpingの代わりにトリガーするJobのID（job.idから取得）。—urlと排他です。
--domain [repo|discussion]: 監視するドメイン: ‘repo’ または ‘discussion’。繰り返し指定できます。デフォルトではすべてのドメインを監視します。
--secret TEXT: Webhookペイロードに署名するために使用される任意のシークレット。
-s, --secrets TEXT: シークレット環境変数を設定します。環境から値を読み込むには --secrets SECRET を優先してください（例: Hugging Face トークンを渡すには --secrets HF_TOKEN）。--secrets SECRET=value は値をシェル履歴に記録してしまいます。
--secrets-file TEXT: シークレット環境変数を含むファイルを読み込みます。- を使用すると、stdin から読み込むことができます。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf webhooks create —url https://example.com/hook —watch model:bert-base-uncased $ hf webhooks create —url https://example.com/hook —watch org:HuggingFace —watch model:gpt2 —domain repo $ hf webhooks create —job-id 687f911eaea852de79c4a50a —watch user:julien-c $ hf webhooks create —job-id 687f911eaea852de79c4a50a —watch bucket:my-org/my-bucket —secrets HF_TOKEN

hf webhooks delete

Webhookを完全に削除します。

使用方法:

$ hf webhooks delete [OPTIONS] WEBHOOK_ID

引数:

WEBHOOK_ID: 削除する Webhook の ID。 [必須]

オプション:

-y, --yes: 確認プロンプトをスキップします。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf webhooks delete abc123 $ hf webhooks delete abc123 —yes

hf webhooks disable

アクティブなWebhookを無効にします。

使用方法:

$ hf webhooks disable [OPTIONS] WEBHOOK_ID

引数:

WEBHOOK_ID: 無効化する Webhook の ID。[必須]

オプション:

--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf webhooks disable abc123

hf webhooks enable

無効化されたWebhookを有効にします。

使用方法:

$ hf webhooks enable [OPTIONS] WEBHOOK_ID

引数:

WEBHOOK_ID: 有効にする Webhook の ID。[必須]

オプション:

--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf webhooks enable abc123

hf webhooks info

単一のWebhookの詳細をすべて表示します。

使用方法:

$ hf webhooks info [OPTIONS] WEBHOOK_ID

引数:

WEBHOOK_ID: WebhookのID。[必須]

オプション:

--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf webhooks info abc123

hf webhooks list

現在のユーザーのすべてのWebhookをリスト表示します。[エイリアス: ls]

使用方法:

$ hf webhooks list [OPTIONS]

オプション:

--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf webhooks ls $ hf webhooks ls —format json $ hf webhooks ls —format quiet

hf webhooks update

既存のWebhookを更新します。提供されたオプションのみが変更されます。

—secretsで渡されるジョブのシークレットは、同名の保存済み値を置き換えます。それ以外の値は保持されます。

使用方法:

$ hf webhooks update [OPTIONS] WEBHOOK_ID

引数:

WEBHOOK_ID: 更新する Webhook の ID。[必須]

オプション:

--url TEXT: Webhookペイロードを送信する新しいURL。
--job-id TEXT: トリガーするソース Job の ID（現在のものでも可）。—secrets / —secrets-file と併せて使用する場合に必須です。
--watch TEXT: 監視する新しいアイテムのリストを、‘type:name’形式で指定します。繰り返し指定できます。既存の監視リスト全体を置き換えます。
--domain [repo|discussion]: 監視するドメインの新しいリスト: ‘repo’ または ‘discussion’。繰り返し指定できます。
--secret TEXT: Webhookペイロードに署名するために使用される新しいシークレット。
-s, --secrets TEXT: シークレット環境変数を設定します。環境から値を読み込むには --secrets SECRET を優先してください（例: Hugging Face トークンを渡すには --secrets HF_TOKEN）。--secrets SECRET=value は値をシェル履歴に記録してしまいます。
--secrets-file TEXT: シークレット環境変数を含むファイルを読み込みます。- を使用すると、stdin から読み込むことができます。
--token TEXT: https://huggingface.co/settings/tokens で生成された User Access Token。
--help: このメッセージを表示して終了します。

例 $ hf webhooks update abc123 —url https://new-url.com/hook $ hf webhooks update abc123 —watch model:gpt2 —domain repo $ hf webhooks update abc123 —secret newsecret $ hf webhooks update abc123 —job-id 687f911eaea852de79c4a50a —secrets HF_TOKEN

Update on GitHub

←Hugging Face Hub API ファイルのダウンロード→

Hub Python Library

hf

hf auth

hf auth list

hf auth login

hf auth logout

hf auth switch

hf auth token

hf auth whoami

hf buckets

hf buckets cp

hf buckets create

hf buckets delete

hf buckets info

hf buckets list

hf buckets move

hf buckets remove

hf buckets settings

hf buckets sync

hf cache

hf cache list

hf cache prune

hf cache rm

hf cache verify

hf コレクション

hf collections add-item

hf collections create

hf collections delete

hf collections delete-item

hf collections info

hf collections list

hf collections update

hf collections update-item

hf cp

hf datasets

hf データセットカード

hf datasets info

hf datasets リーダーボード

hf datasets list

hf datasets parquet

hf datasets sql

hf discussions

hf discussions close

hf discussions comment

hf discussions create

hf discussions diff

hf discussions 編集

hf discussions info

hf discussions list

hf discussions merge

hf discussions 名前変更

hf discussions 再開

hf download

hf endpoints

hf エンドポイント カタログ

hf endpoints catalog deploy

hf endpoints catalog list

hf endpoints delete

hf endpoints deploy

hf endpoints describe

hf endpoints ハードウェア

hf endpoints list

hf endpoints list-catalog

hf endpoints pause

hf endpoints resume

hf endpoints scale-to-zero

hf endpoints update

hf env

hf extensions

hf extensions exec

hf extensions install

hf extensions list

hf extensions remove

hf extensions search

hf extensions update

hf jobs

hf jobs cancel

hf jobs expose

hf jobs hardware

hf jobs inspect

hf エンドポイントカタログ

hf jobs スケジュールラベル