hf

Hugging Face Hub CLI

Usage:

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

Options:

• --install-completion: Install completion for the current shell.
• --show-completion: Show completion for the current shell, to copy it or customize the installation.
• --help: Show this message and exit.

Commands:

• auth: Manage authentication (login, logout, etc.).
• cache: Manage local cache directory.
• collections: Interact with collections on the Hub.
• datasets: Interact with datasets on the Hub.
• download: Download files from the Hub.
• endpoints: Manage Hugging Face Inference Endpoints.
• env: Print information about the environment.
• jobs: Run and manage Jobs on the Hub.
• lfs-enable-largefiles: Configure your repository to enable upload…
• lfs-multipart-upload: Internal git-lfs custom transfer agent for…
• models: Interact with models on the Hub.
• papers: Interact with papers on the Hub.
• repo: Manage repos on the Hub.
• repo-files: Manage files in a repo on the Hub.
• skills: Manage skills for AI assistants.
• spaces: Interact with spaces on the Hub.
• upload: Upload a file or a folder to the Hub.
• upload-large-folder: Upload a large folder to the Hub.
• version: Print information about the hf version.

hf auth

Manage authentication (login, logout, etc.).

Usage:

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

Options:

• --help: Show this message and exit.

Commands:

• list: List all stored access tokens.
• login: Login using a token from…
• logout: Logout from a specific token.
• switch: Switch between access tokens.
• whoami: Find out which huggingface.co account you…

hf auth list

List all stored access tokens.

Usage:

$hf auth list [OPTIONS]

Options:

• --help: Show this message and exit.

Examples$ hf auth list

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf auth login

Login using a token from huggingface.co/settings/tokens.

Usage:

$hf auth login [OPTIONS]

Options:

• --token TEXT: A User Access Token generated fromhttps://huggingface.co/settings/tokens.
• --add-to-git-credential / --no-add-to-git-credential: Save to git credential helper. Useful only if you plan to run git commands directly. [default: no-add-to-git-credential]
• --help: Show this message and exit.

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

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf auth logout

Logout from a specific token.

Usage:

$hf authlogout [OPTIONS]

Options:

• --token-name TEXT: Name of token to logout
• --help: Show this message and exit.

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

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf auth switch

Switch between access tokens.

Usage:

$hf auth switch [OPTIONS]

Options:

• --token-name TEXT: Name of the token to switch to
• --add-to-git-credential / --no-add-to-git-credential: Save to git credential helper. Useful only if you plan to run git commands directly. [default: no-add-to-git-credential]
• --help: Show this message and exit.

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

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf auth whoami

Find out which huggingface.co account you are logged in as.

Usage:

$hf authwhoami [OPTIONS]

Options:

• --help: Show this message and exit.

Examples$ hf auth whoami

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf cache

Manage local cache directory.

Usage:

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

Options:

• --help: Show this message and exit.

Commands:

• ls: List cached repositories or revisions.
• prune: Remove detached revisions from the cache.
• rm: Remove cached repositories or revisions.
• verify: Verify checksums for a single repo…

hf cache ls

List cached repositories or revisions.

Usage:

$hf cachels [OPTIONS]

Options:

• --cache-dir TEXT: Cache directory to scan (defaults to Hugging Face cache).
• --revisions / --no-revisions: Include revisions in the output instead of aggregated repositories. [default: no-revisions]
• -f, --filter TEXT: Filter entries (e.g. ‘size>1GB’, ‘type=model’, ‘accessed>7d’). Can be used multiple times.
• --format [table|json]: Output format. [default: table]
• -q, --quiet: Print only IDs (repo IDs or revision hashes).
• --sort [accessed|accessed:asc|accessed:desc|modified|modified:asc|modified:desc|name|name:asc|name:desc|size|size:asc|size:desc]: Sort entries by key. Supported keys: ‘accessed’, ‘modified’, ‘name’, ‘size’. Append ‘:asc’ or ‘:desc’ to explicitly set the order (e.g., ‘modified:asc’). Defaults: ‘accessed’, ‘modified’, ‘size’ default to ‘desc’ (newest/biggest first); ‘name’ defaults to ‘asc’ (alphabetical).
• --limit INTEGER: Limit the number of results returned. Returns only the top N entries after sorting.
• --help: Show this message and exit.

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

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf cache prune

Remove detached revisions from the cache.

Usage:

$hf cache prune [OPTIONS]

Options:

• --cache-dir TEXT: Cache directory to scan (defaults to Hugging Face cache).
• -y, --yes: Skip confirmation prompt.
• --dry-run / --no-dry-run: Preview deletions without removing anything. [default: no-dry-run]
• --help: Show this message and exit.

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

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf cache rm

Remove cached repositories or revisions.

Usage:

$hf cacherm [OPTIONS] TARGETS...

Arguments:

• TARGETS...: One or more repo IDs (e.g. model/bert-base-uncased) or revision hashes to delete. [required]

Options:

• --cache-dir TEXT: Cache directory to scan (defaults to Hugging Face cache).
• -y, --yes: Skip confirmation prompt.
• --dry-run / --no-dry-run: Preview deletions without removing anything. [default: no-dry-run]
• --help: Show this message and exit.

Examples$ hf cache rm model/gpt2$ hf cache rm <revision_hash>$ hf cache rm model/gpt2 —dry-run$ hf cache rm model/gpt2 —yes

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf cache verify

Verify checksums for a single repo revision from cache or a local directory.

Examples:

• Verify main revision in cache:hf cache verify gpt2
• Verify specific revision:hf cache verify gpt2 --revision refs/pr/1
• Verify dataset:hf cache verify karpathy/fineweb-edu-100b-shuffle --repo-type dataset
• Verify local dir:hf cache verify deepseek-ai/DeepSeek-OCR --local-dir /path/to/repo

Usage:

$hf cache verify [OPTIONS] REPO_ID

Arguments:

• REPO_ID: The ID of the repo (e.g.username/repo-name). [required]

Options:

• --repo-type [model|dataset|space]: The type of repository (model, dataset, or space). [default: model]
• --revision TEXT: Git revision id which can be a branch name, a tag, or a commit hash.
• --cache-dir TEXT: Cache directory to use when verifying files from cache (defaults to Hugging Face cache).
• --local-dir TEXT: If set, verify files under this directory instead of the cache.
• --fail-on-missing-files: Fail if some files exist on the remote but are missing locally.
• --fail-on-extra-files: Fail if some files exist locally but are not present on the remote revision.
• --token TEXT: A User Access Token generated fromhttps://huggingface.co/settings/tokens.
• --help: Show this message and exit.

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

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf collections

Interact with collections on the Hub.

Usage:

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

Options:

• --help: Show this message and exit.

Commands:

• add-item: Add an item to a collection.
• create: Create a new collection on the Hub.
• delete: Delete a collection from the Hub.
• delete-item: Delete an item from a collection.
• info: Get info about a collection on the Hub.
• ls: List collections on the Hub.
• update: Update a collection’s metadata on the Hub.
• update-item: Update an item in a collection.

