Files
hfd/hfdocs.context
2026-04-09 11:33:20 -07:00

66 lines
3.4 KiB
Plaintext
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
Output of hf --help:
usage: hf <command> [<args>]
positional arguments:
{auth,cache,download,jobs,repo,repo-files,upload,upload-large-folder,env,version,lfs-enable-largefiles,lfs-multipart-upload}
hf command helpers
auth Manage authentication (login, logout, etc.).
cache Manage local cache directory.
download Download files from the Hub
jobs Run and manage Jobs on the Hub.
repo Manage repos on the Hub.
repo-files Manage files in a repo on the Hub.
upload Upload a file or a folder to the Hub. Recommended for single-commit uploads.
upload-large-folder
Upload a large folder to the Hub. Recommended for resumable uploads.
env Print information about the environment.
version Print information about the hf version.
options:
-h, --help show this help message and exit
hf auth --help
usage: hf <command> [<args>] auth [-h] {login,logout,whoami,switch,list} ...
positional arguments:
{login,logout,whoami,switch,list}
Authentication subcommands
login Log in using a token from huggingface.co/settings/tokens
logout Log out
whoami Find out which huggingface.co account you are logged in as.
switch Switch between access tokens
list List all stored access tokens
options:
-h, --help show this help message and exit
hf download --help
usage: hf <command> [<args>] download [-h] [--repo-type {model,dataset,space}] [--revision REVISION] [--include [INCLUDE ...]] [--exclude [EXCLUDE ...]] [--cache-dir CACHE_DIR]
[--local-dir LOCAL_DIR] [--force-download] [--token TOKEN] [--quiet] [--max-workers MAX_WORKERS]
repo_id [filenames ...]
positional arguments:
repo_id ID of the repo to download from (e.g. `username/repo-name`).
filenames Files to download (e.g. `config.json`, `data/metadata.jsonl`).
options:
-h, --help show this help message and exit
--repo-type {model,dataset,space}
Type of repo to download from (defaults to 'model').
--revision REVISION An optional Git revision id which can be a branch name, a tag, or a commit hash.
--include [INCLUDE ...]
Glob patterns to match files to download.
--exclude [EXCLUDE ...]
Glob patterns to exclude from files to download.
--cache-dir CACHE_DIR
Path to the directory where to save the downloaded files.
--local-dir LOCAL_DIR
If set, the downloaded file will be placed under this directory. Check out https://huggingface.co/docs/huggingface_hub/guides/download#download-files-to-local-
folder for more details.
--force-download If True, the files will be downloaded even if they are already cached.
--token TOKEN A User Access Token generated from https://huggingface.co/settings/tokens
--quiet If True, progress bars are disabled and only the path to the download files is printed.
--max-workers MAX_WORKERS
Maximum number of workers to use for downloading files. Default is 8.