hf collections add-item

Add an item to a collection.

Usage:

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

Arguments:

• COLLECTION_SLUG: The collection slug (e.g., ‘username/collection-slug’). [required]
• ITEM_ID: The ID of the item to add (repo_id for repos, paper ID for papers). [required]
• ITEM_TYPE:{model|dataset|space|paper|collection}: The type of item (model, dataset, space, paper, or collection). [required]

Options:

• --note TEXT: A note to attach to the item (max 500 characters).
• --exists-ok / --no-exists-ok: Do not raise an error if the item is already in the collection. [default: no-exists-ok]
• --token TEXT: A User Access Token generated fromhttps://huggingface.co/settings/tokens.
• --help: Show this message and exit.

Examples$ 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

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf collections create

Create a new collection on the Hub.

Usage:

$hf collections create [OPTIONS] TITLE

Arguments:

• TITLE: The title of the collection. [required]

Options:

• --namespace TEXT: The namespace (username or organization). Defaults to the authenticated user.
• --description TEXT: A description for the collection.
• --private / --no-private: Create a private collection. [default: no-private]
• --exists-ok / --no-exists-ok: Do not raise an error if the collection already exists. [default: no-exists-ok]
• --token TEXT: A User Access Token generated fromhttps://huggingface.co/settings/tokens.
• --help: Show this message and exit.

Examples$ 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

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf collections delete

Delete a collection from the Hub.

Usage:

$hf collections delete [OPTIONS] COLLECTION_SLUG

Arguments:

• COLLECTION_SLUG: The collection slug (e.g., ‘username/collection-slug’). [required]

Options:

• --missing-ok / --no-missing-ok: Do not raise an error if the collection doesn’t exist. [default: no-missing-ok]
• --token TEXT: A User Access Token generated fromhttps://huggingface.co/settings/tokens.
• --help: Show this message and exit.

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

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf collections delete-item

Delete an item from a collection.

Usage:

$hf collections delete-item [OPTIONS] COLLECTION_SLUG ITEM_OBJECT_ID

Arguments:

• COLLECTION_SLUG: The collection slug (e.g., ‘username/collection-slug’). [required]
• ITEM_OBJECT_ID: The ID of the item in the collection (retrieved fromitem_object_id field returned by ‘hf collections info’. [required]

Options:

• --missing-ok / --no-missing-ok: Do not raise an error if the item doesn’t exist. [default: no-missing-ok]
• --token TEXT: A User Access Token generated fromhttps://huggingface.co/settings/tokens.
• --help: Show this message and exit.

hf collections info

Get info about a collection on the Hub.

Usage:

$hf collections info [OPTIONS] COLLECTION_SLUG

Arguments:

• COLLECTION_SLUG: The collection slug (e.g., ‘username/collection-slug’). [required]

Options:

• --token TEXT: A User Access Token generated fromhttps://huggingface.co/settings/tokens.
• --help: Show this message and exit.

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

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf collections ls

List collections on the Hub.

Usage:

$hf collectionsls [OPTIONS]

Options:

• --owner TEXT: Filter by owner username or organization.
• --item TEXT: Filter collections containing a specific item (e.g., “models/gpt2”, “datasets/squad”, “papers/2311.12983”).
• --sort [lastModified|trending|upvotes]: Sort results by last modified, trending, or upvotes.
• --limit INTEGER: Limit the number of results. [default: 10]
• --format [table|json]: Output format (table or json). [default: table]
• -q, --quiet: Print only IDs (one per line).
• --token TEXT: A User Access Token generated fromhttps://huggingface.co/settings/tokens.
• --help: Show this message and exit.

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

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf collections update

Update a collection’s metadata on the Hub.

Usage:

$hf collections update [OPTIONS] COLLECTION_SLUG

Arguments:

• COLLECTION_SLUG: The collection slug (e.g., ‘username/collection-slug’). [required]

Options:

• --title TEXT: The new title for the collection.
• --description TEXT: The new description for the collection.
• --position INTEGER: The new position of the collection in the owner’s list.
• --private / --no-private: Whether the collection should be private.
• --theme TEXT: The theme color for the collection (e.g., ‘green’, ‘blue’).
• --token TEXT: A User Access Token generated fromhttps://huggingface.co/settings/tokens.
• --help: Show this message and exit.

Examples$ 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

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf collections update-item

Update an item in a collection.

Usage:

$hf collections update-item [OPTIONS] COLLECTION_SLUG ITEM_OBJECT_ID

Arguments:

• COLLECTION_SLUG: The collection slug (e.g., ‘username/collection-slug’). [required]
• ITEM_OBJECT_ID: The ID of the item in the collection (from ‘item_object_id’ field, not the repo_id). [required]

Options:

• --note TEXT: A new note for the item (max 500 characters).
• --position INTEGER: The new position of the item in the collection.
• --token TEXT: A User Access Token generated fromhttps://huggingface.co/settings/tokens.
• --help: Show this message and exit.

Examples$ 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

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf datasets

Interact with datasets on the Hub.

Usage:

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

Options:

• --help: Show this message and exit.

Commands:

• info: Get info about a dataset on the Hub.
• ls: List datasets on the Hub.

hf datasets info

Get info about a dataset on the Hub.

Usage:

$hf datasets info [OPTIONS] DATASET_ID

Arguments:

• DATASET_ID: The dataset ID (e.g.username/repo-name). [required]

Options:

• --revision TEXT: Git revision id which can be a branch name, a tag, or a commit hash.
• --expand TEXT: Comma-separated properties to expand. Example: ‘—expand=downloads,likes,tags’. Valid: author, cardData, citation, createdAt, description, disabled, downloads, downloadsAllTime, gated, lastModified, likes, paperswithcode_id, private, resourceGroup, sha, siblings, tags, trendingScore, usedStorage.
• --token TEXT: A User Access Token generated fromhttps://huggingface.co/settings/tokens.
• --help: Show this message and exit.

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

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf datasets ls

List datasets on the Hub.

Usage:

$hf datasetsls [OPTIONS]

Options:

• --search TEXT: Search query.
• --author TEXT: Filter by author or organization.
• --filter TEXT: Filter by tags (e.g. ‘text-classification’). Can be used multiple times.
• --sort [created_at|downloads|last_modified|likes|trending_score]: Sort results.
• --limit INTEGER: Limit the number of results. [default: 10]
• --expand TEXT: Comma-separated properties to expand. Example: ‘—expand=downloads,likes,tags’. Valid: author, cardData, citation, createdAt, description, disabled, downloads, downloadsAllTime, gated, lastModified, likes, paperswithcode_id, private, resourceGroup, sha, siblings, tags, trendingScore, usedStorage.
• --format [table|json]: Output format (table or json). [default: table]
• -q, --quiet: Print only IDs (one per line).
• --token TEXT: A User Access Token generated fromhttps://huggingface.co/settings/tokens.
• --help: Show this message and exit.

Examples$ hf datasets ls$ hf datasets ls —sort downloads —limit 10$ hf datasets ls —search “code”

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf download

Download files from the Hub.

Usage:

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

Arguments:

• REPO_ID: The ID of the repo (e.g.username/repo-name). [required]
• [FILENAMES]...: Files to download (e.g.config.json,data/metadata.jsonl).

Options:

• --repo-type [model|dataset|space]: The type of repository (model, dataset, or space). [default: model]
• --revision TEXT: Git revision id which can be a branch name, a tag, or a commit hash.
• --include TEXT: Glob patterns to include from files to download. eg: *.json
• --exclude TEXT: Glob patterns to exclude from files to download.
• --cache-dir TEXT: Directory where to save files.
• --local-dir TEXT: If set, the downloaded file will be placed under this directory. Check outhttps://huggingface.co/docs/huggingface_hub/guides/download#download-files-to-a-local-folder for more details.
• --force-download / --no-force-download: If True, the files will be downloaded even if they are already cached. [default: no-force-download]
• --dry-run / --no-dry-run: If True, perform a dry run without actually downloading the file. [default: no-dry-run]
• --token TEXT: A User Access Token generated fromhttps://huggingface.co/settings/tokens.
• --quiet / --no-quiet: If True, progress bars are disabled and only the path to the download files is printed. [default: no-quiet]
• --max-workers INTEGER: Maximum number of workers to use for downloading files. Default is 8. [default: 8]
• --help: Show this message and exit.

Examples$ 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

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf endpoints

Manage Hugging Face Inference Endpoints.

Usage:

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

Options:

• --help: Show this message and exit.

Commands:

• catalog: Interact with the Inference Endpoints…
• delete: Delete an Inference Endpoint permanently.
• deploy: Deploy an Inference Endpoint from a Hub…
• describe: Get information about an existing endpoint.
• list-catalog: List available Catalog models.
• ls: Lists all Inference Endpoints for the…
• pause: Pause an Inference Endpoint.
• resume: Resume an Inference Endpoint.
• scale-to-zero: Scale an Inference Endpoint to zero.
• update: Update an existing endpoint.

hf endpoints catalog

Interact with the Inference Endpoints catalog.

Usage:

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

Options:

• --help: Show this message and exit.

Commands:

• deploy: Deploy an Inference Endpoint from the…
• ls: List available Catalog models.

hf endpoints catalog deploy

Deploy an Inference Endpoint from the Model Catalog.

Usage:

$hf endpoints catalog deploy [OPTIONS]

Options:

• --repo TEXT: The name of the model repository associated with the Inference Endpoint (e.g. ‘openai/gpt-oss-120b’). [required]
• --name TEXT: Endpoint name.
• --namespace TEXT: The namespace associated with the Inference Endpoint. Defaults to the current user’s namespace.
• --token TEXT: A User Access Token generated fromhttps://huggingface.co/settings/tokens.
• --help: Show this message and exit.

Examples$ hf endpoints catalog deploy —repo meta-llama/Llama-3.2-1B-Instruct

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf endpoints catalog ls

List available Catalog models.

Usage:

$hf endpoints catalogls [OPTIONS]

Options:

• --token TEXT: A User Access Token generated fromhttps://huggingface.co/settings/tokens.
• --help: Show this message and exit.

Examples$ hf endpoints catalog ls

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf endpoints delete

Delete an Inference Endpoint permanently.

Usage:

$hf endpoints delete [OPTIONS] NAME

Arguments:

• NAME: Endpoint name. [required]

Options:

• --namespace TEXT: The namespace associated with the Inference Endpoint. Defaults to the current user’s namespace.
• --yes: Skip confirmation prompts.
• --token TEXT: A User Access Token generated fromhttps://huggingface.co/settings/tokens.
• --help: Show this message and exit.

Examples$ hf endpoints delete my-endpoint

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf endpoints deploy

Deploy an Inference Endpoint from a Hub repository.

Usage:

$hf endpoints deploy [OPTIONS] NAME

Arguments:

• NAME: Endpoint name. [required]

Options:

• --repo TEXT: The name of the model repository associated with the Inference Endpoint (e.g. ‘openai/gpt-oss-120b’). [required]
• --framework TEXT: The machine learning framework used for the model (e.g. ‘vllm’). [required]
• --accelerator TEXT: The hardware accelerator to be used for inference (e.g. ‘cpu’). [required]
• --instance-size TEXT: The size or type of the instance to be used for hosting the model (e.g. ‘x4’). [required]
• --instance-type TEXT: The cloud instance type where the Inference Endpoint will be deployed (e.g. ‘intel-icl’). [required]
• --region TEXT: The cloud region in which the Inference Endpoint will be created (e.g. ‘us-east-1’). [required]
• --vendor TEXT: The cloud provider or vendor where the Inference Endpoint will be hosted (e.g. ‘aws’). [required]
• --namespace TEXT: The namespace associated with the Inference Endpoint. Defaults to the current user’s namespace.
• --task TEXT: The task on which to deploy the model (e.g. ‘text-classification’).
• --token TEXT: A User Access Token generated fromhttps://huggingface.co/settings/tokens.
• --min-replica INTEGER: The minimum number of replicas (instances) to keep running for the Inference Endpoint. [default: 1]
• --max-replica INTEGER: The maximum number of replicas (instances) to scale to for the Inference Endpoint. [default: 1]
• --scale-to-zero-timeout INTEGER: The duration in minutes before an inactive endpoint is scaled to zero.
• --scaling-metric [pendingRequests|hardwareUsage]: The metric reference for scaling.
• --scaling-threshold FLOAT: The scaling metric threshold used to trigger a scale up. Ignored when scaling metric is not provided.
• --help: Show this message and exit.

Examples$ hf endpoints deploy my-endpoint —repo gpt2 —framework pytorch …

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf endpoints describe

Get information about an existing endpoint.

Usage:

$hf endpoints describe [OPTIONS] NAME

Arguments:

• NAME: Endpoint name. [required]

Options:

• --namespace TEXT: The namespace associated with the Inference Endpoint. Defaults to the current user’s namespace.
• --token TEXT: A User Access Token generated fromhttps://huggingface.co/settings/tokens.
• --help: Show this message and exit.

Examples$ hf endpoints describe my-endpoint

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf endpoints list-catalog

List available Catalog models.

Usage:

$hf endpoints list-catalog [OPTIONS]

Options:

• --token TEXT: A User Access Token generated fromhttps://huggingface.co/settings/tokens.
• --help: Show this message and exit.

hf endpoints ls

Lists all Inference Endpoints for the given namespace.

Usage:

$hf endpointsls [OPTIONS]

Options:

• --namespace TEXT: The namespace associated with the Inference Endpoint. Defaults to the current user’s namespace.
• --format [table|json]: Output format (table or json). [default: table]
• -q, --quiet: Print only IDs (one per line).
• --token TEXT: A User Access Token generated fromhttps://huggingface.co/settings/tokens.
• --help: Show this message and exit.

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

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf endpoints pause

Pause an Inference Endpoint.

Usage:

$hf endpoints pause [OPTIONS] NAME

Arguments:

• NAME: Endpoint name. [required]

Options:

• --namespace TEXT: The namespace associated with the Inference Endpoint. Defaults to the current user’s namespace.
• --token TEXT: A User Access Token generated fromhttps://huggingface.co/settings/tokens.
• --help: Show this message and exit.

Examples$ hf endpoints pause my-endpoint

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf endpoints resume

Resume an Inference Endpoint.

Usage:

$hf endpoints resume [OPTIONS] NAME

Arguments:

• NAME: Endpoint name. [required]

Options:

• --namespace TEXT: The namespace associated with the Inference Endpoint. Defaults to the current user’s namespace.
• --fail-if-already-running: IfTrue, the method will raise an error if the Inference Endpoint is already running.
• --token TEXT: A User Access Token generated fromhttps://huggingface.co/settings/tokens.
• --help: Show this message and exit.

Examples$ hf endpoints resume my-endpoint

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf endpoints scale-to-zero

Scale an Inference Endpoint to zero.

Usage:

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

Arguments:

• NAME: Endpoint name. [required]

Options:

• --namespace TEXT: The namespace associated with the Inference Endpoint. Defaults to the current user’s namespace.
• --token TEXT: A User Access Token generated fromhttps://huggingface.co/settings/tokens.
• --help: Show this message and exit.

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

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf endpoints update

Update an existing endpoint.

Usage:

$hf endpoints update [OPTIONS] NAME

Arguments:

• NAME: Endpoint name. [required]

Options:

• --namespace TEXT: The namespace associated with the Inference Endpoint. Defaults to the current user’s namespace.
• --repo TEXT: The name of the model repository associated with the Inference Endpoint (e.g. ‘openai/gpt-oss-120b’).
• --accelerator TEXT: The hardware accelerator to be used for inference (e.g. ‘cpu’).
• --instance-size TEXT: The size or type of the instance to be used for hosting the model (e.g. ‘x4’).
• --instance-type TEXT: The cloud instance type where the Inference Endpoint will be deployed (e.g. ‘intel-icl’).
• --framework TEXT: The machine learning framework used for the model (e.g. ‘custom’).
• --revision TEXT: The specific model revision to deploy on the Inference Endpoint (e.g. ‘6c0e6080953db56375760c0471a8c5f2929baf11’).
• --task TEXT: The task on which to deploy the model (e.g. ‘text-classification’).
• --min-replica INTEGER: The minimum number of replicas (instances) to keep running for the Inference Endpoint.
• --max-replica INTEGER: The maximum number of replicas (instances) to scale to for the Inference Endpoint.
• --scale-to-zero-timeout INTEGER: The duration in minutes before an inactive endpoint is scaled to zero.
• --scaling-metric [pendingRequests|hardwareUsage]: The metric reference for scaling.
• --scaling-threshold FLOAT: The scaling metric threshold used to trigger a scale up. Ignored when scaling metric is not provided.
• --token TEXT: A User Access Token generated fromhttps://huggingface.co/settings/tokens.
• --help: Show this message and exit.

Examples$ hf endpoints update my-endpoint —min-replica 2

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf env

Print information about the environment.

Usage:

$hfenv [OPTIONS]

Options:

• --help: Show this message and exit.

hf jobs

Run and manage Jobs on the Hub.

Usage:

$hfjobs [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• cancel: Cancel a Job
• hardware: List available hardware options for Jobs
• inspect: Display detailed information on one or…
• logs: Fetch the logs of a Job
• ps: List Jobs.
• run: Run a Job.
• scheduled: Create and manage scheduled Jobs on the Hub.
• stats: Fetch the resource usage statistics and…
• uv: Run UV scripts (Python with inline…

hf jobs cancel

Cancel a Job

Usage:

$hfjobs cancel [OPTIONS] JOB_ID

Arguments:

• JOB_ID: Job ID [required]

Options:

• --namespace TEXT: The namespace where the job will be running. Defaults to the current user’s namespace.
• --token TEXT: A User Access Token generated fromhttps://huggingface.co/settings/tokens.
• --help: Show this message and exit.

Examples$ hf jobs cancel <job_id>

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf jobs hardware

List available hardware options for Jobs

Usage:

$hfjobs hardware [OPTIONS]

Options:

• --help: Show this message and exit.

Examples$ hf jobs hardware

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf jobs inspect

Display detailed information on one or more Jobs

Usage:

$hfjobs inspect [OPTIONS] JOB_IDS...

Arguments:

• JOB_IDS...: The jobs to inspect [required]

Options:

• --namespace TEXT: The namespace where the job will be running. Defaults to the current user’s namespace.
• --token TEXT: A User Access Token generated fromhttps://huggingface.co/settings/tokens.
• --help: Show this message and exit.

Examples$ hf jobs inspect <job_id>

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf jobs logs

Fetch the logs of a Job

Usage:

$hfjobs logs [OPTIONS] JOB_ID

Arguments:

• JOB_ID: Job ID [required]

Options:

• --namespace TEXT: The namespace where the job will be running. Defaults to the current user’s namespace.
• --token TEXT: A User Access Token generated fromhttps://huggingface.co/settings/tokens.
• --help: Show this message and exit.

Examples$ hf jobs logs <job_id>

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf jobs ps

List Jobs.

Usage:

$hfjobs ps [OPTIONS]

Options:

• -a, --all: Show all Jobs (default shows just running)
• --namespace TEXT: The namespace where the job will be running. Defaults to the current user’s namespace.
• --token TEXT: A User Access Token generated fromhttps://huggingface.co/settings/tokens.
• -f, --filter TEXT: Filter output based on conditions provided (format: key=value)
• --format TEXT: Format output using a custom template
• --help: Show this message and exit.

Examples$ hf jobs ps$ hf jobs ps -a

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf jobs run

Run a Job.

Usage:

$hfjobs run [OPTIONS] IMAGE COMMAND...

Arguments:

• IMAGE: The Docker image to use. [required]
• COMMAND...: The command to run. [required]

Options:

• -e, --env TEXT: Set environment variables. E.g. —env ENV=value
• -s, --secrets TEXT: Set secret environment variables. E.g. —secrets SECRET=value or--secrets HF_TOKEN to pass your Hugging Face token.
• -l, --label TEXT: Set labels. E.g. —label KEY=VALUE or —label LABEL
• --env-file TEXT: Read in a file of environment variables.
• --secrets-file TEXT: Read in a file of secret environment variables.
• --flavor [cpu-basic|cpu-upgrade|cpu-xl|zero-a10g|t4-small|t4-medium|l4x1|l4x4|l40sx1|l40sx4|l40sx8|a10g-small|a10g-large|a10g-largex2|a10g-largex4|a100-large|a100x4|a100x8]: Flavor for the hardware, as in HF Spaces. Run ‘hf jobs hardware’ to list available flavors. Defaults tocpu-basic.
• --timeout TEXT: Max duration: int/float with s (seconds, default), m (minutes), h (hours) or d (days).
• -d, --detach: Run the Job in the background and print the Job ID.
• --namespace TEXT: The namespace where the job will be running. Defaults to the current user’s namespace.
• --token TEXT: A User Access Token generated fromhttps://huggingface.co/settings/tokens.
• --help: Show this message and exit.

Examples$ hf jobs run python:3.12 python -c ‘print(“Hello!”)’$ hf jobs run -e FOO=foo python:3.12 python script.py$ hf jobs run —secrets HF_TOKEN python:3.12 python script.py

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf jobs scheduled

Create and manage scheduled Jobs on the Hub.

Usage:

$hfjobs scheduled [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• delete: Delete a scheduled Job.
• inspect: Display detailed information on one or…
• ps: List scheduled Jobs
• resume: Resume (unpause) a scheduled Job.
• run: Schedule a Job.
• suspend: Suspend (pause) a scheduled Job.
• uv: Schedule UV scripts on HF infrastructure.

hf jobs scheduled delete

Delete a scheduled Job.

Usage:

$hfjobs scheduled delete [OPTIONS] SCHEDULED_JOB_ID

Arguments:

• SCHEDULED_JOB_ID: Scheduled Job ID [required]

Options:

• --namespace TEXT: The namespace where the job will be running. Defaults to the current user’s namespace.
• --token TEXT: A User Access Token generated fromhttps://huggingface.co/settings/tokens.
• --help: Show this message and exit.

Examples$ hf jobs scheduled delete <id>

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf jobs scheduled inspect

Display detailed information on one or more scheduled Jobs

Usage:

$hfjobs scheduled inspect [OPTIONS] SCHEDULED_JOB_IDS...

Arguments:

• SCHEDULED_JOB_IDS...: The scheduled jobs to inspect [required]

Options:

• --namespace TEXT: The namespace where the job will be running. Defaults to the current user’s namespace.
• --token TEXT: A User Access Token generated fromhttps://huggingface.co/settings/tokens.
• --help: Show this message and exit.

Examples$ hf jobs scheduled inspect <id>

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf jobs scheduled ps

List scheduled Jobs

Usage:

$hfjobs scheduled ps [OPTIONS]

Options:

• -a, --all: Show all scheduled Jobs (default hides suspended)
• --namespace TEXT: The namespace where the job will be running. Defaults to the current user’s namespace.
• --token TEXT: A User Access Token generated fromhttps://huggingface.co/settings/tokens.
• -f, --filter TEXT: Filter output based on conditions provided (format: key=value)
• --format TEXT: Format output using a custom template
• --help: Show this message and exit.

Examples$ hf jobs scheduled ps

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf jobs scheduled resume

Resume (unpause) a scheduled Job.

Usage:

$hfjobs scheduled resume [OPTIONS] SCHEDULED_JOB_ID

Arguments:

• SCHEDULED_JOB_ID: Scheduled Job ID [required]

Options:

• --namespace TEXT: The namespace where the job will be running. Defaults to the current user’s namespace.
• --token TEXT: A User Access Token generated fromhttps://huggingface.co/settings/tokens.
• --help: Show this message and exit.

Examples$ hf jobs scheduled resume <id>

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf jobs scheduled run

Schedule a Job.

Usage:

$hfjobs scheduled run [OPTIONS] SCHEDULE IMAGE COMMAND...

Arguments:

• SCHEDULE: One of annually, yearly, monthly, weekly, daily, hourly, or a CRON schedule expression. [required]
• IMAGE: The Docker image to use. [required]
• COMMAND...: The command to run. [required]

Options:

• --suspend / --no-suspend: Suspend (pause) the scheduled Job
• --concurrency / --no-concurrency: Allow multiple instances of this Job to run concurrently
• -e, --env TEXT: Set environment variables. E.g. —env ENV=value
• -s, --secrets TEXT: Set secret environment variables. E.g. —secrets SECRET=value or--secrets HF_TOKEN to pass your Hugging Face token.
• -l, --label TEXT: Set labels. E.g. —label KEY=VALUE or —label LABEL
• --env-file TEXT: Read in a file of environment variables.
• --secrets-file TEXT: Read in a file of secret environment variables.
• --flavor [cpu-basic|cpu-upgrade|cpu-xl|zero-a10g|t4-small|t4-medium|l4x1|l4x4|l40sx1|l40sx4|l40sx8|a10g-small|a10g-large|a10g-largex2|a10g-largex4|a100-large|a100x4|a100x8]: Flavor for the hardware, as in HF Spaces. Run ‘hf jobs hardware’ to list available flavors. Defaults tocpu-basic.
• --timeout TEXT: Max duration: int/float with s (seconds, default), m (minutes), h (hours) or d (days).
• --namespace TEXT: The namespace where the job will be running. Defaults to the current user’s namespace.
• --token TEXT: A User Access Token generated fromhttps://huggingface.co/settings/tokens.
• --help: Show this message and exit.

Examples$ hf jobs scheduled run “0 0 * * *” python:3.12 python script.py

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf jobs scheduled suspend

Suspend (pause) a scheduled Job.

Usage:

$hfjobs scheduledsuspend [OPTIONS] SCHEDULED_JOB_ID

Arguments:

• SCHEDULED_JOB_ID: Scheduled Job ID [required]

Options:

• --namespace TEXT: The namespace where the job will be running. Defaults to the current user’s namespace.
• --token TEXT: A User Access Token generated fromhttps://huggingface.co/settings/tokens.
• --help: Show this message and exit.

Examples$ hf jobs scheduled suspend <id>

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf jobs scheduled uv

Schedule UV scripts on HF infrastructure.

Usage:

$hfjobs scheduled uv [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• run: Run a UV script (local file or URL) on HF…

hf jobs scheduled uv run

Run a UV script (local file or URL) on HF infrastructure

Usage:

$hfjobs scheduled uv run [OPTIONS] SCHEDULE SCRIPT [SCRIPT_ARGS]...

Arguments:

• SCHEDULE: One of annually, yearly, monthly, weekly, daily, hourly, or a CRON schedule expression. [required]
• SCRIPT: UV script to run (local file or URL) [required]
• [SCRIPT_ARGS]...: Arguments for the script

Options:

• --suspend / --no-suspend: Suspend (pause) the scheduled Job
• --concurrency / --no-concurrency: Allow multiple instances of this Job to run concurrently
• --image TEXT: Use a custom Docker image withuv installed.
• --flavor [cpu-basic|cpu-upgrade|cpu-xl|zero-a10g|t4-small|t4-medium|l4x1|l4x4|l40sx1|l40sx4|l40sx8|a10g-small|a10g-large|a10g-largex2|a10g-largex4|a100-large|a100x4|a100x8]: Flavor for the hardware, as in HF Spaces. Run ‘hf jobs hardware’ to list available flavors. Defaults tocpu-basic.
• -e, --env TEXT: Set environment variables. E.g. —env ENV=value
• -s, --secrets TEXT: Set secret environment variables. E.g. —secrets SECRET=value or--secrets HF_TOKEN to pass your Hugging Face token.
• -l, --label TEXT: Set labels. E.g. —label KEY=VALUE or —label LABEL
• --env-file TEXT: Read in a file of environment variables.
• --secrets-file TEXT: Read in a file of secret environment variables.
• --timeout TEXT: Max duration: int/float with s (seconds, default), m (minutes), h (hours) or d (days).
• --namespace TEXT: The namespace where the job will be running. Defaults to the current user’s namespace.
• --token TEXT: A User Access Token generated fromhttps://huggingface.co/settings/tokens.
• --with TEXT: Run with the given packages installed
• -p, --python TEXT: The Python interpreter to use for the run environment
• --help: Show this message and exit.

Examples$ hf jobs scheduled uv run “0 0 * *” script.py$ hf jobs scheduled uv run “0 0 * *” script.py —with pandas

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf jobs stats

Fetch the resource usage statistics and metrics of Jobs

Usage:

$hfjobs stats [OPTIONS] [JOB_IDS]...

Arguments:

• [JOB_IDS]...: Job IDs

Options:

• --namespace TEXT: The namespace where the job will be running. Defaults to the current user’s namespace.
• --token TEXT: A User Access Token generated fromhttps://huggingface.co/settings/tokens.
• --help: Show this message and exit.

Examples$ hf jobs stats <job_id>

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf jobs uv

Run UV scripts (Python with inline dependencies) on HF infrastructure.

Usage:

$hfjobs uv [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• run: Run a UV script (local file or URL) on HF…

hf jobs uv run

Run a UV script (local file or URL) on HF infrastructure

Usage:

$hfjobs uv run [OPTIONS] SCRIPT [SCRIPT_ARGS]...

Arguments:

• SCRIPT: UV script to run (local file or URL) [required]
• [SCRIPT_ARGS]...: Arguments for the script

Options:

• --image TEXT: Use a custom Docker image withuv installed.
• --flavor [cpu-basic|cpu-upgrade|cpu-xl|zero-a10g|t4-small|t4-medium|l4x1|l4x4|l40sx1|l40sx4|l40sx8|a10g-small|a10g-large|a10g-largex2|a10g-largex4|a100-large|a100x4|a100x8]: Flavor for the hardware, as in HF Spaces. Run ‘hf jobs hardware’ to list available flavors. Defaults tocpu-basic.
• -e, --env TEXT: Set environment variables. E.g. —env ENV=value
• -s, --secrets TEXT: Set secret environment variables. E.g. —secrets SECRET=value or--secrets HF_TOKEN to pass your Hugging Face token.
• -l, --label TEXT: Set labels. E.g. —label KEY=VALUE or —label LABEL
• --env-file TEXT: Read in a file of environment variables.
• --secrets-file TEXT: Read in a file of secret environment variables.
• --timeout TEXT: Max duration: int/float with s (seconds, default), m (minutes), h (hours) or d (days).
• -d, --detach: Run the Job in the background and print the Job ID.
• --namespace TEXT: The namespace where the job will be running. Defaults to the current user’s namespace.
• --token TEXT: A User Access Token generated fromhttps://huggingface.co/settings/tokens.
• --with TEXT: Run with the given packages installed
• -p, --python TEXT: The Python interpreter to use for the run environment
• --help: Show this message and exit.

Examples$ hf jobs uv run my_script.py$ hf jobs uv run ml_training.py —flavor a10g-small$ hf jobs uv run —with transformers train.py

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf lfs-enable-largefiles

Configure your repository to enable upload of files > 5GB.

This command sets up git-lfs to use the custom multipart transfer agentwhich enables efficient uploading of large files in chunks.

Usage:

$hf lfs-enable-largefiles [OPTIONS] PATH

Arguments:

• PATH: Local path to repository you want to configure. [required]

Options:

• --help: Show this message and exit.

hf lfs-multipart-upload

Internal git-lfs custom transfer agent for multipart uploads.

This function implements the custom transfer protocol for git-lfs multipart uploads.Handles chunked uploads of large files to Hugging Face Hub.

Usage:

$hf lfs-multipart-upload [OPTIONS]

Options:

• --help: Show this message and exit.

hf models

Interact with models on the Hub.

Usage:

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

Options:

• --help: Show this message and exit.

Commands:

• info: Get info about a model on the Hub.
• ls: List models on the Hub.

hf models info

Get info about a model on the Hub.

Usage:

$hf models info [OPTIONS] MODEL_ID

Arguments:

• MODEL_ID: The model ID (e.g.username/repo-name). [required]

Options:

• --revision TEXT: Git revision id which can be a branch name, a tag, or a commit hash.
• --expand TEXT: Comma-separated properties to expand. Example: ‘—expand=downloads,likes,tags’. Valid: 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: A User Access Token generated fromhttps://huggingface.co/settings/tokens.
• --help: Show this message and exit.

Examples$ hf models info meta-llama/Llama-3.2-1B-Instruct$ hf models info gpt2 —expand downloads,likes,tags

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf models ls

List models on the Hub.

Usage:

$hf modelsls [OPTIONS]

Options:

• --search TEXT: Search query.
• --author TEXT: Filter by author or organization.
• --filter TEXT: Filter by tags (e.g. ‘text-classification’). Can be used multiple times.
• --sort [created_at|downloads|last_modified|likes|trending_score]: Sort results.
• --limit INTEGER: Limit the number of results. [default: 10]
• --expand TEXT: Comma-separated properties to expand. Example: ‘—expand=downloads,likes,tags’. Valid: 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.
• --format [table|json]: Output format (table or json). [default: table]
• -q, --quiet: Print only IDs (one per line).
• --token TEXT: A User Access Token generated fromhttps://huggingface.co/settings/tokens.
• --help: Show this message and exit.

Examples$ hf models ls —sort downloads —limit 10$ hf models ls —search “llama” —author meta-llama

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf papers

Interact with papers on the Hub.

Usage:

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

Options:

• --help: Show this message and exit.

Commands:

• ls: List daily papers on the Hub.

hf papers ls

List daily papers on the Hub.

Usage:

$hf papersls [OPTIONS]

Options:

• --date TEXT: Date in ISO format (YYYY-MM-DD) or ‘today’.
• --sort [publishedAt|trending]: Sort results.
• --limit INTEGER: Limit the number of results. [default: 50]
• --token TEXT: A User Access Token generated fromhttps://huggingface.co/settings/tokens.
• --help: Show this message and exit.

Examples$ hf papers ls$ hf papers ls —sort trending$ hf papers ls —date 2025-01-23

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf repo

Manage repos on the Hub.

Usage:

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

Options:

• --help: Show this message and exit.

Commands:

• branch: Manage branches for a repo on the Hub.
• create: Create a new repo on the Hub.
• delete: Delete a repo from the Hub.
• move: Move a repository from a namespace to…
• settings: Update the settings of a repository.
• tag: Manage tags for a repo on the Hub.

hf repo branch

Manage branches for a repo on the Hub.

Usage:

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

Options:

• --help: Show this message and exit.

Commands:

• create: Create a new branch for a repo on the Hub.
• delete: Delete a branch from a repo on the Hub.

hf repo branch create

Create a new branch for a repo on the Hub.

Usage:

$hf repo branch create [OPTIONS] REPO_ID BRANCH

Arguments:

• REPO_ID: The ID of the repo (e.g.username/repo-name). [required]
• BRANCH: The name of the branch to create. [required]

Options:

• --revision TEXT: Git revision id which can be a branch name, a tag, or a commit hash.
• --token TEXT: A User Access Token generated fromhttps://huggingface.co/settings/tokens.
• --repo-type [model|dataset|space]: The type of repository (model, dataset, or space). [default: model]
• --exist-ok / --no-exist-ok: If set to True, do not raise an error if branch already exists. [default: no-exist-ok]
• --help: Show this message and exit.

Examples$ hf repo branch create my-model dev$ hf repo branch create my-model dev —revision abc123

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf repo branch delete

Delete a branch from a repo on the Hub.

Usage:

$hf repo branch delete [OPTIONS] REPO_ID BRANCH

Arguments:

• REPO_ID: The ID of the repo (e.g.username/repo-name). [required]
• BRANCH: The name of the branch to delete. [required]

Options:

• --token TEXT: A User Access Token generated fromhttps://huggingface.co/settings/tokens.
• --repo-type [model|dataset|space]: The type of repository (model, dataset, or space). [default: model]
• --help: Show this message and exit.

Examples$ hf repo branch delete my-model dev

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf repo create

Create a new repo on the Hub.

Usage:

$hf repo create [OPTIONS] REPO_ID

Arguments:

• REPO_ID: The ID of the repo (e.g.username/repo-name). [required]

Options:

• --repo-type [model|dataset|space]: The type of repository (model, dataset, or space). [default: model]
• --space-sdk TEXT: Hugging Face Spaces SDK type. Required when —type is set to ‘space’.
• --private / --no-private: Whether to create a private repo if repo doesn’t exist on the Hub. Ignored if the repo already exists.
• --token TEXT: A User Access Token generated fromhttps://huggingface.co/settings/tokens.
• --exist-ok / --no-exist-ok: Do not raise an error if repo already exists. [default: no-exist-ok]
• --resource-group-id TEXT: Resource group in which to create the repo. Resource groups is only available for Enterprise Hub organizations.
• --help: Show this message and exit.

Examples$ hf repo create my-model$ hf repo create my-dataset —repo-type dataset —private

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf repo delete

Delete a repo from the Hub. This is an irreversible operation.

Usage:

$hf repo delete [OPTIONS] REPO_ID

Arguments:

• REPO_ID: The ID of the repo (e.g.username/repo-name). [required]

Options:

• --repo-type [model|dataset|space]: The type of repository (model, dataset, or space). [default: model]
• --token TEXT: A User Access Token generated fromhttps://huggingface.co/settings/tokens.
• --missing-ok / --no-missing-ok: If set to True, do not raise an error if repo does not exist. [default: no-missing-ok]
• --help: Show this message and exit.

Examples$ hf repo delete my-model

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf repo move

Move a repository from a namespace to another namespace.

Usage:

$hf repo move [OPTIONS] FROM_ID TO_ID

Arguments:

• FROM_ID: The ID of the repo (e.g.username/repo-name). [required]
• TO_ID: The ID of the repo (e.g.username/repo-name). [required]

Options:

• --token TEXT: A User Access Token generated fromhttps://huggingface.co/settings/tokens.
• --repo-type [model|dataset|space]: The type of repository (model, dataset, or space). [default: model]
• --help: Show this message and exit.

Examples$ hf repo move old-namespace/my-model new-namespace/my-model

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf repo settings

Update the settings of a repository.

Usage:

$hf repo settings [OPTIONS] REPO_ID

Arguments:

• REPO_ID: The ID of the repo (e.g.username/repo-name). [required]

Options:

• --gated [auto|manual|false]: The gated status for the repository.
• --private / --no-private: Whether the repository should be private.
• --token TEXT: A User Access Token generated fromhttps://huggingface.co/settings/tokens.
• --repo-type [model|dataset|space]: The type of repository (model, dataset, or space). [default: model]
• --help: Show this message and exit.

Examples$ hf repo settings my-model —private$ hf repo settings my-model —gated auto

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf repo tag

Manage tags for a repo on the Hub.

Usage:

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

Options:

• --help: Show this message and exit.

Commands:

• create: Create a tag for a repo.
• delete: Delete a tag for a repo.
• list: List tags for a repo.

hf repo tag create

Create a tag for a repo.

Usage:

$hf repo tag create [OPTIONS] REPO_ID TAG

Arguments:

• REPO_ID: The ID of the repo (e.g.username/repo-name). [required]
• TAG: The name of the tag to create. [required]

Options:

• -m, --message TEXT: The description of the tag to create.
• --revision TEXT: Git revision id which can be a branch name, a tag, or a commit hash.
• --token TEXT: A User Access Token generated fromhttps://huggingface.co/settings/tokens.
• --repo-type [model|dataset|space]: The type of repository (model, dataset, or space). [default: model]
• --help: Show this message and exit.

Examples$ hf repo tag create my-model v1.0$ hf repo tag create my-model v1.0 -m “First release”

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf repo tag delete

Delete a tag for a repo.

Usage:

$hf repo tag delete [OPTIONS] REPO_ID TAG

Arguments:

• REPO_ID: The ID of the repo (e.g.username/repo-name). [required]
• TAG: The name of the tag to delete. [required]

Options:

• -y, --yes: Answer Yes to prompt automatically
• --token TEXT: A User Access Token generated fromhttps://huggingface.co/settings/tokens.
• --repo-type [model|dataset|space]: The type of repository (model, dataset, or space). [default: model]
• --help: Show this message and exit.

Examples$ hf repo tag delete my-model v1.0

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf repo tag list

List tags for a repo.

Usage:

$hf repo tag list [OPTIONS] REPO_ID

Arguments:

• REPO_ID: The ID of the repo (e.g.username/repo-name). [required]

Options:

• --token TEXT: A User Access Token generated fromhttps://huggingface.co/settings/tokens.
• --repo-type [model|dataset|space]: The type of repository (model, dataset, or space). [default: model]
• --help: Show this message and exit.

Examples$ hf repo tag list my-model

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf repo-files

Manage files in a repo on the Hub.

Usage:

$hf repo-files [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• delete

hf repo-files delete

Usage:

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

Arguments:

• REPO_ID: The ID of the repo (e.g.username/repo-name). [required]
• PATTERNS...: Glob patterns to match files to delete. Based on fnmatch, ’*’ matches files recursively. [required]

Options:

• --repo-type [model|dataset|space]: The type of repository (model, dataset, or space). [default: model]
• --revision TEXT: Git revision id which can be a branch name, a tag, or a commit hash.
• --commit-message TEXT: The summary / title / first line of the generated commit.
• --commit-description TEXT: The description of the generated commit.
• --create-pr / --no-create-pr: Whether to create a new Pull Request for these changes. [default: no-create-pr]
• --token TEXT: A User Access Token generated fromhttps://huggingface.co/settings/tokens.
• --help: Show this message and exit.

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

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf skills

Manage skills for AI assistants.

Usage:

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

Options:

• --help: Show this message and exit.

Commands:

• add: Download a skill and install it for an AI…

hf skills add

Download a skill and install it for an AI assistant.

Usage:

$hf skills add [OPTIONS]

Options:

• --claude: Install for Claude.
• --codex: Install for Codex.
• --opencode: Install for OpenCode.
• -g, --global: Install globally (user-level) instead of in the current project directory.
• --dest PATH: Install into a custom destination (path to skills directory).
• --force: Overwrite existing skills in the destination.
• --help: Show this message and exit.

Examples$ hf skills add —claude$ hf skills add —claude —global$ hf skills add —codex —opencode

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf spaces

Interact with spaces on the Hub.

Usage:

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

Options:

• --help: Show this message and exit.

Commands:

• info: Get info about a space on the Hub.
• ls: List spaces on the Hub.

hf spaces info

Get info about a space on the Hub.

Usage:

$hf spaces info [OPTIONS] SPACE_ID

Arguments:

• SPACE_ID: The space ID (e.g.username/repo-name). [required]

Options:

• --revision TEXT: Git revision id which can be a branch name, a tag, or a commit hash.
• --expand TEXT: Comma-separated properties to expand. Example: ‘—expand=likes,tags’. Valid: author, cardData, createdAt, datasets, disabled, lastModified, likes, models, private, resourceGroup, runtime, sdk, sha, siblings, subdomain, tags, trendingScore, usedStorage.
• --token TEXT: A User Access Token generated fromhttps://huggingface.co/settings/tokens.
• --help: Show this message and exit.

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

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf spaces ls

List spaces on the Hub.

Usage:

$hf spacesls [OPTIONS]

Options:

• --search TEXT: Search query.
• --author TEXT: Filter by author or organization.
• --filter TEXT: Filter by tags (e.g. ‘text-classification’). Can be used multiple times.
• --sort [created_at|last_modified|likes|trending_score]: Sort results.
• --limit INTEGER: Limit the number of results. [default: 10]
• --expand TEXT: Comma-separated properties to expand. Example: ‘—expand=likes,tags’. Valid: author, cardData, createdAt, datasets, disabled, lastModified, likes, models, private, resourceGroup, runtime, sdk, sha, siblings, subdomain, tags, trendingScore, usedStorage.
• --format [table|json]: Output format (table or json). [default: table]
• -q, --quiet: Print only IDs (one per line).
• --token TEXT: A User Access Token generated fromhttps://huggingface.co/settings/tokens.
• --help: Show this message and exit.

Examples$ hf spaces ls —limit 10$ hf spaces ls —search “chatbot” —author huggingface

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf upload

Upload a file or a folder to the Hub. Recommended for single-commit uploads.

Usage:

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

Arguments:

• REPO_ID: The ID of the repo (e.g.username/repo-name). [required]
• [LOCAL_PATH]: Local path to the file or folder to upload. Wildcard patterns are supported. Defaults to current directory.
• [PATH_IN_REPO]: Path of the file or folder in the repo. Defaults to the relative path of the file or folder.

Options:

• --repo-type [model|dataset|space]: The type of repository (model, dataset, or space). [default: model]
• --revision TEXT: Git revision id which can be a branch name, a tag, or a commit hash.
• --private / --no-private: Whether to create a private repo if repo doesn’t exist on the Hub. Ignored if the repo already exists.
• --include TEXT: Glob patterns to match files to upload.
• --exclude TEXT: Glob patterns to exclude from files to upload.
• --delete TEXT: Glob patterns for file to be deleted from the repo while committing.
• --commit-message TEXT: The summary / title / first line of the generated commit.
• --commit-description TEXT: The description of the generated commit.
• --create-pr / --no-create-pr: Whether to upload content as a new Pull Request. [default: no-create-pr]
• --every FLOAT: f set, a background job is scheduled to create commits everyevery minutes.
• --token TEXT: A User Access Token generated fromhttps://huggingface.co/settings/tokens.
• --quiet / --no-quiet: Disable progress bars and warnings; print only the returned path. [default: no-quiet]
• --help: Show this message and exit.

Examples$ 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

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf upload-large-folder

Upload a large folder to the Hub. Recommended for resumable uploads.

Usage:

$hf upload-large-folder [OPTIONS] REPO_ID LOCAL_PATH

Arguments:

• REPO_ID: The ID of the repo (e.g.username/repo-name). [required]
• LOCAL_PATH: Local path to the folder to upload. [required]

Options:

• --repo-type [model|dataset|space]: The type of repository (model, dataset, or space). [default: model]
• --revision TEXT: Git revision id which can be a branch name, a tag, or a commit hash.
• --private / --no-private: Whether to create a private repo if repo doesn’t exist on the Hub. Ignored if the repo already exists.
• --include TEXT: Glob patterns to match files to upload.
• --exclude TEXT: Glob patterns to exclude from files to upload.
• --token TEXT: A User Access Token generated fromhttps://huggingface.co/settings/tokens.
• --num-workers INTEGER: Number of workers to use to hash, upload and commit files.
• --no-report / --no-no-report: Whether to disable regular status report. [default: no-no-report]
• --no-bars / --no-no-bars: Whether to disable progress bars. [default: no-no-bars]
• --help: Show this message and exit.

Examples$ hf upload-large-folder Wauplin/my-cool-model ./large_model_dir$ hf upload-large-folder Wauplin/my-cool-model ./large_model_dir —revision v1.0

Learn moreUsehf <command> --help for more information about a command.Read the documentation athttps://huggingface.co/docs/huggingface_hub/en/guides/cli

hf version

Print information about the hf version.

Usage:

$hf version [OPTIONS]

Options:

• --help: Show this message and exit.