# AVISO # Este arquivo inteiro foi gerado a partir da implementação da CLI `hf`. # Para regenerar o código, execute `make style` ou `python ./utils/generate_cli_reference.py --update`. # AVISO --> # `hf` CLI do Hugging Face Hub **Uso**: ```console $ hf [OPTIONS] [COMMAND] [ARGS]... ``` **Opções**: * `--skills`: Imprime o `hf-cli` SKILL.md no stdout (alias para `hf skills preview`). * `--install-completion`: Instala a conclusão para o shell atual. * `--show-completion`: Exibe a conclusão para o shell atual, para copiá-la ou personalizar a instalação. * `--help`: Exibe esta mensagem e sai. **Comandos**: * `auth`: Gerencia a autenticação (login, logout, etc.). * `buckets`: Comandos para interagir com buckets. * `cache`: Gerencia o diretório de cache local. * `collections`: Interaja com coleções no Hub. * `cp`: Copia arquivos entre caminhos locais, repositórios e buckets. * `datasets`: Interaja com conjuntos de dados no Hub. * `discussions`: Gerencie discussões e pull requests no Hub. * `download`: Baixe arquivos do Hub. * `endpoints`: Gerencia Hugging Face Inference Endpoints. * `env`: Imprime informações sobre o ambiente. * `extensions`: Gerencia extensões do CLI hf. [alias: ext] * `jobs`: Execute e gerencie Jobs no Hub. * `lfs-enable-largefiles`: Configure seu repositório para permitir o upload de arquivos > 5GB. * `lfs-multipart-upload`: Agente de transferência personalizado do git-lfs para uploads multipart. * `models`: Interaja com modelos no Hub. * `papers`: Interaja com os papers no Hub. * `repos`: Gerencia repositórios no Hub. * `sandbox`: Execute e gerencie sandboxes experimentais no Hugging Face Jobs. * `skills`: Gerencie habilidades para assistentes de IA. * `spaces`: Interaja com os espaços no Hub. * `sync`: Sincroniza arquivos entre o diretório local e um bucket. * `update`: Atualize o CLI `hf` para a versão mais recente. * `upload`: Envie um arquivo ou uma pasta para o Hub. * `version`: Imprime informações sobre a versão do hf. * `webhooks`: Gerencie webhooks no Hub. ## `hf auth` Gerenciar autenticação (login, logout, etc.). **Uso**: ```console $ hf auth [OPTIONS] COMMAND [ARGS]... ``` **Opções**: * `--help`: Exibe esta mensagem e sai. **Comandos**: * `list`: Lista todos os tokens de acesso armazenados. [alias: ls] * `login`: Inicie sessão pelo seu navegador ou usando um token de huggingface.co/settings/tokens. * `logout`: Desconecta de um token específico. * `switch`: Alterne entre tokens de acesso. * `token`: Imprime o token de acesso atual no stdout. * `whoami`: Descubra em qual conta do huggingface.co você está conectado. ### `hf auth list` Liste todos os tokens de acesso armazenados. [alias: ls] **Uso**: ```console $ hf auth list [OPTIONS] ``` **Opções**: * `--help`: Exibe esta mensagem e sai. Exemplos $ hf auth list Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf auth login` Faça login pelo seu navegador ou usando um token de huggingface.co/settings/tokens. **Uso**: ```console $ hf auth login [OPTIONS] ``` **Opções**: * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--add-to-git-credential / --no-add-to-git-credential`: Salva no git credential helper. Útil apenas se você planeja executar comandos git diretamente. [padrão: no-add-to-git-credential] * `--force / --no-force`: Força o re-login mesmo que já esteja conectado. [padrão: no-force] * `--help`: Exibe esta mensagem e sai. Exemplos $ hf auth login $ hf auth login --token $HF_TOKEN $ hf auth login --token $HF_TOKEN --add-to-git-credential $ hf auth login --force Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf auth logout` Desconecte-se de um token específico. **Uso**: ```console $ hf auth logout [OPTIONS] ``` **Opções**: * `--token-name TEXT`: Nome do token para fazer logout * `--help`: Exibe esta mensagem e sai. Exemplos $ hf auth logout $ hf auth logout --token-name my-token Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf auth switch` Alterne entre tokens de acesso. **Uso**: ```console $ hf auth switch [OPTIONS] ``` **Opções**: * `--token-name TEXT`: Nome do token para o qual alternar * `--add-to-git-credential / --no-add-to-git-credential`: Salva no git credential helper. Útil apenas se você planeja executar comandos git diretamente. [padrão: no-add-to-git-credential] * `--help`: Exibe esta mensagem e sai. Exemplos $ hf auth switch $ hf auth switch --token-name my-token Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf auth token` Imprima o token de acesso atual no stdout. **Uso**: ```console $ hf auth token [OPTIONS] ``` **Opções**: * `--help`: Exibe esta mensagem e sai. Exemplos $ hf auth token $ hf auth token | xargs curl -H 'Authorization: Bearer {}' Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf auth whoami` Descubra em qual conta do huggingface.co você está conectado. **Uso**: ```console $ hf auth whoami [OPTIONS] ``` **Opções**: * `--help`: Exibe esta mensagem e sai. Exemplos $ hf auth whoami $ hf auth whoami --format json Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ## `hf buckets` Comandos para interagir com buckets. **Uso**: ```console $ hf buckets [OPTIONS] COMMAND [ARGS]... ``` **Opções**: * `--help`: Exibe esta mensagem e sai. **Comandos**: * `cp`: Copia arquivos entre caminhos locais, repositórios e buckets. * `create`: Cria um novo bucket. * `delete`: Exclui um bucket. * `info`: Obter informações sobre um bucket. * `list`: Lista buckets ou arquivos em um bucket. [alias: ls] * `move`: Move (renomeia) um bucket para um novo nome ou namespace. * `remove`: Remove arquivos de um bucket. [alias: rm] * `settings`: Atualizar configurações do bucket (visibilidade). * `sync`: Sincroniza arquivos entre o diretório local e um bucket. ### `hf buckets cp` Copie arquivos entre caminhos locais, repositórios e buckets. Gerencia uploads (local/stdin -> repositório/bucket), downloads (repositório/bucket -> local/stdout) e cópias remotas (repositório/bucket -> repositório/bucket). Cópias de bucket para repositório e de local para local não são suportadas. Para diretórios, use `hf upload`/`hf download` (repositórios) ou `hf buckets sync` (buckets). Cópias remotas funcionam apenas dentro da mesma região de armazenamento (https://huggingface.co/docs/hub/storage-regions). **Uso**: ```console $ hf buckets cp [OPTIONS] SRC [DST] ``` **Argumentos**: * `SRC`: Origem: arquivo local, URI hf:// (repositório ou bucket) ou - para stdin. [obrigatório] * `[DST]`: Destino: caminho local, URI hf:// (repositório ou bucket) ou - para stdout. **Opções**: * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ 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/ Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf buckets create` Crie um novo bucket. **Uso**: ```console $ hf buckets create [OPTIONS] BUCKET_ID ``` **Argumentos**: * `BUCKET_ID`: ID do bucket: bucket_name, namespace/bucket_name ou hf://buckets/namespace/bucket_name [obrigatório] **Opções**: * `--private`: Cria um bucket privado. * `--region [us|eu]`: Região da nuvem em que o bucket será criado. Pode ser 'us' ou 'eu'. Requer o plano Team ou superior. * `--exist-ok`: Não gera um erro se o bucket já existir. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ 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 Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf buckets delete` Excluir um bucket. Isso exclui o bucket inteiro e todo o seu conteúdo. Use `hf buckets rm` para remover arquivos individuais. **Uso**: ```console $ hf buckets delete [OPTIONS] BUCKET_ID ``` **Argumentos**: * `BUCKET_ID`: ID do bucket: namespace/bucket_name ou hf://buckets/namespace/bucket_name [obrigatório] **Opções**: * `-y, --yes`: Pula o prompt de confirmação. * `--missing-ok`: Não gera um erro se o bucket não existir. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ 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 Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf buckets info` Obter informações sobre um bucket. **Uso**: ```console $ hf buckets info [OPTIONS] BUCKET_ID ``` **Argumentos**: * `BUCKET_ID`: ID do bucket: namespace/bucket_name ou hf://buckets/namespace/bucket_name [obrigatório] **Opções**: * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf buckets info user/my-bucket $ hf buckets info hf://buckets/user/my-bucket Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf buckets list` Liste buckets ou arquivos em um bucket. [alias: ls] Quando chamado sem argumento ou com um namespace, lista os buckets. Quando chamado com um ID de bucket (namespace/bucket_name), lista os arquivos no bucket. **Uso**: ```console $ hf buckets list [OPTIONS] [ARGUMENT] ``` **Argumentos**: * `[ARGUMENT]`: Namespace (usuário ou organização) para listar buckets, ou ID do bucket (namespace/bucket_name(/prefix) ou hf://buckets/...) para listar arquivos. **Opções**: * `-h, --human-readable`: Exibe os tamanhos em formato legível por humanos. * `--tree`: Lista arquivos em formato de árvore (apenas para listar arquivos). * `-R, --recursive`: Lista arquivos recursivamente (apenas para listar arquivos). * `--search TEXT`: Consulta de pesquisa. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ 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 Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf buckets move` Move (renomear) um bucket para um novo nome ou namespace. **Uso**: ```console $ hf buckets move [OPTIONS] FROM_ID TO_ID ``` **Argumentos**: * `FROM_ID`: ID do bucket de origem: namespace/bucket_name ou hf://buckets/namespace/bucket_name [obrigatório] * `TO_ID`: ID do bucket de destino: namespace/bucket_name ou hf://buckets/namespace/bucket_name [obrigatório] **Opções**: * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ 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 Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf buckets remove` Remove arquivos de um bucket. [alias: rm] Para excluir um bucket inteiro, use `hf buckets delete` em vez disso. **Uso**: ```console $ hf buckets remove [OPTIONS] ARGUMENT ``` **Argumentos**: * `ARGUMENT`: Caminho do bucket: namespace/bucket_name/path ou hf://buckets/namespace/bucket_name/path. Com --recursive, namespace/bucket_name também é aceito para direcionar a todos os arquivos. [obrigatório] **Opções**: * `-R, --recursive`: Remove arquivos recursivamente sob o prefixo dado. * `-y, --yes`: Pula o prompt de confirmação. * `--dry-run`: Pré-visualiza o que seria excluído sem realmente excluir. * `--include TEXT`: Inclui apenas arquivos que correspondem ao padrão (pode especificar vários). Exige --recursive. * `--exclude TEXT`: Exclui arquivos que correspondem ao padrão (pode especificar vários). Requer --recursive. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ 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 Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf buckets settings` Atualizar configurações do bucket (visibilidade). **Uso**: ```console $ hf buckets settings [OPTIONS] BUCKET_ID ``` **Argumentos**: * `BUCKET_ID`: ID do bucket: namespace/bucket_name ou hf://buckets/namespace/bucket_name [obrigatório] **Opções**: * `--private`: Torna o bucket privado. * `--public`: Torna o bucket público. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf buckets settings user/my-bucket --private $ hf buckets settings user/my-bucket --public $ hf buckets settings hf://buckets/user/my-bucket --private Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf buckets sync` Sincronize arquivos entre um diretório local e um bucket. **Uso**: ```console $ hf buckets sync [OPTIONS] [SOURCE] [DEST] ``` **Argumentos**: * `[SOURCE]`: Caminho de origem: diretório local ou hf://buckets/namespace/bucket_name(/prefix) * `[DEST]`: Caminho de destino: diretório local ou hf://buckets/namespace/bucket_name(/prefix) **Opções**: * `--delete / --no-delete`: Exclui os arquivos de destino que não estão presentes na origem. [padrão: no-delete] * `--ignore-times`: Pule arquivos com base apenas no tamanho, ignorando os horários de modificação. * `--ignore-sizes`: Pular arquivos com base apenas nos horários de modificação, ignorando os tamanhos. * `--plan TEXT`: Salva o plano de sincronização em um arquivo JSONL para revisão, em vez de executar. * `--apply TEXT`: Aplica um arquivo de plano salvo anteriormente. * `--dry-run`: Imprime o plano de sincronização no stdout como JSONL sem executar. * `--include TEXT`: Inclui arquivos que correspondem ao padrão (pode especificar vários). * `--exclude TEXT`: Exclui arquivos que correspondem ao padrão (pode especificar vários). * `--filter-from TEXT`: Lê os padrões de inclusão/exclusão de um arquivo. * `--existing`: Pula a criação de novos arquivos no receptor (atualiza apenas os arquivos existentes). * `--ignore-existing`: Pula a atualização de arquivos que já existem no receptor (cria apenas arquivos novos). * `-v, --verbose`: Exibe logs detalhados com raciocínio. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ 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 . Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ## `hf cache` Gerenciar o diretório de cache local. **Uso**: ```console $ hf cache [OPTIONS] COMMAND [ARGS]... ``` **Opções**: * `--help`: Exibe esta mensagem e sai. **Comandos**: * `list`: Lista repositórios ou revisões em cache. [alias: ls] * `prune`: Remove revisões desconectadas e downloads incompletos do cache. * `rm`: Remove repositórios, revisões ou arquivos em cache. * `verify`: Verifica os checksums de uma única revisão de repositório a partir do cache ou de um diretório local. ### `hf cache list` Liste repositórios ou revisões em cache. [alias: ls] **Uso**: ```console $ hf cache list [OPTIONS] ``` **Opções**: * `--cache-dir TEXT`: Diretório de cache para varredura (padrão: cache do Hugging Face). * `--revisions / --no-revisions`: Inclui revisões na saída em vez de repositórios agregados. [padrão: no-revisions] * `-f, --filter TEXT`: Filtra entradas (por exemplo, 'size>1GB', 'type=model', 'accessed>7d'). Pode ser usado várias vezes. * `--sort [accessed|accessed:asc|accessed:desc|modified|modified:asc|modified:desc|name|name:asc|name:desc|size|size:asc|size:desc]`: Ordena as entradas por chave. Chaves suportadas: 'accessed', 'modified', 'name', 'size'. Adicione ':asc' ou ':desc' para definir explicitamente a ordem (por exemplo, 'modified:asc'). Padrões: 'accessed', 'modified' e 'size' usam 'desc' por padrão (mais recente/maior primeiro); 'name' usa 'asc' por padrão (alfabética). * `--limit INTEGER`: Limita o número de resultados retornados. Retorna apenas as N primeiras entradas após a ordenação. * `--show-warnings / --no-show-warnings`: Exibe avisos sobre inconsistências no cache. [padrão: no-show-warnings] * `--help`: Exibe esta mensagem e sai. Exemplos $ hf cache ls $ hf cache ls --revisions $ hf cache ls --filter "size>1GB" --limit 20 $ hf cache ls --format json Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf cache prune` Remove revisões desconectadas e downloads incompletos do cache. **Uso**: ```console $ hf cache prune [OPTIONS] ``` **Opções**: * `--cache-dir TEXT`: Diretório de cache para varredura (padrão: cache do Hugging Face). * `-y, --yes`: Pula o prompt de confirmação. * `--dry-run / --no-dry-run`: Pré-visualiza as exclusões sem remover nada. [padrão: no-dry-run] * `--help`: Exibe esta mensagem e sai. Exemplos $ hf cache prune $ hf cache prune --dry-run Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf cache rm` Remove repositórios, revisões ou arquivos em cache. **Uso**: ```console $ hf cache rm [OPTIONS] TARGETS... ``` **Argumentos**: * `TARGETS...`: Um ou mais IDs de repositório (por exemplo, model/bert-base-uncased), URIs hf:// (repositório ou arquivo) ou hashes de revisão a serem excluídos. [obrigatório] **Opções**: * `--cache-dir TEXT`: Diretório de cache para varredura (padrão: cache do Hugging Face). * `-y, --yes`: Pula o prompt de confirmação. * `--dry-run / --no-dry-run`: Pré-visualiza as exclusões sem remover nada. [padrão: no-dry-run] * `--help`: Exibe esta mensagem e sai. Exemplos $ 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 $ hf cache rm model/gpt2 --dry-run $ hf cache rm model/gpt2 --yes Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf cache verify` Verifique os checksums para uma única revisão de repositório a partir do cache ou de um diretório local. Exemplos: - Verifique a revisão principal no cache: `hf cache verify gpt2` - Verifique uma revisão específica: `hf cache verify gpt2 --revision refs/pr/1` - Verificar o conjunto de dados: `hf cache verify karpathy/fineweb-edu-100b-shuffle --repo-type dataset` - Verifique o diretório local: `hf cache verify deepseek-ai/DeepSeek-OCR --local-dir /path/to/repo` **Uso**: ```console $ hf cache verify [OPTIONS] REPO_ID ``` **Argumentos**: * `REPO_ID`: O ID do repositório (por exemplo, `username/repo-name` ou `spaces/username/repo-name`). [obrigatório] **Opções**: * `--type, --repo-type [model|dataset|space|kernel]`: O tipo de repositório (model, dataset, space ou kernel). [padrão: model] * `--revision TEXT`: id da revisão Git, que pode ser um nome de branch, uma tag ou um hash de commit. * `--cache-dir TEXT`: Diretório de cache a ser usado ao verificar arquivos a partir do cache (padrão: cache do Hugging Face). * `--local-dir TEXT`: Se definido, verifica os arquivos sob este diretório em vez do cache. * `--fail-on-missing-files`: Falha se alguns arquivos existem no remoto, mas estão ausentes localmente. * `--fail-on-extra-files`: Falha se alguns arquivos existirem localmente, mas não estiverem presentes na revisão remota. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf cache verify gpt2 $ hf cache verify gpt2 --revision refs/pr/1 $ hf cache verify my-dataset --repo-type dataset Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ## `hf collections` Interaja com coleções no Hub. **Uso**: ```console $ hf collections [OPTIONS] COMMAND [ARGS]... ``` **Opções**: * `--help`: Exibe esta mensagem e sai. **Comandos**: * `add-item`: Adiciona um item a uma coleção. * `create`: Cria uma nova coleção no Hub. * `delete`: Exclui uma coleção do Hub. * `delete-item`: Exclui um item de uma coleção. * `info`: Obter informações sobre uma coleção no Hub. * `list`: Lista coleções no Hub. [alias: ls] * `update`: Atualiza os metadados de uma coleção no Hub. * `update-item`: Atualiza um item em uma coleção. ### `hf collections add-item` Adicione um item a uma coleção. **Uso**: ```console $ hf collections add-item [OPTIONS] COLLECTION_SLUG ITEM_ID ITEM_TYPE:{model|dataset|space|paper|collection|bucket} ``` **Argumentos**: * `COLLECTION_SLUG`: O slug da coleção (por exemplo, 'username/collection-slug'). [obrigatório] * `ITEM_ID`: O ID do item a ser adicionado (repo_id para repositórios, ID do paper para papers). [obrigatório] * `ITEM_TYPE:{model|dataset|space|paper|collection|bucket}`: O tipo de item (model, dataset, space, paper, collection ou bucket). [obrigatório] **Opções**: * `--note TEXT`: Uma nota para anexar ao item (máx. 500 caracteres). * `--exists-ok / --no-exists-ok`: Não gera um erro se o item já estiver na coleção. [padrão: no-exists-ok] * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ 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 Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf collections create` Crie uma nova coleção no Hub. **Uso**: ```console $ hf collections create [OPTIONS] TITLE ``` **Argumentos**: * `TITLE`: O título da coleção. [obrigatório] **Opções**: * `--namespace TEXT`: O namespace (nome de usuário ou organização). O padrão é o usuário autenticado. * `--description TEXT`: Uma descrição para a coleção (máx. 150 caracteres). * `--private / --no-private`: Cria uma coleção privada. [padrão: no-private] * `--exists-ok / --no-exists-ok`: Não gera um erro se a coleção já existir. [padrão: no-exists-ok] * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ 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 Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf collections delete` Excluir uma coleção do Hub. **Uso**: ```console $ hf collections delete [OPTIONS] COLLECTION_SLUG ``` **Argumentos**: * `COLLECTION_SLUG`: O slug da coleção (por exemplo, 'username/collection-slug'). [obrigatório] **Opções**: * `--missing-ok / --no-missing-ok`: Não gera um erro se a coleção não existir. [padrão: no-missing-ok] * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf collections delete username/my-collection $ hf collections delete username/my-collection --missing-ok Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf collections delete-item` Excluir um item de uma coleção. **Uso**: ```console $ hf collections delete-item [OPTIONS] COLLECTION_SLUG ITEM_OBJECT_ID ``` **Argumentos**: * `COLLECTION_SLUG`: O slug da coleção (por exemplo, 'username/collection-slug'). [obrigatório] * `ITEM_OBJECT_ID`: O ID do item na coleção (obtido do campo `item_object_id` retornado por 'hf collections info'. [obrigatório] **Opções**: * `--missing-ok / --no-missing-ok`: Não gera um erro se o item não existir. [padrão: no-missing-ok] * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. ### `hf collections info` Obter informações sobre uma coleção no Hub. **Uso**: ```console $ hf collections info [OPTIONS] COLLECTION_SLUG ``` **Argumentos**: * `COLLECTION_SLUG`: O slug da coleção (por exemplo, 'username/collection-slug'). [obrigatório] **Opções**: * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf collections info username/my-collection-slug Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf collections list` Liste coleções no Hub. [alias: ls] **Uso**: ```console $ hf collections list [OPTIONS] ``` **Opções**: * `--owner TEXT`: Filtrar pelo nome de usuário ou organização do proprietário. * `--item TEXT`: Filtra coleções que contêm um item específico (por exemplo, "models/gpt2", "datasets/squad", "papers/2311.12983"). * `--sort [lastModified|trending|upvotes]`: Ordena os resultados por data de última modificação, em alta ou votos positivos. * `--limit INTEGER`: Limita o número de resultados. [padrão: 10] * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf collections ls $ hf collections ls --owner nvidia $ hf collections ls --item models/teknium/OpenHermes-2.5-Mistral-7B --limit 10 Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf collections update` Atualize os metadados de uma coleção no Hub. **Uso**: ```console $ hf collections update [OPTIONS] COLLECTION_SLUG ``` **Argumentos**: * `COLLECTION_SLUG`: O slug da coleção (por exemplo, 'username/collection-slug'). [obrigatório] **Opções**: * `--title TEXT`: O novo título para a coleção. * `--description TEXT`: A nova descrição para a coleção (máx. 150 caracteres). * `--position INTEGER`: A nova posição da coleção na lista do proprietário. * `--private / --no-private`: Se a coleção deve ser privada. * `--theme TEXT`: A cor do tema da coleção (por exemplo, 'green', 'blue'). * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ 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 Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf collections update-item` Atualize um item em uma coleção. **Uso**: ```console $ hf collections update-item [OPTIONS] COLLECTION_SLUG ITEM_OBJECT_ID ``` **Argumentos**: * `COLLECTION_SLUG`: O slug da coleção (por exemplo, 'username/collection-slug'). [obrigatório] * `ITEM_OBJECT_ID`: O ID do item na coleção (do campo 'item_object_id', não do repo_id). [obrigatório] **Opções**: * `--note TEXT`: Uma nova nota para o item (máx. 500 caracteres). * `--position INTEGER`: A nova posição do item na coleção. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ 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 Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ## `hf cp` Copie arquivos entre caminhos locais, repositórios e buckets. Gerencia uploads (local/stdin -> repositório/bucket), downloads (repositório/bucket -> local/stdout) e cópias remotas (repositório/bucket -> repositório/bucket). Cópias de bucket para repositório e de local para local não são suportadas. Para diretórios, use `hf upload`/`hf download` (repositórios) ou `hf buckets sync` (buckets). Cópias remotas funcionam apenas dentro da mesma região de armazenamento (https://huggingface.co/docs/hub/storage-regions). **Uso**: ```console $ hf cp [OPTIONS] SRC [DST] ``` **Argumentos**: * `SRC`: Origem: arquivo local, URI hf:// (repositório ou bucket) ou - para stdin. [obrigatório] * `[DST]`: Destino: caminho local, URI hf:// (repositório ou bucket) ou - para stdout. **Opções**: * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ 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 Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ## `hf datasets` Interaja com conjuntos de dados no Hub. **Uso**: ```console $ hf datasets [OPTIONS] COMMAND [ARGS]... ``` **Opções**: * `--help`: Exibe esta mensagem e sai. **Comandos**: * `card`: Obter o card do dataset (README) para um dataset no Hub. * `info`: Obter informações sobre um conjunto de dados no Hub. * `leaderboard`: Lista as pontuações dos modelos de um leaderboard de dataset. * `list`: Lista conjuntos de dados no Hub ou arquivos em um repositório de conjunto de dados. [alias: ls] * `parquet`: Lista as URLs dos arquivos parquet disponíveis para um conjunto de dados. * `sql`: Executa uma consulta SQL bruta com DuckDB contra as URLs parquet do dataset. ### `hf datasets card` Obtenha o cartão do dataset (README) para um dataset no Hub. **Uso**: ```console $ hf datasets card [OPTIONS] DATASET_ID ``` **Argumentos**: * `DATASET_ID`: O ID do conjunto de dados (por exemplo, `username/repo-name`). [obrigatório] **Opções**: * `--metadata`: Exibe apenas os metadados do card. * `--text`: Exibe apenas o corpo do texto (sem metadados). * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ 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 Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf datasets info` Obtenha informações sobre um conjunto de dados no Hub. **Uso**: ```console $ hf datasets info [OPTIONS] DATASET_ID ``` **Argumentos**: * `DATASET_ID`: O ID do conjunto de dados (por exemplo, `username/repo-name`). [obrigatório] **Opções**: * `--revision TEXT`: id da revisão Git, que pode ser um nome de branch, uma tag ou um hash de commit. * `--expand TEXT`: Propriedades separadas por vírgulas para retornar. Quando usado, apenas as propriedades listadas (e id) são retornadas. Exemplo: '--expand=downloads,likes,tags'. Válidos: author, cardData, citation, createdAt, description, disabled, downloads, downloadsAllTime, gated, lastModified, likes, mainSize, paperswithcode_id, private, resourceGroup, sha, siblings, tags, trendingScore, usedStorage. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf datasets info HuggingFaceFW/fineweb $ hf datasets info my-dataset --expand downloads,likes,tags Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf datasets leaderboard` Liste as pontuações dos modelos de um ranking de datasets. Este comando ajuda a encontrar os melhores modelos para uma tarefa ou a comparar modelos por meio de pontuações de benchmark. Use 'hf datasets ls --filter benchmark:official' para listar os rankings disponíveis. **Uso**: ```console $ hf datasets leaderboard [OPTIONS] DATASET_ID ``` **Argumentos**: * `DATASET_ID`: O ID do conjunto de dados de benchmark (por exemplo, `SWE-bench/SWE-bench_Verified`). [obrigatório] **Opções**: * `--limit INTEGER`: Limita o número de resultados. [padrão: 20] * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ 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 Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf datasets list` Liste conjuntos de dados no Hub ou arquivos em um repositório de conjunto de dados. [alias: ls] Quando chamado sem argumentos, lista os datasets no Hub. Quando chamado com um ID de dataset, lista os arquivos no repositório desse dataset. **Uso**: ```console $ hf datasets list [OPTIONS] [REPO_ID] ``` **Argumentos**: * `[REPO_ID]`: ID do dataset (por exemplo, `username/repo-name`) para listar os arquivos. Se omitido, lista os datasets. **Opções**: * `--search TEXT`: Consulta de pesquisa. * `--author TEXT`: Filtrar por autor ou organização. * `--filter TEXT`: Filtra por tags (por exemplo, 'text-classification'). Pode ser usado várias vezes. * `--sort [created_at|downloads|last_modified|likes|trending_score]`: Ordena os resultados. * `--limit INTEGER`: Limita o número de resultados. [padrão: 30] * `--expand TEXT`: Propriedades separadas por vírgulas para retornar. Quando usado, apenas as propriedades listadas (e id) são retornadas. Exemplo: '--expand=downloads,likes,tags'. Válidos: author, cardData, citation, createdAt, description, disabled, downloads, downloadsAllTime, gated, lastModified, likes, mainSize, paperswithcode_id, private, resourceGroup, sha, siblings, tags, trendingScore, usedStorage. * `-h, --human-readable`: Exibe os tamanhos em formato legível por humanos (apenas para listar arquivos). * `--tree`: Lista arquivos em formato de árvore (apenas para listar arquivos). * `-R, --recursive`: Lista arquivos recursivamente (apenas para listar arquivos). * `--revision TEXT`: id da revisão Git, que pode ser um nome de branch, uma tag ou um hash de commit. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ 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 Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf datasets parquet` Liste as URLs dos arquivos parquet disponíveis para um conjunto de dados. **Uso**: ```console $ hf datasets parquet [OPTIONS] DATASET_ID ``` **Argumentos**: * `DATASET_ID`: O ID do conjunto de dados (por exemplo, `username/repo-name`). [obrigatório] **Opções**: * `--subset TEXT`: Filtra entradas do parquet por subconjunto/configuração. * `--split TEXT`: Filtra entradas do parquet por split. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ 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 Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf datasets sql` Execute uma consulta SQL bruta com DuckDB contra URLs de parquets de datasets. **Uso**: ```console $ hf datasets sql [OPTIONS] SQL ``` **Argumentos**: * `SQL`: Consulta SQL bruta a ser executada. [obrigatório] **Opções**: * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ 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 Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ## `hf discussions` Gerencie discussões e pull requests no Hub. **Uso**: ```console $ hf discussions [OPTIONS] COMMAND [ARGS]... ``` **Opções**: * `--help`: Exibe esta mensagem e sai. **Comandos**: * `close`: Fecha uma discussão ou pull request. * `comment`: Comente em uma discussão ou pull request. * `create`: Cria uma nova discussão ou pull request em um repositório. * `diff`: Mostra o diff de um pull request. * `edit`: Edita um comentário existente em uma discussão ou pull request. * `info`: Obter informações sobre uma discussão ou pull request. * `list`: Lista discussões e pull requests em um repositório. [alias: ls] * `merge`: Mesclar um pull request. * `rename`: Renomeia uma discussão ou pull request. * `reopen`: Reabre uma discussão ou pull request fechada. ### `hf discussions close` Fechar uma discussão ou pull request. **Uso**: ```console $ hf discussions close [OPTIONS] REPO_ID NUM ``` **Argumentos**: * `REPO_ID`: O ID do repositório (por exemplo, `username/repo-name` ou `spaces/username/repo-name`). [obrigatório] * `NUM`: O número da discussão ou pull request. [obrigatório] **Opções**: * `--comment TEXT`: Um comentário opcional para publicar ao fechar. * `-y, --yes`: Pula o prompt de confirmação. * `--type, --repo-type [model|dataset|space|kernel]`: O tipo de repositório (model, dataset, space ou kernel). [padrão: model] * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf discussions close username/my-model 5 $ hf discussions close username/my-model 5 --comment "Closing as resolved." Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf discussions comment` Comente em uma discussão ou solicitação de pull. **Uso**: ```console $ hf discussions comment [OPTIONS] REPO_ID NUM ``` **Argumentos**: * `REPO_ID`: O ID do repositório (por exemplo, `username/repo-name` ou `spaces/username/repo-name`). [obrigatório] * `NUM`: O número da discussão ou pull request. [obrigatório] **Opções**: * `--body TEXT`: O texto do comentário (suporta Markdown). * `--body-file PATH`: Lê o comentário de um arquivo. Use '-' para stdin. * `--attach TEXT`: Anexa um arquivo de imagem, vídeo ou áudio, como 'FILE' ou 'FILE#texto alternativo'. Uma referência '![alt](FILE)' no corpo é substituída pelo arquivo enviado, enquanto outros arquivos são adicionados. Pode ser usado várias vezes. * `--type, --repo-type [model|dataset|space|kernel]`: O tipo de repositório (model, dataset, space ou kernel). [padrão: model] * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ 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 Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf discussions create` Crie uma nova discussão ou solicitação de pull em um repositório. **Uso**: ```console $ hf discussions create [OPTIONS] REPO_ID ``` **Argumentos**: * `REPO_ID`: O ID do repositório (por exemplo, `username/repo-name` ou `spaces/username/repo-name`). [obrigatório] **Opções**: * `--title TEXT`: O título da discussão ou pull request. [obrigatório] * `--body TEXT`: A descrição (suporta Markdown). * `--body-file PATH`: Lê a descrição de um arquivo. Use '-' para stdin. * `--pull-request, --pr`: Cria um pull request em vez de uma discussão. * `--attach TEXT`: Anexa um arquivo de imagem, vídeo ou áudio, como 'FILE' ou 'FILE#texto alternativo'. Uma referência '![alt](FILE)' no corpo é substituída pelo arquivo enviado, enquanto outros arquivos são adicionados. Pode ser usado várias vezes. * `--type, --repo-type [model|dataset|space|kernel]`: O tipo de repositório (model, dataset, space ou kernel). [padrão: model] * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ 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 Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf discussions diff` Exibir a diferença de um pull request. **Uso**: ```console $ hf discussions diff [OPTIONS] REPO_ID NUM ``` **Argumentos**: * `REPO_ID`: O ID do repositório (por exemplo, `username/repo-name` ou `spaces/username/repo-name`). [obrigatório] * `NUM`: O número da discussão ou pull request. [obrigatório] **Opções**: * `--type, --repo-type [model|dataset|space|kernel]`: O tipo de repositório (model, dataset, space ou kernel). [padrão: model] * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf discussions diff username/my-model 5 Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf discussions edit` Edite um comentário existente em uma discussão ou pull request. **Uso**: ```console $ hf discussions edit [OPTIONS] REPO_ID NUM COMMENT_ID ``` **Argumentos**: * `REPO_ID`: O ID do repositório (por exemplo, `username/repo-name` ou `spaces/username/repo-name`). [obrigatório] * `NUM`: O número da discussão ou pull request. [obrigatório] * `COMMENT_ID`: O ID do comentário a ser editado (veja 'hf discussions info ... --format json'). [obrigatório] **Opções**: * `--body TEXT`: O novo texto do comentário (suporta Markdown). * `--body-file PATH`: Lê o novo comentário de um arquivo. Use '-' para stdin. * `--attach TEXT`: Anexa um arquivo de imagem, vídeo ou áudio, como 'FILE' ou 'FILE#texto alternativo'. Uma referência '![alt](FILE)' no corpo é substituída pelo arquivo enviado, enquanto outros arquivos são adicionados. Pode ser usado várias vezes. * `--type, --repo-type [model|dataset|space|kernel]`: O tipo de repositório (model, dataset, space ou kernel). [padrão: model] * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ 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](./after.png)" --attach ./after.png Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf discussions info` Obtenha informações sobre uma discussão ou pull request. **Uso**: ```console $ hf discussions info [OPTIONS] REPO_ID NUM ``` **Argumentos**: * `REPO_ID`: O ID do repositório (por exemplo, `username/repo-name` ou `spaces/username/repo-name`). [obrigatório] * `NUM`: O número da discussão ou pull request. [obrigatório] **Opções**: * `--type, --repo-type [model|dataset|space|kernel]`: O tipo de repositório (model, dataset, space ou kernel). [padrão: model] * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf discussions info username/my-model 5 $ hf discussions info username/my-model 5 --format json Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf discussions list` Liste discussões e pull requests em um repositório. [alias: ls] **Uso**: ```console $ hf discussions list [OPTIONS] REPO_ID ``` **Argumentos**: * `REPO_ID`: O ID do repositório (por exemplo, `username/repo-name` ou `spaces/username/repo-name`). [obrigatório] **Opções**: * `-s, --status [open|closed|merged|draft|all]`: Filtra por status (open, closed, merged, draft, all). [padrão: open] * `-k, --kind [all|discussion|pull_request]`: Filtra por tipo (discussion, pull_request, all). [padrão: all] * `--author TEXT`: Filtrar por autor ou organização. * `--limit INTEGER`: Limita o número de resultados. [padrão: 30] * `--type, --repo-type [model|dataset|space|kernel]`: O tipo de repositório (model, dataset, space ou kernel). [padrão: model] * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ 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 Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf discussions merge` Mergir um pull request. **Uso**: ```console $ hf discussions merge [OPTIONS] REPO_ID NUM ``` **Argumentos**: * `REPO_ID`: O ID do repositório (por exemplo, `username/repo-name` ou `spaces/username/repo-name`). [obrigatório] * `NUM`: O número da discussão ou pull request. [obrigatório] **Opções**: * `--comment TEXT`: Um comentário opcional para publicar ao mesclar. * `-y, --yes`: Pula o prompt de confirmação. * `--type, --repo-type [model|dataset|space|kernel]`: O tipo de repositório (model, dataset, space ou kernel). [padrão: model] * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf discussions merge username/my-model 5 $ hf discussions merge username/my-model 5 --comment "Merging, thanks!" Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf discussions rename` Renomear uma discussão ou pull request. **Uso**: ```console $ hf discussions rename [OPTIONS] REPO_ID NUM NEW_TITLE ``` **Argumentos**: * `REPO_ID`: O ID do repositório (por exemplo, `username/repo-name` ou `spaces/username/repo-name`). [obrigatório] * `NUM`: O número da discussão ou pull request. [obrigatório] * `NEW_TITLE`: O novo título. [obrigatório] **Opções**: * `--type, --repo-type [model|dataset|space|kernel]`: O tipo de repositório (model, dataset, space ou kernel). [padrão: model] * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf discussions rename username/my-model 5 "Updated title" Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf discussions reopen` Reabrir uma discussão ou pull request fechado. **Uso**: ```console $ hf discussions reopen [OPTIONS] REPO_ID NUM ``` **Argumentos**: * `REPO_ID`: O ID do repositório (por exemplo, `username/repo-name` ou `spaces/username/repo-name`). [obrigatório] * `NUM`: O número da discussão ou pull request. [obrigatório] **Opções**: * `--comment TEXT`: Um comentário opcional para publicar ao reabrir. * `-y, --yes`: Pula o prompt de confirmação. * `--type, --repo-type [model|dataset|space|kernel]`: O tipo de repositório (model, dataset, space ou kernel). [padrão: model] * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf discussions reopen username/my-model 5 $ hf discussions reopen username/my-model 5 --comment "Reopening for further investigation." Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ## `hf download` Baixe arquivos do Hub. **Uso**: ```console $ hf download [OPTIONS] REPO_ID [FILENAMES]... ``` **Argumentos**: * `REPO_ID`: O ID do repositório (por exemplo, `username/repo-name` ou `spaces/username/repo-name`). [obrigatório] * `[FILENAMES]...`: Arquivos para download (por exemplo, `config.json`, `data/metadata.jsonl`). **Opções**: * `--type, --repo-type [model|dataset|space|kernel]`: O tipo de repositório (model, dataset, space ou kernel). [padrão: (model)] * `--revision TEXT`: id da revisão Git, que pode ser um nome de branch, uma tag ou um hash de commit. * `--include TEXT`: Padrões Glob para incluir nos arquivos a serem baixados. Ex.: *.json * `--exclude TEXT`: Padrões de glob para excluir dos arquivos a serem baixados. * `--cache-dir TEXT`: Diretório onde salvar os arquivos. * `--local-dir TEXT`: Se definido, o arquivo baixado será colocado neste diretório. Consulte https://huggingface.co/docs/huggingface_hub/guides/download#download-files-to-a-local-folder para mais detalhes. * `--force-download / --no-force-download`: Se True, os arquivos serão baixados mesmo que já estejam em cache. [padrão: no-force-download] * `--dry-run / --no-dry-run`: Se True, executa uma simulação sem efetivamente baixar o arquivo. [padrão: no-dry-run] * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--max-workers INTEGER`: Número máximo de workers a serem usados para baixar arquivos. O padrão é 8. [default: 8] * `--help`: Exibe esta mensagem e sai. Exemplos $ 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 Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ## `hf endpoints` Gerenciar Hugging Face Inference Endpoints. **Uso**: ```console $ hf endpoints [OPTIONS] COMMAND [ARGS]... ``` **Opções**: * `--help`: Exibe esta mensagem e sai. **Comandos**: * `catalog`: Interaja com o catálogo de Inference Endpoints. * `delete`: Exclui um Inference Endpoint permanentemente. * `deploy`: Implanta um Inference Endpoint a partir de um repositório do Hub. * `describe`: Obter informações sobre um endpoint existente. * `hardware`: Lista o hardware disponível para implantar um Inference Endpoint. * `list`: Lista todos os Inference Endpoints para o namespace fornecido. [alias: ls] * `list-catalog`: Lista os modelos disponíveis no Model Catalog. * `pause`: Pausa um Inference Endpoint. * `resume`: Retomar um Inference Endpoint. * `scale-to-zero`: Escala um Inference Endpoint para zero. * `update`: Atualiza um endpoint existente. ### `hf endpoints catalog` Interaja com o catálogo de Inference Endpoints. **Uso**: ```console $ hf endpoints catalog [OPTIONS] COMMAND [ARGS]... ``` **Opções**: * `--help`: Exibe esta mensagem e sai. **Comandos**: * `deploy`: Implante um Inference Endpoint a partir do Model Catalog. * `list`: Lista os modelos disponíveis no Model Catalog. [alias: ls] #### `hf endpoints catalog deploy` Implante um Endpoint de Inferência a partir do Catálogo de Modelos. Os modelos do catálogo são implantados por meio de uma receita: uma combinação de hardware e motor que foi testada para eles. Passe --repo para implantar a receita padrão de um modelo, opcionalmente restringida com --accelerator e --gguf-file, ou passe --recipe para implantar uma receita exata listada por `hf endpoints catalog ls`. **Uso**: ```console $ hf endpoints catalog deploy [OPTIONS] ``` **Opções**: * `--repo TEXT`: O nome do repositório de modelo associado ao Inference Endpoint (por exemplo, 'openai/gpt-oss-120b'). Implanta sua receita padrão. É mutuamente exclusivo com --recipe. * `--recipe TEXT`: O id da receita do catálogo a ser implantada, conforme listado por 'hf endpoints catalog ls'. Mutuamente exclusivo com --repo. * `--name TEXT`: Nome do endpoint. * `--accelerator [cpu|gpu|neuron]`: O acelerador de hardware a ser usado para inferência. Somente com --repo. * `--gguf-file TEXT`: O arquivo GGUF a ser implantado, para modelos que possuem uma receita por quantização. Somente com --repo. * `--namespace TEXT`: O namespace associado ao Inference Endpoint. O padrão é o namespace do usuário atual. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf endpoints catalog deploy --repo meta-llama/Llama-3.2-1B-Instruct $ hf endpoints catalog deploy --recipe sizzling-biryani-g4xsi1ac Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli #### `hf endpoints catalog list` Liste os modelos disponíveis no Catálogo de Modelos. [alias: ls] Uma linha por receita, ou seja, por cada maneira testada de implantar um modelo. Implante um com `hf endpoints catalog deploy --recipe `. **Uso**: ```console $ hf endpoints catalog list [OPTIONS] ``` **Opções**: * `--accelerator [cpu|gpu|neuron]`: Mostra apenas as receitas executadas neste acelerador. * `--engine [llamacpp|sglang|tei|vllm]`: Mostra apenas as receitas que executam este motor de inferência. * `--license TEXT`: Mostra apenas modelos sob esta licença (por exemplo, 'Apache 2.0'). * `--task TEXT`: Mostra apenas os modelos para esta tarefa (por exemplo, 'text-generation'). * `--search TEXT`: Consulta de pesquisa. * `--limit INTEGER`: Limita o número de modelos a serem retornados. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf endpoints catalog ls $ hf endpoints catalog ls --engine vllm Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf endpoints delete` Excluir permanentemente um Inference Endpoint. **Uso**: ```console $ hf endpoints delete [OPTIONS] NAME ``` **Argumentos**: * `NAME`: Nome do endpoint. [obrigatório] **Opções**: * `--namespace TEXT`: O namespace associado ao Inference Endpoint. O padrão é o namespace do usuário atual. * `--yes`: Pula os prompts de confirmação. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf endpoints delete my-endpoint Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf endpoints deploy` Implante um Endpoint de Inferência a partir de um repositório do Hub. Execute `hf endpoints hardware` para listar as combinações válidas de `--vendor`, `--region`, `--accelerator`, `--instance-type` e `--instance-size`. **Uso**: ```console $ hf endpoints deploy [OPTIONS] NAME ``` **Argumentos**: * `NAME`: Nome do endpoint. [obrigatório] **Opções**: * `--repo TEXT`: O nome do repositório de modelo associado ao Inference Endpoint (por exemplo, 'openai/gpt-oss-120b'). [obrigatório] * `--framework TEXT`: O framework de machine learning usado para o modelo (por exemplo, 'vllm'). [obrigatório] * `--accelerator TEXT`: O acelerador de hardware a ser usado para inferência (por exemplo, 'cpu'). [obrigatório] * `--instance-size TEXT`: O tamanho ou o tipo da instância a ser usada para hospedar o modelo (por exemplo, 'x4'). [obrigatório] * `--instance-type TEXT`: O tipo de instância na nuvem onde o Inference Endpoint será implantado (por exemplo, 'intel-icl'). [obrigatório] * `--region TEXT`: A região da nuvem na qual o Inference Endpoint será criado (por exemplo, 'us-east-1'). [obrigatório] * `--vendor TEXT`: O provedor de nuvem ou fornecedor onde o Inference Endpoint será hospedado (por exemplo, 'aws'). [obrigatório] * `--namespace TEXT`: O namespace associado ao Inference Endpoint. O padrão é o namespace do usuário atual. * `--task TEXT`: A tarefa na qual o modelo será implantado (por exemplo, 'text-classification'). * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--min-replica INTEGER`: O número mínimo de réplicas (instâncias) a manter em execução para o Inference Endpoint. [padrão: 1] * `--max-replica INTEGER`: O número máximo de réplicas (instâncias) para as quais o Inference Endpoint será dimensionado. [padrão: 1] * `--scale-to-zero-timeout INTEGER`: A duração, em minutos, antes de um endpoint inativo ser reduzido a zero. * `--scaling-metric [pendingRequests|hardwareUsage]`: A métrica de referência para o dimensionamento. * `--scaling-threshold FLOAT`: O limiar da métrica de escala usado para acionar o aumento de escala. Ignorado quando a métrica de escala não é fornecida. * `--revision TEXT`: id da revisão Git, que pode ser um nome de branch, uma tag ou um hash de commit. * `--custom-image TEXT`: URL da imagem Docker para o contêiner a ser executado (ex.: 'nexagi/sglang:v0.5.12'). Exige '--framework custom'. * `--engine [custom|hf-serve|llamacpp|sglang|tei|tgi|tgi-neuron|vllm|vllm-neuron]`: Imagem do engine gerenciado para executar com --custom-image (por exemplo, 'vllm'). O padrão é um container arbitrário. * `--health-route TEXT`: rota de verificação de saúde exposta pelo contêiner (por exemplo, '/health'). Exige --custom-image. * `--port INTEGER`: Porta na qual o contêiner escuta (por exemplo, 30000). Exige --custom-image. * `--container-registry-username TEXT`: Nome de usuário usado para autenticar com o registro que hospeda --custom-image. * `--container-registry-password TEXT`: Senha opcional usada para autenticar com o registry que hospeda o --custom-image. * `--tensor-parallel-size INTEGER`: Número de aceleradores para dividir uma única cópia do modelo (somente nos motores vLLM e SGLang). * `--data-parallel-size INTEGER`: Número de cópias do modelo a serem executadas, uma por acelerador (somente para o mecanismo vLLM). * `--container-command TEXT`: Substitui o entrypoint do container, como uma string entre aspas dividida em tokens (ex.: "python -m sglang.launch_server"). * `--container-args TEXT`: Argumentos adicionados ao entrypoint do container, como uma string entre aspas dividida em tokens (ex.: "--tp 8 --reasoning-parser qwen3"). * `-e, --env TEXT`: Define variáveis de ambiente. Ex.: --env ENV=value * `--env-file TEXT`: Lê um arquivo de variáveis de ambiente. Use `-` para lê-las do stdin. * `-s, --secrets TEXT`: Define variáveis de ambiente secretas. Prefira `--secrets SECRET` para ler o valor do seu ambiente (por exemplo, `--secrets HF_TOKEN` para passar seu token do Hugging Face); `--secrets SECRET=value` coloca o valor no histórico do seu shell. * `--secrets-file TEXT`: Lê um arquivo de variáveis de ambiente secretas. Use `-` para lê-las do stdin. * `--type [public|authenticated|private]`: tipo de acesso ao endpoint. O padrão é 'authenticated' (protegido por token, acessível publicamente). * `--help`: Exibe esta mensagem e sai. Exemplos $ 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 ... Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf endpoints describe` Obtenha informações sobre um endpoint existente. **Uso**: ```console $ hf endpoints describe [OPTIONS] NAME ``` **Argumentos**: * `NAME`: Nome do endpoint. [obrigatório] **Opções**: * `--namespace TEXT`: O namespace associado ao Inference Endpoint. O padrão é o namespace do usuário atual. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf endpoints describe my-endpoint Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf endpoints hardware` Liste o hardware disponível para implantar um Inference Endpoint. Apenas o hardware no qual o namespace pode implantar no momento é listado: um status utilizável e cota de acelerador suficiente para uma réplica. Use `--all` para listar todas as combinações retornadas pela API. A cota é por namespace, portanto, passe o mesmo `--namespace` que você passará para `hf endpoints deploy`. Os preços estão em USD, por réplica por hora. **Uso**: ```console $ hf endpoints hardware [OPTIONS] ``` **Opções**: * `--namespace TEXT`: O namespace associado ao Inference Endpoint. O padrão é o namespace do usuário atual. * `--vendor TEXT`: Mostra apenas o hardware hospedado por este provedor de nuvem (por exemplo, 'aws'). * `--region TEXT`: Mostra apenas o hardware disponível nesta região da nuvem (por exemplo, 'us-east-1'). * `--accelerator TEXT`: Mostra apenas o hardware com este acelerador (por exemplo, 'cpu', 'gpu', 'neuron'). * `--instance-type TEXT`: Mostra apenas o hardware deste tipo de instância (por exemplo, 'nvidia-l4'). * `-a, --all`: Também exibe hardware que não pode ser implantado no momento (indisponível, descontinuado ou sem cota). * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf endpoints hardware $ hf endpoints hardware --vendor aws --accelerator gpu Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf endpoints list` Lista todos os Inference Endpoints para o namespace fornecido. [alias: ls] **Uso**: ```console $ hf endpoints list [OPTIONS] ``` **Opções**: * `--namespace TEXT`: O namespace associado ao Inference Endpoint. O padrão é o namespace do usuário atual. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf endpoints ls $ hf endpoints ls --namespace my-org Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf endpoints list-catalog` Liste os modelos disponíveis no Catálogo de Modelos. Uma linha por receita, ou seja, por cada maneira testada de implantar um modelo. Implante um com `hf endpoints catalog deploy --recipe `. **Uso**: ```console $ hf endpoints list-catalog [OPTIONS] ``` **Opções**: * `--accelerator [cpu|gpu|neuron]`: Mostra apenas as receitas executadas neste acelerador. * `--engine [llamacpp|sglang|tei|vllm]`: Mostra apenas as receitas que executam este motor de inferência. * `--license TEXT`: Mostra apenas modelos sob esta licença (por exemplo, 'Apache 2.0'). * `--task TEXT`: Mostra apenas os modelos para esta tarefa (por exemplo, 'text-generation'). * `--search TEXT`: Consulta de pesquisa. * `--limit INTEGER`: Limita o número de modelos a serem retornados. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. ### `hf endpoints pause` Pausar um Inference Endpoint. **Uso**: ```console $ hf endpoints pause [OPTIONS] NAME ``` **Argumentos**: * `NAME`: Nome do endpoint. [obrigatório] **Opções**: * `--namespace TEXT`: O namespace associado ao Inference Endpoint. O padrão é o namespace do usuário atual. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf endpoints pause my-endpoint Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf endpoints resume` Retomar um Inference Endpoint. **Uso**: ```console $ hf endpoints resume [OPTIONS] NAME ``` **Argumentos**: * `NAME`: Nome do endpoint. [obrigatório] **Opções**: * `--namespace TEXT`: O namespace associado ao Inference Endpoint. O padrão é o namespace do usuário atual. * `--fail-if-already-running`: Se `True`, o método lançará um erro se o Inference Endpoint já estiver em execução. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf endpoints resume my-endpoint Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf endpoints scale-to-zero` Escale um Endpoint de Inferência para zero. **Uso**: ```console $ hf endpoints scale-to-zero [OPTIONS] NAME ``` **Argumentos**: * `NAME`: Nome do endpoint. [obrigatório] **Opções**: * `--namespace TEXT`: O namespace associado ao Inference Endpoint. O padrão é o namespace do usuário atual. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf endpoints scale-to-zero my-endpoint Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf endpoints update` Atualize um endpoint existente. **Uso**: ```console $ hf endpoints update [OPTIONS] NAME ``` **Argumentos**: * `NAME`: Nome do endpoint. [obrigatório] **Opções**: * `--namespace TEXT`: O namespace associado ao Inference Endpoint. O padrão é o namespace do usuário atual. * `--repo TEXT`: O nome do repositório de modelos associado ao Inference Endpoint (por exemplo, 'openai/gpt-oss-120b'). * `--accelerator TEXT`: O acelerador de hardware a ser usado para inferência (por exemplo, 'cpu'). * `--instance-size TEXT`: O tamanho ou o tipo da instância a ser usada para hospedar o modelo (por exemplo, 'x4'). * `--instance-type TEXT`: O tipo de instância na nuvem onde o Inference Endpoint será implantado (por exemplo, 'intel-icl'). * `--framework TEXT`: O framework de machine learning usado para o modelo (por exemplo, 'custom'). * `--revision TEXT`: A revisão específica do modelo a ser implantada no Inference Endpoint (por exemplo, '6c0e6080953db56375760c0471a8c5f2929baf11'). * `--task TEXT`: A tarefa na qual o modelo será implantado (por exemplo, 'text-classification'). * `--custom-image TEXT`: URL da imagem Docker para o contêiner a ser executado (ex.: 'nexagi/sglang:v0.5.12'). Substitui a imagem atualmente configurada no endpoint, em vez de aplicá-la como patch, portanto, passe as configurações de engine e contêiner que deseja manter junto com ela; execute 'hf endpoints describe NAME' primeiro para visualizá-las. * `--engine [custom|hf-serve|llamacpp|sglang|tei|tgi|tgi-neuron|vllm|vllm-neuron]`: Imagem do engine gerenciado para executar com --custom-image (por exemplo, 'vllm'). O padrão é um container arbitrário. * `--health-route TEXT`: rota de verificação de saúde exposta pelo contêiner (por exemplo, '/health'). Exige --custom-image. * `--port INTEGER`: Porta na qual o contêiner escuta (por exemplo, 30000). Exige --custom-image. * `--tensor-parallel-size INTEGER`: Número de aceleradores para dividir uma única cópia do modelo (somente nos motores vLLM e SGLang). * `--data-parallel-size INTEGER`: Número de cópias do modelo a serem executadas, uma por acelerador (somente para o mecanismo vLLM). * `--container-command TEXT`: Substitui o entrypoint do container, como uma string entre aspas dividida em tokens (por exemplo, "python -m sglang.launch_server"). Substitui o valor atual; passe uma string vazia para limpá-lo. * `--container-args TEXT`: Argumentos adicionados ao entrypoint do container, como uma string entre aspas dividida em tokens (ex.: "--enable-auto-tool-choice --tool-call-parser lfm2"). Substitui os argumentos atualmente definidos no endpoint, em vez de adicioná-los, portanto inclua aqueles que deseja manter; execute 'hf endpoints describe NAME' primeiro para visualizá-los. Passe uma string vazia para limpá-los. * `--min-replica INTEGER`: O número mínimo de réplicas (instâncias) a manter em execução para o Inference Endpoint. * `--max-replica INTEGER`: O número máximo de réplicas (instâncias) para as quais o Inference Endpoint será dimensionado. * `--scale-to-zero-timeout INTEGER`: A duração, em minutos, antes de um endpoint inativo ser reduzido a zero. * `--scaling-metric [pendingRequests|hardwareUsage]`: A métrica de referência para o dimensionamento. * `--scaling-threshold FLOAT`: O limiar da métrica de escala usado para acionar o aumento de escala. Ignorado quando a métrica de escala não é fornecida. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ 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" Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ## `hf env` Imprime informações sobre o ambiente. **Uso**: ```console $ hf env [OPTIONS] ``` **Opções**: * `--help`: Exibe esta mensagem e sai. ## `hf extensions` Gerencie as extensões do CLI hf. [alias: ext] Aviso de segurança: as extensões são executáveis de terceiros ou pacotes Python. Instale apenas de fontes confiáveis. **Uso**: ```console $ hf extensions [OPTIONS] COMMAND [ARGS]... ``` **Opções**: * `--help`: Exibe esta mensagem e sai. **Comandos**: * `exec`: Executa uma extensão instalada. * `install`: Instala uma extensão de um repositório público do GitHub. * `list`: Lista os comandos de extensão instalados. [alias: ls] * `remove`: Remove uma extensão instalada. [alias: rm] * `search`: Busca extensões disponíveis no GitHub (marcadas com o tópico 'hf-extension'). * `update`: Atualiza a(s) extensão(ões) instalada(s) para a(s) sua(s) versão(ões) mais recente(s). ### `hf extensions exec` Execute uma extensão instalada. **Uso**: ```console $ hf extensions exec [OPTIONS] NAME ``` **Argumentos**: * `NAME`: Extension name (with or without `hf-` prefix). [required] **Opções**: * `--help`: Exibe esta mensagem e sai. Exemplos $ hf extensions exec claude -- --help $ hf extensions exec claude --model zai-org/GLM-5 Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf extensions install` Instale uma extensão de um repositório público do GitHub. Aviso de segurança: isso instala um executável ou pacote Python de terceiros. Instale apenas de fontes confiáveis. **Uso**: ```console $ hf extensions install [OPTIONS] REPO_ID ``` **Argumentos**: * `REPO_ID`: repositório de extensão do GitHub no formato `[OWNER/]hf-`. [obrigatório] **Opções**: * `--force`: Sobrescreve se já estiver instalado. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf extensions install hf-claude $ hf extensions install hanouticelina/hf-claude $ hf extensions install alvarobartt/hf-mem Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf extensions list` Lista os comandos de extensões instalados. [alias: ls] **Uso**: ```console $ hf extensions list [OPTIONS] ``` **Opções**: * `--help`: Exibe esta mensagem e sai. Exemplos $ hf extensions list Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf extensions remove` Remove uma extensão instalada. [alias: rm] **Uso**: ```console $ hf extensions remove [OPTIONS] NAME ``` **Argumentos**: * `NAME`: Nome da extensão a ser removida (com ou sem o prefixo `hf-`). [obrigatório] **Opções**: * `--help`: Exibe esta mensagem e sai. Exemplos $ hf extensions remove claude Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf extensions search` Pesquise extensões disponíveis no GitHub (marcadas com o tópico 'hf-extension'). **Uso**: ```console $ hf extensions search [OPTIONS] ``` **Opções**: * `--help`: Exibe esta mensagem e sai. Exemplos $ hf extensions search Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf extensions update` Atualize a(s) extensão(ões) instalada(s) para a(s) sua(s) versão(ões) mais recente(s). **Uso**: ```console $ hf extensions update [OPTIONS] [NAME] ``` **Argumentos**: * `[NAME]`: Extensão a ser atualizada (com ou sem o prefixo `hf-`, opcionalmente como `OWNER/hf-`). Se omitido, todas as extensões instaladas são verificadas e as desatualizadas são atualizadas. **Opções**: * `--help`: Exibe esta mensagem e sai. Exemplos $ hf extensions update $ hf extensions update hf-claude $ hf extensions update alvarobartt/hf-mem Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ## `hf jobs` Execute e gerencie Jobs no Hub. **Uso**: ```console $ hf jobs [OPTIONS] COMMAND [ARGS]... ``` **Opções**: * `--help`: Exibe esta mensagem e sai. **Comandos**: * `cancel`: Cancelar um Job * `expose`: Substitui as portas expostas em um Job em execução. * `hardware`: Lista as opções de hardware disponíveis para Jobs * `inspect`: Exibe informações detalhadas sobre um ou mais Jobs * `labels`: Atualiza os rótulos de um Job. * `list`: Lista os trabalhos. [alias: ls, ps] * `logs`: Obter os logs de um Job. * `rerun`: Executa um novo Job com a especificação de um Job existente. * `run`: Executa um Job. * `scheduled`: Crie e gerencie Jobs agendados no Hub. * `ssh`: Conectar via SSH a um Job em execução. * `stats`: Obter as estatísticas e métricas de uso de recursos dos Jobs. * `uv`: Execute scripts UV (Python com dependências inline) na infraestrutura do HF. * `wait`: Aguarda que um ou mais Jobs atinjam um estado terminal. ### `hf jobs cancel` Cancelar um Job **Uso**: ```console $ hf jobs cancel [OPTIONS] JOB_ID ``` **Argumentos**: * `JOB_ID`: ID do trabalho (ou 'namespace/job_id') [obrigatório] **Opções**: * `--namespace TEXT`: O namespace onde o job será executado. O padrão é o namespace do usuário atual. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos hf jobs cancel Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf jobs expose` Substitua as portas expostas em um Job em execução. **Uso**: ```console $ hf jobs expose [OPTIONS] JOB_ID [PORTS]... ``` **Argumentos**: * `JOB_ID`: ID do trabalho (ou 'namespace/job_id') [obrigatório] * `[PORTS]...`: Portas a serem expostas através do proxy de jobs. O acesso requer um token do HF com permissão de leitura no namespace do job. **Opções**: * `--public INTEGER`: Expõe uma porta sem autenticação. Repita a flag para múltiplas portas. Não é necessário passar a porta também como argumento posicional. * `--clear`: Fecha todas as portas expostas. * `--namespace TEXT`: O namespace onde o job será executado. O padrão é o namespace do usuário atual. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf jobs expose 8000 $ hf jobs expose 8000 --public 9000 $ hf jobs expose --clear Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf jobs hardware` Listar as opções de hardware disponíveis para Jobs **Uso**: ```console $ hf jobs hardware [OPTIONS] ``` **Opções**: * `--help`: Exibe esta mensagem e sai. Exemplos hf jobs hardware Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf jobs inspect` Exibir informações detalhadas sobre um ou mais Jobs **Uso**: ```console $ hf jobs inspect [OPTIONS] JOB_IDS... ``` **Argumentos**: * `JOB_IDS...`: IDs dos jobs a inspecionar (ou 'namespace/job_id') [obrigatório] **Opções**: * `--namespace TEXT`: O namespace onde o job será executado. O padrão é o namespace do usuário atual. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf jobs inspect Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf jobs labels` Atualize os rótulos de um Job. Passar --label substitui todos os rótulos existentes; passar apenas --name os mantém. **Uso**: ```console $ hf jobs labels [OPTIONS] JOB_ID ``` **Argumentos**: * `JOB_ID`: ID do trabalho (ou 'namespace/job_id') [obrigatório] **Opções**: * `--name TEXT`: Nomeia o Job. Armazenado como o rótulo `name`. Os nomes não precisam ser únicos. O padrão é o nome da imagem ou do script mais um hash curto da configuração de inicialização resolvida. * `-l, --label TEXT`: Define rótulos. Ex.: --label KEY=VALUE ou --label LABEL * `--clear`: Remove todos os rótulos do job. * `--namespace TEXT`: O namespace onde o job será executado. O padrão é o namespace do usuário atual. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf jobs labels --name training-v2 $ hf jobs labels --label env=prod --label team=ml $ hf jobs labels --clear Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf jobs list | ls | ps` Listar Jobs. Use `--status` para filtrar por status (veja [JobStage](/docs/huggingface_hub/v2.4.0/pt/package_reference/jobs#huggingface_hub.JobStage) para os valores possíveis) e `--label` para filtrar por rótulos `key=value`. Um Job deve corresponder a todos os filtros para ser listado. **Uso**: ```console $ hf jobs list | ls | ps [OPTIONS] ``` **Opções**: * `-a, --all`: Exibe todos os Jobs (por padrão, exibe os em execução e agendados). Não pode ser combinado com --status. * `--status [COMPLETED|CANCELED|ERROR|DELETED|SCHEDULING|RUNNING]`: Mostra apenas Jobs com o status indicado. Separado por vírgulas ou repetido, por exemplo, `--status running,scheduling`. * `-l, --label TEXT`: Mostra apenas Jobs com o rótulo `key=value` especificado. Repita para exigir vários rótulos, por exemplo, `--label env=prod --label team=ml`. * `--name TEXT`: Mostra apenas Jobs com o nome especificado (atalho para `--label name=NAME`). * `--limit INTEGER`: Número máximo de Jobs a exibir. Defina como 0 para exibir todos (sem limite). [padrão: 100] * `--namespace TEXT`: O namespace onde o job será executado. O padrão é o namespace do usuário atual. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ 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 Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf jobs logs` Obtenha os logs de um Job. Por padrão, imprime os logs atualmente disponíveis e sai (não bloqueante). Use --follow/-f para transmitir os logs em tempo real até que o trabalho seja concluído. Use --tail/-n para limitar o número de linhas retornadas (no lado do servidor, quando suportado). Observação: o comando a seguir encerra quando o fluxo de logs termina, independentemente de o Job ter tido sucesso ou falha. Execute `hf jobs inspect ` para verificar o status final. **Uso**: ```console $ hf jobs logs [OPTIONS] JOB_ID ``` **Argumentos**: * `JOB_ID`: ID do trabalho (ou 'namespace/job_id') [obrigatório] **Opções**: * `-f, --follow`: Acompanha a saída do log (transmite até a conclusão do job). Sem essa flag, apenas os logs atualmente disponíveis são exibidos. * `-n, --tail INTEGER`: Número de linhas a exibir a partir do final dos logs. Quando combinado com --follow, inicia o streaming a partir das últimas N linhas. * `--namespace TEXT`: O namespace onde o job será executado. O padrão é o namespace do usuário atual. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf jobs logs $ hf jobs logs -f $ hf jobs logs --tail 20 $ hf jobs logs -f --tail 100 Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf jobs rerun` Execute um novo Job com a especificação de um Job existente. **Uso**: ```console $ hf jobs rerun [OPTIONS] JOB_ID ``` **Argumentos**: * `JOB_ID`: ID do trabalho (ou 'namespace/job_id') [obrigatório] **Opções**: * `-d, --detach`: Executa o Job em segundo plano e imprime o ID do Job. * `--namespace TEXT`: O namespace onde o job será executado. O padrão é o namespace do usuário atual. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf jobs rerun $ hf jobs rerun --detach Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf jobs run` Executar um Job. **Uso**: ```console $ hf jobs run [OPTIONS] IMAGE COMMAND... ``` **Argumentos**: * `IMAGE`: A imagem Docker a ser usada. [obrigatório] * `COMMAND...`: O comando a ser executado. [obrigatório] **Opções**: * `-e, --env TEXT`: Define variáveis de ambiente. Ex.: --env ENV=value * `-s, --secrets TEXT`: Define variáveis de ambiente secretas. Prefira `--secrets SECRET` para ler o valor do seu ambiente (por exemplo, `--secrets HF_TOKEN` para passar seu token do Hugging Face); `--secrets SECRET=value` coloca o valor no histórico do seu shell. * `--name TEXT`: Nomeia o Job. Armazenado como o rótulo `name`. Os nomes não precisam ser únicos. O padrão é o nome da imagem ou do script mais um hash curto da configuração de inicialização resolvida. * `-l, --label TEXT`: Define rótulos. Ex.: --label KEY=VALUE ou --label LABEL * `-v, --volume TEXT`: Monta um ou mais volumes. Formato: hf://[TYPE/]SOURCE:/MOUNT_PATH[:ro|:rw] ou LOCAL_DIR:/MOUNT_PATH[:ro|:rw]. TYPE é um dos seguintes: models, datasets, spaces, buckets. Se omitido, TYPE padrão é models. models, datasets e spaces são sempre montados somente leitura. buckets são leitura+escrita por padrão. Uma origem de diretório local é primeiro sincronizada para um bucket e montada somente leitura por padrão. Ex.: -v hf://datasets/org/ds:/data ou -v hf://buckets/org/b:/mnt:ro ou -v ./inputs:/inputs * `--env-file TEXT`: Lê um arquivo de variáveis de ambiente. Use `-` para lê-las do stdin. * `--secrets-file TEXT`: Lê um arquivo de variáveis de ambiente secretas. Use `-` para lê-las do 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 do hardware. Execute 'hf jobs hardware' para listar os flavors disponíveis. O padrão é `cpu-basic`. * `--timeout TEXT`: Duração máxima: int com s (segundos, padrão), m (minutos), h (horas) ou d (dias). * `--attempts INTEGER RANGE`: Tentativas máximas, incluindo a primeira execução. Padrão: 1. [x>=1] * `-d, --detach`: Executa o Job em segundo plano e imprime o ID do Job. * `--dry-run`: Imprime a configuração resolvida do Job sem submetê-lo. * `--expose INTEGER`: Expõe uma porta do contêiner através do proxy de jobs. Repita a flag para múltiplas portas (por exemplo, `--expose 8000 --expose 8001`). Cada porta exposta é acessível no domínio público de jobs; o acesso requer um token HF com permissão de leitura no namespace do job. * `--expose-public INTEGER`: Expõe uma porta do container através do proxy de jobs sem autenticação. Repita a flag para múltiplas portas. Não é necessário passar a porta também com `--expose`. * `--ssh`: Torna o container do job acessível via SSH. Conecte-se com `hf jobs ssh `. Requer uma chave pública SSH registrada em https://huggingface.co/settings/keys. * `--network-group TEXT`: Adiciona a um grupo de rede. Jobs no mesmo namespace e resource group que compartilham um grupo são colocados juntos e se alcançam em todas as portas. Dentro de cada membro, `$HF_NETWORK_GROUP_HOSTNAME` resolve para todos os membros. Alfanuméricos minúsculos e hífens, no máximo 46 caracteres. * `--network-alias TEXT`: Solicita um alias no grupo de rede. Os membros acessam os jobs que o solicitam em `${HF_NETWORK_GROUP_PREFIX}`. Repita a flag para vários aliases. Alfanuméricos minúsculos e hífens, no máximo 34 caracteres, único dentro do job. Exige `--network-group`. * `--resource-group-id TEXT`: O ID do grupo de recursos em que o Job será criado. Usado para controlar o acesso a recursos dentro de uma organização e para recursos de atribuição de custos/limites de gastos. * `--namespace TEXT`: O namespace onde o job será executado. O padrão é o namespace do usuário atual. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--format [agent|auto|human|json|quiet]`: Formato de saída. O padrão é 'auto', que seleciona 'agent' ou 'human' com base no terminal. * `--json`: saída em JSON. Equivalente a '--format json'. * `-q, --quiet`: Saída silenciosa (um ID por linha). Equivalente a '--format quiet'. * `--help`: Exibe esta mensagem e sai. Exemplos $ 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 Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf jobs scheduled` Crie e gerencie Jobs agendados no Hub. **Uso**: ```console $ hf jobs scheduled [OPTIONS] COMMAND [ARGS]... ``` **Opções**: * `--help`: Exibe esta mensagem e sai. **Comandos**: * `delete`: Exclui um Job agendado. * `inspect`: Exibe informações detalhadas sobre um ou mais Jobs agendados * `labels`: Atualiza os rótulos em um Job agendado. * `list`: Lista os Jobs agendados. [alias: ls, ps] * `reschedule`: Altera quando um Job agendado é executado. * `resume`: Retoma (despausa) um Job agendado. * `run`: Agendar um Job. * `suspend`: Suspender (pausar) um Job agendado. * `trigger`: Dispara a execução imediata de um Job agendado (não altera o agendamento). * `uv`: Agende scripts UV na infraestrutura do HF. #### `hf jobs scheduled delete` Excluir um Job agendado. **Uso**: ```console $ hf jobs scheduled delete [OPTIONS] SCHEDULED_JOB_ID ``` **Argumentos**: * `SCHEDULED_JOB_ID`: ID do Job Agendado (ou 'namespace/scheduled_job_id') [obrigatório] **Opções**: * `--namespace TEXT`: O namespace onde o job será executado. O padrão é o namespace do usuário atual. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos hf jobs scheduled delete Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli #### `hf jobs scheduled inspect` Exibir informações detalhadas sobre um ou mais Jobs agendados **Uso**: ```console $ hf jobs scheduled inspect [OPTIONS] SCHEDULED_JOB_IDS... ``` **Argumentos**: * `SCHEDULED_JOB_IDS...`: IDs de Jobs Agendados para inspecionar (ou 'namespace/scheduled_job_id') [obrigatório] **Opções**: * `--namespace TEXT`: O namespace onde o job será executado. O padrão é o namespace do usuário atual. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf jobs scheduled inspect Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli #### `hf jobs scheduled labels` Atualize os rótulos em um Job agendado. Passar --label substitui todos os rótulos existentes; passar apenas --name os mantém. **Uso**: ```console $ hf jobs scheduled labels [OPTIONS] SCHEDULED_JOB_ID ``` **Argumentos**: * `SCHEDULED_JOB_ID`: ID do Job Agendado (ou 'namespace/scheduled_job_id') [obrigatório] **Opções**: * `--name TEXT`: Nomeia o Job. Armazenado como o rótulo `name`. Os nomes não precisam ser únicos. O padrão é o nome da imagem ou do script mais um hash curto da configuração de inicialização resolvida. * `-l, --label TEXT`: Define rótulos. Ex.: --label KEY=VALUE ou --label LABEL * `--clear`: Remove todos os rótulos do agendamento. * `--namespace TEXT`: O namespace onde o job será executado. O padrão é o namespace do usuário atual. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf jobs scheduled labels --name daily-script $ hf jobs scheduled labels --label env=prod --label team=ml $ hf jobs scheduled labels --clear Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli #### `hf jobs scheduled list | ls | ps` Listar Jobs agendados. Use `--status` para filtrar por status (`active` ou `suspended`) e `--label` para filtrar por rótulos `key=value`. Um Job agendado deve corresponder a todos os filtros para ser listado. **Uso**: ```console $ hf jobs scheduled list | ls | ps [OPTIONS] ``` **Opções**: * `-a, --all`: Exibe todos os Jobs agendados (por padrão, os suspensos ficam ocultos). Não pode ser combinado com --status. * `--status [active|suspended]`: Mostra apenas Jobs agendados com o status indicado. Separado por vírgulas ou repetido, por exemplo, `--status suspended`. * `-l, --label TEXT`: Mostra apenas Jobs agendados com o rótulo `key=value` especificado. Repita para exigir vários rótulos, por exemplo, `--label env=prod --label team=ml`. * `--name TEXT`: Mostra apenas Jobs agendados com o nome especificado (atalho para `--label name=NAME`). * `--namespace TEXT`: O namespace onde o job será executado. O padrão é o namespace do usuário atual. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ 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 Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli #### `hf jobs scheduled reschedule` Alterar quando um Job agendado é executado. **Uso**: ```console $ hf jobs scheduled reschedule [OPTIONS] SCHEDULED_JOB_ID SCHEDULE ``` **Argumentos**: * `SCHEDULED_JOB_ID`: ID do Job Agendado (ou 'namespace/scheduled_job_id') [obrigatório] * `SCHEDULE`: Um dos valores @annually, @yearly, @monthly, @weekly, @daily, @hourly, ou uma expressão de agendamento CRON. [obrigatório] **Opções**: * `--namespace TEXT`: O namespace onde o job será executado. O padrão é o namespace do usuário atual. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf jobs scheduled reschedule "0 9 * * 1" Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli #### `hf jobs scheduled resume` Resume (retomar) um Job agendado. **Uso**: ```console $ hf jobs scheduled resume [OPTIONS] SCHEDULED_JOB_ID ``` **Argumentos**: * `SCHEDULED_JOB_ID`: ID do Job Agendado (ou 'namespace/scheduled_job_id') [obrigatório] **Opções**: * `--namespace TEXT`: O namespace onde o job será executado. O padrão é o namespace do usuário atual. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos hf jobs scheduled resume Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli #### `hf jobs scheduled run` Agendar um Job. **Uso**: ```console $ hf jobs scheduled run [OPTIONS] SCHEDULE IMAGE COMMAND... ``` **Argumentos**: * `SCHEDULE`: Um dos valores @annually, @yearly, @monthly, @weekly, @daily, @hourly, ou uma expressão de agendamento CRON. [obrigatório] * `IMAGE`: A imagem Docker a ser usada. [obrigatório] * `COMMAND...`: O comando a ser executado. [obrigatório] **Opções**: * `--suspend / --no-suspend`: Suspender (pausar) o Job agendado * `--concurrency / --no-concurrency`: Permite que múltiplas instâncias deste Job sejam executadas simultaneamente * `-e, --env TEXT`: Define variáveis de ambiente. Ex.: --env ENV=value * `-s, --secrets TEXT`: Define variáveis de ambiente secretas. Prefira `--secrets SECRET` para ler o valor do seu ambiente (por exemplo, `--secrets HF_TOKEN` para passar seu token do Hugging Face); `--secrets SECRET=value` coloca o valor no histórico do seu shell. * `--name TEXT`: Nomeia o Job. Armazenado como o rótulo `name`. Os nomes não precisam ser únicos. O padrão é o nome da imagem ou do script mais um hash curto da configuração de inicialização resolvida. * `-l, --label TEXT`: Define rótulos. Ex.: --label KEY=VALUE ou --label LABEL * `-v, --volume TEXT`: Monta um ou mais volumes. Formato: hf://[TYPE/]SOURCE:/MOUNT_PATH[:ro|:rw] ou LOCAL_DIR:/MOUNT_PATH[:ro|:rw]. TYPE é um dos seguintes: models, datasets, spaces, buckets. Se omitido, TYPE padrão é models. models, datasets e spaces são sempre montados somente leitura. buckets são leitura+escrita por padrão. Uma origem de diretório local é primeiro sincronizada para um bucket e montada somente leitura por padrão. Ex.: -v hf://datasets/org/ds:/data ou -v hf://buckets/org/b:/mnt:ro ou -v ./inputs:/inputs * `--env-file TEXT`: Lê um arquivo de variáveis de ambiente. Use `-` para lê-las do stdin. * `--secrets-file TEXT`: Lê um arquivo de variáveis de ambiente secretas. Use `-` para lê-las do 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 do hardware. Execute 'hf jobs hardware' para listar os flavors disponíveis. O padrão é `cpu-basic`. * `--timeout TEXT`: Duração máxima: int com s (segundos, padrão), m (minutos), h (horas) ou d (dias). * `--attempts INTEGER RANGE`: Tentativas máximas, incluindo a primeira execução. Padrão: 1. [x>=1] * `--dry-run`: Imprime a configuração resolvida do Job sem submetê-lo. * `--expose INTEGER`: Expõe uma porta do contêiner através do proxy de jobs. Repita a flag para múltiplas portas (por exemplo, `--expose 8000 --expose 8001`). Cada porta exposta é acessível no domínio público de jobs; o acesso requer um token HF com permissão de leitura no namespace do job. * `--expose-public INTEGER`: Expõe uma porta do container através do proxy de jobs sem autenticação. Repita a flag para múltiplas portas. Não é necessário passar a porta também com `--expose`. * `--resource-group-id TEXT`: O ID do grupo de recursos em que o Job será criado. Usado para controlar o acesso a recursos dentro de uma organização e para recursos de atribuição de custos/limites de gastos. * `--namespace TEXT`: O namespace onde o job será executado. O padrão é o namespace do usuário atual. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--format [agent|auto|human|json|quiet]`: Formato de saída. O padrão é 'auto', que seleciona 'agent' ou 'human' com base no terminal. * `--json`: saída em JSON. Equivalente a '--format json'. * `-q, --quiet`: Saída silenciosa (um ID por linha). Equivalente a '--format quiet'. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf jobs scheduled run "0 0 * * *" --name daily-script python:3.12 python script.py Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli #### `hf jobs scheduled suspend` Suspend (pausa) um Job agendado. **Uso**: ```console $ hf jobs scheduled suspend [OPTIONS] SCHEDULED_JOB_ID ``` **Argumentos**: * `SCHEDULED_JOB_ID`: ID do Job Agendado (ou 'namespace/scheduled_job_id') [obrigatório] **Opções**: * `--namespace TEXT`: O namespace onde o job será executado. O padrão é o namespace do usuário atual. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos hf jobs scheduled suspend Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli #### `hf jobs scheduled trigger` Disparar a execução imediata de um Job agendado (não altera o agendamento). **Uso**: ```console $ hf jobs scheduled trigger [OPTIONS] SCHEDULED_JOB_ID ``` **Argumentos**: * `SCHEDULED_JOB_ID`: ID do Job Agendado (ou 'namespace/scheduled_job_id') [obrigatório] **Opções**: * `--namespace TEXT`: O namespace onde o job será executado. O padrão é o namespace do usuário atual. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos hf jobs scheduled trigger Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli #### `hf jobs scheduled uv` Agende scripts UV na infraestrutura do HF. **Uso**: ```console $ hf jobs scheduled uv [OPTIONS] COMMAND [ARGS]... ``` **Opções**: * `--help`: Exibe esta mensagem e sai. **Comandos**: * `run`: Executa um script UV (arquivo local ou URL) na infraestrutura do HF ##### `hf jobs scheduled uv run` Execute um script UV (arquivo local ou URL) na infraestrutura do HF **Uso**: ```console $ hf jobs scheduled uv run [OPTIONS] SCHEDULE SCRIPT [SCRIPT_ARGS]... ``` **Argumentos**: * `SCHEDULE`: Um dos valores @annually, @yearly, @monthly, @weekly, @daily, @hourly, ou uma expressão de agendamento CRON. [obrigatório] * `SCRIPT`: script UV para executar (arquivo local ou URL) [obrigatório] * `[SCRIPT_ARGS]...`: Argumentos para o script **Opções**: * `--suspend / --no-suspend`: Suspender (pausar) o Job agendado * `--concurrency / --no-concurrency`: Permite que múltiplas instâncias deste Job sejam executadas simultaneamente * `--image TEXT`: Use uma imagem Docker personalizada com `uv` instalado. * `--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 do hardware. Execute 'hf jobs hardware' para listar os flavors disponíveis. O padrão é `cpu-basic`. * `-e, --env TEXT`: Define variáveis de ambiente. Ex.: --env ENV=value * `-s, --secrets TEXT`: Define variáveis de ambiente secretas. Prefira `--secrets SECRET` para ler o valor do seu ambiente (por exemplo, `--secrets HF_TOKEN` para passar seu token do Hugging Face); `--secrets SECRET=value` coloca o valor no histórico do seu shell. * `--name TEXT`: Nomeia o Job. Armazenado como o rótulo `name`. Os nomes não precisam ser únicos. O padrão é o nome da imagem ou do script mais um hash curto da configuração de inicialização resolvida. * `-l, --label TEXT`: Define rótulos. Ex.: --label KEY=VALUE ou --label LABEL * `-v, --volume TEXT`: Monta um ou mais volumes. Formato: hf://[TYPE/]SOURCE:/MOUNT_PATH[:ro|:rw] ou LOCAL_DIR:/MOUNT_PATH[:ro|:rw]. TYPE é um dos seguintes: models, datasets, spaces, buckets. Se omitido, TYPE padrão é models. models, datasets e spaces são sempre montados somente leitura. buckets são leitura+escrita por padrão. Uma origem de diretório local é primeiro sincronizada para um bucket e montada somente leitura por padrão. Ex.: -v hf://datasets/org/ds:/data ou -v hf://buckets/org/b:/mnt:ro ou -v ./inputs:/inputs * `--env-file TEXT`: Lê um arquivo de variáveis de ambiente. Use `-` para lê-las do stdin. * `--secrets-file TEXT`: Lê um arquivo de variáveis de ambiente secretas. Use `-` para lê-las do stdin. * `--timeout TEXT`: Duração máxima: int com s (segundos, padrão), m (minutos), h (horas) ou d (dias). * `--attempts INTEGER RANGE`: Tentativas máximas, incluindo a primeira execução. Padrão: 1. [x>=1] * `--dry-run`: Imprime a configuração resolvida do Job sem submetê-lo. * `--expose INTEGER`: Expõe uma porta do contêiner através do proxy de jobs. Repita a flag para múltiplas portas (por exemplo, `--expose 8000 --expose 8001`). Cada porta exposta é acessível no domínio público de jobs; o acesso requer um token HF com permissão de leitura no namespace do job. * `--expose-public INTEGER`: Expõe uma porta do container através do proxy de jobs sem autenticação. Repita a flag para múltiplas portas. Não é necessário passar a porta também com `--expose`. * `--resource-group-id TEXT`: O ID do grupo de recursos em que o Job será criado. Usado para controlar o acesso a recursos dentro de uma organização e para recursos de atribuição de custos/limites de gastos. * `--namespace TEXT`: O namespace onde o job será executado. O padrão é o namespace do usuário atual. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--with TEXT`: Executa com os pacotes especificados instalados * `-p, --python TEXT`: O interpretador Python a ser usado para o ambiente de execução * `--format [agent|auto|human|json|quiet]`: Formato de saída. O padrão é 'auto', que seleciona 'agent' ou 'human' com base no terminal. * `--json`: saída em JSON. Equivalente a '--format json'. * `-q, --quiet`: Saída silenciosa (um ID por linha). Equivalente a '--format quiet'. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf jobs scheduled uv run "0 0 * * *" --name daily-script script.py $ hf jobs scheduled uv run "0 0 * * *" script.py --with pandas Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf jobs ssh` Faça SSH em um Job em execução. Se o Job ainda não estiver em execução, aguarda até que ele atinja o estado RUNNING antes de conectar. Exige que o Job tenha sido iniciado com SSH habilitado (`hf jobs run --ssh ...`) e que sua chave pública SSH esteja registrada em https://huggingface.co/settings/keys. **Uso**: ```console $ hf jobs ssh [OPTIONS] JOB_ID ``` **Argumentos**: * `JOB_ID`: ID do trabalho (ou 'namespace/job_id') [obrigatório] **Opções**: * `-i, --identity-file PATH`: Caminho para o arquivo de identidade SSH (encaminhado para `ssh -i`). * `--dry-run`: Imprime o comando SSH em vez de executá-lo. * `--namespace TEXT`: O namespace onde o job será executado. O padrão é o namespace do usuário atual. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf jobs ssh $ hf jobs ssh --dry-run $ hf jobs ssh -i ~/.ssh/id_ed25519 Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf jobs stats` Obtenha as estatísticas e métricas de uso de recursos dos Jobs. Por padrão, imprime um instantâneo das estatísticas atuais e sai (não bloqueante). Use --follow/-f para exibir estatísticas em tempo real até que os Jobs sejam concluídos. **Uso**: ```console $ hf jobs stats [OPTIONS] [JOB_IDS]... ``` **Argumentos**: * `[JOB_IDS]...`: IDs de trabalho (ou 'namespace/job_id') **Opções**: * `-f, --follow`: Acompanha a saída de estatísticas (visualização ao vivo até que os Jobs sejam concluídos). Sem essa flag, um único instantâneo é exibido. * `--namespace TEXT`: O namespace onde o job será executado. O padrão é o namespace do usuário atual. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf jobs stats $ hf jobs stats $ hf jobs stats -f Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf jobs uv` Execute scripts UV (Python com dependências inline) na infraestrutura do HF. **Uso**: ```console $ hf jobs uv [OPTIONS] COMMAND [ARGS]... ``` **Opções**: * `--help`: Exibe esta mensagem e sai. **Comandos**: * `run`: Executa um script UV (arquivo local ou URL) na infraestrutura do HF #### `hf jobs uv run` Execute um script UV (arquivo local ou URL) na infraestrutura do HF **Uso**: ```console $ hf jobs uv run [OPTIONS] SCRIPT [SCRIPT_ARGS]... ``` **Argumentos**: * `SCRIPT`: script UV para executar (arquivo local ou URL) [obrigatório] * `[SCRIPT_ARGS]...`: Argumentos para o script **Opções**: * `--image TEXT`: Use uma imagem Docker personalizada com `uv` instalado. * `--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 do hardware. Execute 'hf jobs hardware' para listar os flavors disponíveis. O padrão é `cpu-basic`. * `-e, --env TEXT`: Define variáveis de ambiente. Ex.: --env ENV=value * `-s, --secrets TEXT`: Define variáveis de ambiente secretas. Prefira `--secrets SECRET` para ler o valor do seu ambiente (por exemplo, `--secrets HF_TOKEN` para passar seu token do Hugging Face); `--secrets SECRET=value` coloca o valor no histórico do seu shell. * `--name TEXT`: Nomeia o Job. Armazenado como o rótulo `name`. Os nomes não precisam ser únicos. O padrão é o nome da imagem ou do script mais um hash curto da configuração de inicialização resolvida. * `-l, --label TEXT`: Define rótulos. Ex.: --label KEY=VALUE ou --label LABEL * `-v, --volume TEXT`: Monta um ou mais volumes. Formato: hf://[TYPE/]SOURCE:/MOUNT_PATH[:ro|:rw] ou LOCAL_DIR:/MOUNT_PATH[:ro|:rw]. TYPE é um dos seguintes: models, datasets, spaces, buckets. Se omitido, TYPE padrão é models. models, datasets e spaces são sempre montados somente leitura. buckets são leitura+escrita por padrão. Uma origem de diretório local é primeiro sincronizada para um bucket e montada somente leitura por padrão. Ex.: -v hf://datasets/org/ds:/data ou -v hf://buckets/org/b:/mnt:ro ou -v ./inputs:/inputs * `--env-file TEXT`: Lê um arquivo de variáveis de ambiente. Use `-` para lê-las do stdin. * `--secrets-file TEXT`: Lê um arquivo de variáveis de ambiente secretas. Use `-` para lê-las do stdin. * `--timeout TEXT`: Duração máxima: int com s (segundos, padrão), m (minutos), h (horas) ou d (dias). * `--attempts INTEGER RANGE`: Tentativas máximas, incluindo a primeira execução. Padrão: 1. [x>=1] * `-d, --detach`: Executa o Job em segundo plano e imprime o ID do Job. * `--dry-run`: Imprime a configuração resolvida do Job sem submetê-lo. * `--expose INTEGER`: Expõe uma porta do contêiner através do proxy de jobs. Repita a flag para múltiplas portas (por exemplo, `--expose 8000 --expose 8001`). Cada porta exposta é acessível no domínio público de jobs; o acesso requer um token HF com permissão de leitura no namespace do job. * `--expose-public INTEGER`: Expõe uma porta do container através do proxy de jobs sem autenticação. Repita a flag para múltiplas portas. Não é necessário passar a porta também com `--expose`. * `--ssh`: Torna o container do job acessível via SSH. Conecte-se com `hf jobs ssh `. Requer uma chave pública SSH registrada em https://huggingface.co/settings/keys. * `--network-group TEXT`: Adiciona a um grupo de rede. Jobs no mesmo namespace e resource group que compartilham um grupo são colocados juntos e se alcançam em todas as portas. Dentro de cada membro, `$HF_NETWORK_GROUP_HOSTNAME` resolve para todos os membros. Alfanuméricos minúsculos e hífens, no máximo 46 caracteres. * `--network-alias TEXT`: Solicita um alias no grupo de rede. Os membros acessam os jobs que o solicitam em `${HF_NETWORK_GROUP_PREFIX}`. Repita a flag para vários aliases. Alfanuméricos minúsculos e hífens, no máximo 34 caracteres, único dentro do job. Exige `--network-group`. * `--resource-group-id TEXT`: O ID do grupo de recursos em que o Job será criado. Usado para controlar o acesso a recursos dentro de uma organização e para recursos de atribuição de custos/limites de gastos. * `--namespace TEXT`: O namespace onde o job será executado. O padrão é o namespace do usuário atual. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--with TEXT`: Executa com os pacotes especificados instalados * `-p, --python TEXT`: O interpretador Python a ser usado para o ambiente de execução * `--format [agent|auto|human|json|quiet]`: Formato de saída. O padrão é 'auto', que seleciona 'agent' ou 'human' com base no terminal. * `--json`: saída em JSON. Equivalente a '--format json'. * `-q, --quiet`: Saída silenciosa (um ID por linha). Equivalente a '--format quiet'. * `--help`: Exibe esta mensagem e sai. Exemplos $ 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 Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf jobs wait` Aguarde um ou mais Jobs atingirem um estado terminal. Bloqueia até que todos os Jobs tenham finalizado, em seguida, encerra com código 0 se todos os Jobs foram concluídos com sucesso, ou com um código de saída não nulo se algum Job foi cancelado, apresentou erro ou foi excluído. Todos os Jobs devem pertencer ao mesmo namespace. **Uso**: ```console $ hf jobs wait [OPTIONS] JOB_IDS... ``` **Argumentos**: * `JOB_IDS...`: IDs dos jobs para aguardar (ou 'namespace/job_id'). [obrigatório] **Opções**: * `--timeout TEXT`: Tempo máximo de espera: int com s (segundos, padrão), m (minutos), h (horas) ou d (dias). * `--namespace TEXT`: O namespace onde o job será executado. O padrão é o namespace do usuário atual. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf jobs wait $ hf jobs wait $ hf jobs ls -q | xargs hf jobs wait Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ## `hf lfs-enable-largefiles` Configure seu repositório para permitir o upload de arquivos > 5GB. Este comando configura o git-lfs para usar o agente de transferência multipart personalizado, que permite o upload eficiente de arquivos grandes em blocos. **Uso**: ```console $ hf lfs-enable-largefiles [OPTIONS] PATH ``` **Argumentos**: * `PATH`: Caminho local para o repositório que você deseja configurar. [obrigatório] **Opções**: * `--help`: Exibe esta mensagem e sai. ## `hf lfs-multipart-upload` Agente de transferência personalizado do git-lfs interno para uploads multipart. Esta função implementa o protocolo de transferência personalizado para uploads multipart do git-lfs. Trata uploads em blocos de arquivos grandes para o Hugging Face Hub. **Uso**: ```console $ hf lfs-multipart-upload [OPTIONS] ``` **Opções**: * `--help`: Exibe esta mensagem e sai. ## `hf models` Interaja com modelos no Hub. **Uso**: ```console $ hf models [OPTIONS] COMMAND [ARGS]... ``` **Opções**: * `--help`: Exibe esta mensagem e sai. **Comandos**: * `card`: Obter o card do modelo (README) para um modelo no Hub. * `info`: Obter informações sobre um modelo no Hub. * `list`: Lista modelos no Hub ou arquivos em um repositório de modelo. [alias: ls] ### `hf models card` Obtenha o cartão do modelo (README) de um modelo no Hub. **Uso**: ```console $ hf models card [OPTIONS] MODEL_ID ``` **Argumentos**: * `MODEL_ID`: O ID do modelo (por exemplo, `username/repo-name`). [obrigatório] **Opções**: * `--metadata`: Exibe apenas os metadados do card. * `--text`: Exibe apenas o corpo do texto (sem metadados). * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ 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 Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf models info` Obtenha informações sobre um modelo no Hub. **Uso**: ```console $ hf models info [OPTIONS] MODEL_ID ``` **Argumentos**: * `MODEL_ID`: O ID do modelo (por exemplo, `username/repo-name`). [obrigatório] **Opções**: * `--revision TEXT`: id da revisão Git, que pode ser um nome de branch, uma tag ou um hash de commit. * `--expand TEXT`: Propriedades separadas por vírgulas para retornar. Quando usado, apenas as propriedades listadas (e id) são retornadas. Exemplo: '--expand=downloads,likes,tags'. Válidos: 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`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf models info meta-llama/Llama-3.2-1B-Instruct $ hf models info Qwen/Qwen3.5-9B --expand downloads,likes,tags Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf models list` Liste modelos no Hub ou arquivos em um repositório de modelo. [alias: ls] Quando chamado sem argumentos, lista os modelos no Hub. Quando chamado com um ID de modelo, lista os arquivos no repositório desse modelo. **Uso**: ```console $ hf models list [OPTIONS] [REPO_ID] ``` **Argumentos**: * `[REPO_ID]`: ID do modelo (por exemplo, `username/repo-name`) para listar os arquivos. Se omitido, lista os modelos. **Opções**: * `--search TEXT`: Consulta de pesquisa. * `--author TEXT`: Filtrar por autor ou organização. * `--filter TEXT`: Filtra por tags (por exemplo, 'text-classification'). Pode ser usado várias vezes. * `--pipeline-tag TEXT`: Filtrar por tag de pipeline (tarefa canônica), por exemplo, 'summarization'. * `--gated / --no-gated`: Filtra pelo status de acesso restrito. Use '--gated' para apenas modelos com acesso restrito e '--no-gated' para apenas modelos sem acesso restrito. * `--apps TEXT`: Filtra por aplicativo(s) que podem executar o modelo, por exemplo, 'ollama' ou 'vllm'. * `--num-parameters TEXT`: Filtra pela contagem de parâmetros, por exemplo, '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]`: Filtra pelos provedores de inferência que servem o modelo, por exemplo, 'fireworks-ai'. * `--warm`: Lista apenas os modelos atualmente servidos por pelo menos um provedor de inferência. * `--sort [created_at|downloads|last_modified|likes|trending_score]`: Ordena os resultados. * `--limit INTEGER`: Limita o número de resultados. [padrão: 30] * `--expand TEXT`: Propriedades separadas por vírgulas para retornar. Quando usado, apenas as propriedades listadas (e id) são retornadas. Exemplo: '--expand=downloads,likes,tags'. Válidos: 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`: Exibe os tamanhos em formato legível por humanos (apenas para listar arquivos). * `--tree`: Lista arquivos em formato de árvore (apenas para listar arquivos). * `-R, --recursive`: Lista arquivos recursivamente (apenas para listar arquivos). * `--revision TEXT`: id da revisão Git, que pode ser um nome de branch, uma tag ou um hash de commit. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ 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 Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ## `hf papers` Interaja com os papers no Hub. **Uso**: ```console $ hf papers [OPTIONS] COMMAND [ARGS]... ``` **Opções**: * `--help`: Exibe esta mensagem e sai. **Comandos**: * `info`: Obter informações sobre um paper no Hub. * `list`: Lista os papers diários no Hub. [alias: ls] * `read`: Lê um artigo como markdown. * `search`: Busca artigos no Hub. ### `hf papers info` Obter informações sobre um paper no Hub. **Uso**: ```console $ hf papers info [OPTIONS] PAPER_ID ``` **Argumentos**: * `PAPER_ID`: O ID do paper no arXiv (ex.: '2502.08025'). [obrigatório] **Opções**: * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf papers info 2601.15621 Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf papers list` Liste os papers diários no Hub. [alias: ls] **Uso**: ```console $ hf papers list [OPTIONS] ``` **Opções**: * `--date TEXT`: Data no formato ISO (AAAA-MM-DD) ou 'today'. * `--week TEXT`: semana ISO para filtrar, por exemplo, '2025-W09'. * `--month TEXT`: Mês para filtrar no formato ISO (AAAA-MM), por exemplo, '2025-02'. * `--submitter TEXT`: Filtrar pelo nome de usuário do remetente. * `--sort [publishedAt|trending]`: Ordena os resultados. * `--limit INTEGER`: Limita o número de resultados. [padrão: 50] * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ 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 Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf papers read` Leia um artigo como markdown. **Uso**: ```console $ hf papers read [OPTIONS] PAPER_ID ``` **Argumentos**: * `PAPER_ID`: O ID do paper no arXiv (ex.: '2502.08025'). [obrigatório] **Opções**: * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf papers read 2601.15621 Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf papers search` Pesquise artigos no Hub. **Uso**: ```console $ hf papers search [OPTIONS] QUERY ``` **Argumentos**: * `QUERY`: String da consulta de pesquisa. [obrigatório] **Opções**: * `--limit INTEGER`: Limita o número de resultados. [padrão: 20] * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf papers search "vision language" $ hf papers search "attention mechanism" --limit 10 $ hf papers search "diffusion" --format json Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ## `hf repos` Gerencie repositórios no Hub. **Uso**: ```console $ hf repos [OPTIONS] COMMAND [ARGS]... ``` **Opções**: * `--help`: Exibe esta mensagem e sai. **Comandos**: * `branch`: Gerencia ramos para um repositório no Hub. * `cp`: Copia arquivos entre caminhos locais, repositórios e buckets. * `create`: Cria um novo repositório no Hub. * `delete`: Exclui um repositório do Hub. * `delete-files`: Exclui arquivos de um repositório no Hub. * `duplicate`: Duplica um repositório no Hub (modelo, conjunto de dados ou Space). * `list`: Lista todos os repositórios (modelos, conjuntos de dados, espaços, buckets) com informações de armazenamento. [alias: ls] * `move`: Move um repositório de um namespace para outro namespace. * `settings`: Atualiza as configurações de um repositório. * `tag`: Gerencia as tags de um repositório no Hub. ### `hf repos branch` Gerencie os ramos de um repositório no Hub. **Uso**: ```console $ hf repos branch [OPTIONS] COMMAND [ARGS]... ``` **Opções**: * `--help`: Exibe esta mensagem e sai. **Comandos**: * `create`: Cria um novo branch para um repositório no Hub. * `delete`: Exclui um branch de um repositório no Hub. #### `hf repos branch create` Crie um novo branch para um repositório no Hub. **Uso**: ```console $ hf repos branch create [OPTIONS] REPO_ID BRANCH ``` **Argumentos**: * `REPO_ID`: O ID do repositório (por exemplo, `username/repo-name` ou `spaces/username/repo-name`). [obrigatório] * `BRANCH`: O nome do branch a ser criado. [obrigatório] **Opções**: * `--revision TEXT`: id da revisão Git, que pode ser um nome de branch, uma tag ou um hash de commit. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--type, --repo-type [model|dataset|space|kernel]`: O tipo de repositório (model, dataset, space ou kernel). [padrão: model] * `--exist-ok / --no-exist-ok`: Se definido como True, não levanta um erro se a branch já existir. [padrão: no-exist-ok] * `--help`: Exibe esta mensagem e sai. Exemplos $ hf repos branch create my-model dev $ hf repos branch create my-model dev --revision abc123 Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli #### `hf repos branch delete` Excluir um branch de um repositório no Hub. **Uso**: ```console $ hf repos branch delete [OPTIONS] REPO_ID BRANCH ``` **Argumentos**: * `REPO_ID`: O ID do repositório (por exemplo, `username/repo-name` ou `spaces/username/repo-name`). [obrigatório] * `BRANCH`: O nome do branch a ser excluído. [obrigatório] **Opções**: * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--type, --repo-type [model|dataset|space|kernel]`: O tipo de repositório (model, dataset, space ou kernel). [padrão: model] * `--help`: Exibe esta mensagem e sai. Exemplos $ hf repos branch delete my-model dev Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf repos cp` Copie arquivos entre caminhos locais, repositórios e buckets. Gerencia uploads (local/stdin -> repositório/bucket), downloads (repositório/bucket -> local/stdout) e cópias remotas (repositório/bucket -> repositório/bucket). Cópias de bucket para repositório e de local para local não são suportadas. Para diretórios, use `hf upload`/`hf download` (repositórios) ou `hf buckets sync` (buckets). Cópias remotas funcionam apenas dentro da mesma região de armazenamento (https://huggingface.co/docs/hub/storage-regions). **Uso**: ```console $ hf repos cp [OPTIONS] SRC [DST] ``` **Argumentos**: * `SRC`: Origem: arquivo local, URI hf:// (repositório ou bucket) ou - para stdin. [obrigatório] * `[DST]`: Destino: caminho local, URI hf:// (repositório ou bucket) ou - para stdout. **Opções**: * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ 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/ Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf repos create` Crie um novo repositório no Hub. **Uso**: ```console $ hf repos create [OPTIONS] REPO_ID ``` **Argumentos**: * `REPO_ID`: O ID do repositório (por exemplo, `username/repo-name` ou `spaces/username/repo-name`). [obrigatório] **Opções**: * `--type, --repo-type [model|dataset|space|kernel]`: O tipo de repositório (model, dataset, space ou kernel). [padrão: model] * `--sdk, --space-sdk TEXT`: tipo de SDK do Hugging Face Spaces. Obrigatório quando --type é definido como 'space'. * `--template TEXT`: Cria um Space a partir de um template oficial. Passe o id do repositório do template (por exemplo, 'SpacesExamples/jupyterlab') ou seu nome curto (por exemplo, 'JupyterLab'). Liste os templates disponíveis com `hf spaces templates`. Somente Spaces. * `--private / --no-private`: Se deve criar um repositório privado caso o repositório não exista no Hub. Ignorado se o repositório já existir. * `--public`: Se o repositório deve ser público. Ignorado se o repositório já existir. * `--protected`: Se o Space deve ser protegido (apenas Spaces). Ignorado se o repositório já existir. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--exist-ok / --no-exist-ok`: Não gera um erro se o repositório já existir. [padrão: no-exist-ok] * `--resource-group-id TEXT`: Grupo de recursos no qual criar o repositório. Grupos de recursos estão disponíveis apenas para organizações Enterprise Hub. * `--region [us|eu]`: Região da nuvem em que o repositório será criado. Pode ser 'us' ou 'eu'. Requer o plano Team ou superior. * `--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]`: Sabor do hardware do Space (por exemplo, 'cpu-basic', 't4-medium', 'l4x4'). Apenas para Spaces. * `--sleep-time INTEGER`: Segundos de inatividade antes de o Space ser colocado em modo de espera. Use -1 para desativar. Somente para Spaces. * `-s, --secrets TEXT`: Define variáveis de ambiente secretas. Prefira `--secrets SECRET` para ler o valor do seu ambiente (por exemplo, `--secrets HF_TOKEN` para passar seu token do Hugging Face); `--secrets SECRET=value` coloca o valor no histórico do seu shell. * `--secrets-file TEXT`: Lê um arquivo de variáveis de ambiente secretas. Use `-` para lê-las do stdin. * `-e, --env TEXT`: Define variáveis de ambiente. Ex.: --env ENV=value * `--env-file TEXT`: Lê um arquivo de variáveis de ambiente. Use `-` para lê-las do stdin. * `-v, --volume TEXT`: Monta um ou mais volumes. Formato: hf://[TYPE/]SOURCE:/MOUNT_PATH[:ro]. TYPE é um dos seguintes: models, datasets, spaces, buckets. Se omitido, TYPE padrão é models. models, datasets e spaces são sempre montados somente leitura. buckets são leitura+escrita por padrão. Ex.: -v hf://org/m:/data ou -v hf://datasets/org/ds:/data ou -v hf://buckets/org/b:/mnt:ro * `--help`: Exibe esta mensagem e sai. Exemplos $ 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 Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf repos delete` Excluir um repositório do Hub. Esta é uma operação irreversível. **Uso**: ```console $ hf repos delete [OPTIONS] REPO_ID ``` **Argumentos**: * `REPO_ID`: O ID do repositório (por exemplo, `username/repo-name` ou `spaces/username/repo-name`). [obrigatório] **Opções**: * `--type, --repo-type [model|dataset|space|kernel]`: O tipo de repositório (model, dataset, space ou kernel). [padrão: model] * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--missing-ok / --no-missing-ok`: Se definido como True, não levanta um erro se o repositório não existir. [padrão: no-missing-ok] * `-y, --yes`: Responde Sim automaticamente ao prompt. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf repos delete my-model Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf repos delete-files` Excluir arquivos de um repositório no Hub. **Uso**: ```console $ hf repos delete-files [OPTIONS] REPO_ID PATTERNS... ``` **Argumentos**: * `REPO_ID`: O ID do repositório (por exemplo, `username/repo-name` ou `spaces/username/repo-name`). [obrigatório] * `PATTERNS...`: Padrões glob para corresponder a arquivos a serem excluídos. Baseado em fnmatch, '*' corresponde a arquivos recursivamente. [obrigatório] **Opções**: * `--type, --repo-type [model|dataset|space|kernel]`: O tipo de repositório (model, dataset, space ou kernel). [padrão: model] * `--revision TEXT`: id da revisão Git, que pode ser um nome de branch, uma tag ou um hash de commit. * `--commit-message TEXT`: O resumo / título / primeira linha do commit gerado. * `--commit-description TEXT`: A descrição do commit gerado. * `--create-pr / --no-create-pr`: Se deve criar um novo Pull Request para essas alterações. [padrão: no-create-pr] * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf repos delete-files my-model file.txt $ hf repos delete-files my-model "*.json" $ hf repos delete-files my-model folder/ Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf repos duplicate` Duplicar um repositório no Hub (modelo, conjunto de dados ou Space). **Uso**: ```console $ hf repos duplicate [OPTIONS] FROM_ID [TO_ID] ``` **Argumentos**: * `FROM_ID`: O ID do repositório (por exemplo, `username/repo-name` ou `spaces/username/repo-name`). [obrigatório] * `[TO_ID]`: ID do repositório de destino (por exemplo, `myorg/my-copy`). O padrão é o seu namespace com o mesmo nome de repositório. **Opções**: * `--type, --repo-type [model|dataset|space|kernel]`: O tipo de repositório (model, dataset, space ou kernel). [padrão: model] * `--private / --no-private`: Se deve criar um repositório privado caso o repositório não exista no Hub. Ignorado se o repositório já existir. * `--public`: Se o repositório deve ser público. Ignorado se o repositório já existir. * `--protected`: Se o Space deve ser protegido (apenas Spaces). Ignorado se o repositório já existir. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--exist-ok / --no-exist-ok`: Não gera um erro se o repositório já existir. [padrão: no-exist-ok] * `--resource-group-id TEXT`: Grupo de recursos no qual criar o novo repositório. Grupos de recursos estão disponíveis apenas para organizações 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]`: Sabor do hardware do Space (por exemplo, 'cpu-basic', 't4-medium', 'l4x4'). Apenas para Spaces. * `--sleep-time INTEGER`: Segundos de inatividade antes de o Space ser colocado em modo de espera. Use -1 para desativar. Somente para Spaces. * `-s, --secrets TEXT`: Define variáveis de ambiente secretas. Prefira `--secrets SECRET` para ler o valor do seu ambiente (por exemplo, `--secrets HF_TOKEN` para passar seu token do Hugging Face); `--secrets SECRET=value` coloca o valor no histórico do seu shell. * `--secrets-file TEXT`: Lê um arquivo de variáveis de ambiente secretas. Use `-` para lê-las do stdin. * `-e, --env TEXT`: Define variáveis de ambiente. Ex.: --env ENV=value * `--env-file TEXT`: Lê um arquivo de variáveis de ambiente. Use `-` para lê-las do stdin. * `-v, --volume TEXT`: Monta um ou mais volumes. Formato: hf://[TYPE/]SOURCE:/MOUNT_PATH[:ro]. TYPE é um dos seguintes: models, datasets, spaces, buckets. Se omitido, TYPE padrão é models. models, datasets e spaces são sempre montados somente leitura. buckets são leitura+escrita por padrão. Ex.: -v hf://org/m:/data ou -v hf://datasets/org/ds:/data ou -v hf://buckets/org/b:/mnt:ro * `--help`: Exibe esta mensagem e sai. Exemplos $ 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 Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf repos list` Liste todos os repositórios (modelos, conjuntos de dados, espaços, buckets) com informações de armazenamento. [alias: ls] **Uso**: ```console $ hf repos list [OPTIONS] ``` **Opções**: * `--namespace TEXT`: Nome da organização. Se não for fornecido, lista os repositórios do usuário autenticado. * `--type, --repo-type [model|dataset|space|bucket]`: Filtra pelo tipo de repositório (model, dataset, space ou bucket). * `--search TEXT`: Consulta de pesquisa. * `--limit INTEGER`: Limita o número de resultados. [padrão: 30] * `--explore`: Explore seus repositórios como uma cidade 3D interativa. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf repos ls $ hf repos ls --explore $ hf repos ls --namespace my-org --search bert Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf repos move` Move um repositório de um namespace para outro namespace. **Uso**: ```console $ hf repos move [OPTIONS] FROM_ID TO_ID ``` **Argumentos**: * `FROM_ID`: O ID do repositório (por exemplo, `username/repo-name` ou `spaces/username/repo-name`). [obrigatório] * `TO_ID`: O ID do repositório (por exemplo, `username/repo-name` ou `spaces/username/repo-name`). [obrigatório] **Opções**: * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--type, --repo-type [model|dataset|space|kernel]`: O tipo de repositório (model, dataset, space ou kernel). [padrão: model] * `--help`: Exibe esta mensagem e sai. Exemplos $ hf repos move old-namespace/my-model new-namespace/my-model Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf repos settings` Atualize as configurações de um repositório. **Uso**: ```console $ hf repos settings [OPTIONS] REPO_ID ``` **Argumentos**: * `REPO_ID`: O ID do repositório (por exemplo, `username/repo-name` ou `spaces/username/repo-name`). [obrigatório] **Opções**: * `--gated [auto|manual|false]`: O status de acesso restrito do repositório. * `--private / --no-private`: Se deve criar um repositório privado caso o repositório não exista no Hub. Ignorado se o repositório já existir. * `--public`: Se o repositório deve ser público. Ignorado se o repositório já existir. * `--protected`: Se o Space deve ser protegido (apenas Spaces). Ignorado se o repositório já existir. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--type, --repo-type [model|dataset|space|kernel]`: O tipo de repositório (model, dataset, space ou kernel). [padrão: model] * `--help`: Exibe esta mensagem e sai. Exemplos $ hf repos settings my-model --private $ hf repos settings my-model --gated auto $ hf repos settings my-space --repo-type space --protected Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf repos tag` Gerencie as tags de um repositório no Hub. **Uso**: ```console $ hf repos tag [OPTIONS] COMMAND [ARGS]... ``` **Opções**: * `--help`: Exibe esta mensagem e sai. **Comandos**: * `create`: Cria uma tag para um repositório. * `delete`: Exclui uma tag de um repositório. * `list`: Lista as tags de um repositório. [alias: ls] #### `hf repos tag create` Crie uma tag para um repositório. **Uso**: ```console $ hf repos tag create [OPTIONS] REPO_ID TAG ``` **Argumentos**: * `REPO_ID`: O ID do repositório (por exemplo, `username/repo-name` ou `spaces/username/repo-name`). [obrigatório] * `TAG`: O nome da tag a ser criada. [obrigatório] **Opções**: * `-m, --message TEXT`: A descrição da tag a ser criada. * `--revision TEXT`: id da revisão Git, que pode ser um nome de branch, uma tag ou um hash de commit. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--type, --repo-type [model|dataset|space|kernel]`: O tipo de repositório (model, dataset, space ou kernel). [padrão: model] * `--help`: Exibe esta mensagem e sai. Exemplos $ hf repos tag create my-model v1.0 $ hf repos tag create my-model v1.0 -m "First release" Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli #### `hf repos tag delete` Excluir uma tag de um repositório. **Uso**: ```console $ hf repos tag delete [OPTIONS] REPO_ID TAG ``` **Argumentos**: * `REPO_ID`: O ID do repositório (por exemplo, `username/repo-name` ou `spaces/username/repo-name`). [obrigatório] * `TAG`: O nome da tag a ser excluída. [obrigatório] **Opções**: * `-y, --yes`: Responde Sim automaticamente ao prompt * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--type, --repo-type [model|dataset|space|kernel]`: O tipo de repositório (model, dataset, space ou kernel). [padrão: model] * `--help`: Exibe esta mensagem e sai. Exemplos $ hf repos tag delete my-model v1.0 Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli #### `hf repos tag list` Liste as tags de um repositório. [alias: ls] **Uso**: ```console $ hf repos tag list [OPTIONS] REPO_ID ``` **Argumentos**: * `REPO_ID`: O ID do repositório (por exemplo, `username/repo-name` ou `spaces/username/repo-name`). [obrigatório] **Opções**: * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--type, --repo-type [model|dataset|space|kernel]`: O tipo de repositório (model, dataset, space ou kernel). [padrão: model] * `--help`: Exibe esta mensagem e sai. Exemplos $ hf repos tag list my-model Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ## `hf sandbox` Execute e gerencie sandboxes experimentais no Hugging Face Jobs. **Uso**: ```console $ hf sandbox [OPTIONS] COMMAND [ARGS]... ``` **Opções**: * `--help`: Exibe esta mensagem e sai. **Comandos**: * `cp`: Copia um arquivo entre a máquina local e um sandbox (estilo docker). * `create`: Cria um sandbox: uma VM dedicada por padrão, ou uma compartilhada de baixo custo com `--pool`. * `exec`: Executa um comando em um sandbox, transmitindo a saída. * `kill`: Encerra um sandbox, um host compartilhado inteiro ou tudo (--all). * `pool`: Pools de VMs de host em modo de aquecimento e criação de sandboxes compartilhadas experimentais para cargas de trabalho dentro do mesmo limite de confiança. * `process`: Lista e interrompe processos em segundo plano executados em um sandbox. * `spawn`: Inicia um comando de longa duração em segundo plano e retorna seu pid (não espera). ### `hf sandbox cp` Copie um arquivo entre a máquina local e um sandbox (estilo docker). **Uso**: ```console $ hf sandbox cp [OPTIONS] SRC DST ``` **Argumentos**: * `SRC`: Origem: um caminho local ou :. [obrigatório] * `DST`: Destino: um caminho local ou :. [obrigatório] **Opções**: * `--namespace TEXT`: O namespace onde o job será executado. O padrão é o namespace do usuário atual. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf sandbox cp data.csv :/data/data.csv $ hf sandbox cp :/app/result.json result.json Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf sandbox create` Crie um sandbox: uma VM dedicada por padrão, ou uma compartilhada de baixo custo com `--pool`. Env e idle-timeout se aplicam ao sandbox em ambos os modos. Com `--pool`, a imagem e o flavor vêm do pool, portanto, passá-los aqui é um erro; `--secrets` também é rejeitado, pois sandboxes em pool não possuem um canal de segredos criptografados (use `--env`). Defina um pool primeiro com `hf sandbox pool create`. **Uso**: ```console $ hf sandbox create [OPTIONS] [IMAGE] ``` **Argumentos**: * `[IMAGE]`: imagem do Docker (requer /bin/sh). **Opções**: * `--pool TEXT`: Cria um sandbox compartilhado de baixo custo neste pool (a partir de `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 do hardware. Execute 'hf jobs hardware' para listar os flavors disponíveis. O padrão é `cpu-basic`. * `--idle-timeout TEXT`: Encerra automaticamente o sandbox após esse período de inatividade (por exemplo, '10m'). O padrão é 10m. * `-e, --env TEXT`: Define variáveis de ambiente. Ex.: --env ENV=value * `-s, --secrets TEXT`: Define variáveis de ambiente secretas. Prefira `--secrets SECRET` para ler o valor do seu ambiente (por exemplo, `--secrets HF_TOKEN` para passar seu token do Hugging Face); `--secrets SECRET=value` coloca o valor no histórico do seu shell. * `-l, --label TEXT`: Define rótulos. Ex.: --label KEY=VALUE ou --label LABEL * `--env-file TEXT`: Lê um arquivo de variáveis de ambiente. Use `-` para lê-las do stdin. * `--secrets-file TEXT`: Lê um arquivo de variáveis de ambiente secretas. Use `-` para lê-las do stdin. * `-v, --volume TEXT`: Monta um ou mais volumes. Formato: hf://[TYPE/]SOURCE:/MOUNT_PATH[:ro]. TYPE é um dos seguintes: models, datasets, spaces, buckets. Se omitido, TYPE padrão é models. models, datasets e spaces são sempre montados somente leitura. buckets são leitura+escrita por padrão. Ex.: -v hf://org/m:/data ou -v hf://datasets/org/ds:/data ou -v hf://buckets/org/b:/mnt:ro * `--namespace TEXT`: O namespace onde o job será executado. O padrão é o namespace do usuário atual. * `--forward-hf-token`: Insere seu token do HF como HF_TOKEN no sandbox. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ 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 Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf sandbox exec` Execute um comando em um sandbox, transmitindo a saída. Encerra com o código de saída do comando. Para iniciar um comando de longa duração em segundo plano, em vez de aguardá-lo, use `hf sandbox spawn`. **Uso**: ```console $ hf sandbox exec [OPTIONS] SANDBOX_ID COMMAND... ``` **Argumentos**: * `SANDBOX_ID`: O id do sandbox, conforme exibido por `hf sandbox create`. [obrigatório] * `COMMAND...`: O comando a ser executado. [obrigatório] **Opções**: * `-w, --workdir TEXT`: Diretório de trabalho. * `-e, --env TEXT`: Define variáveis de ambiente. Ex.: --env ENV=value * `--env-file TEXT`: Lê um arquivo de variáveis de ambiente. Use `-` para lê-las do stdin. * `--timeout FLOAT`: Encerra o comando após esse número de segundos. * `--namespace TEXT`: O namespace onde o job será executado. O padrão é o namespace do usuário atual. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf sandbox exec -- python -c "print(42)" $ hf sandbox exec -w /app -- pytest -x Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf sandbox kill` Encerre um sandbox, um host compartilhado inteiro ou tudo (--all). **Uso**: ```console $ hf sandbox kill [OPTIONS] [SANDBOX_ID] ``` **Argumentos**: * `[SANDBOX_ID]`: O id do sandbox ou host a ser encerrado. **Opções**: * `--all`: Encerra todos os sandboxes e hosts no namespace. * `-y, --yes`: Responde Sim automaticamente aos prompts. * `--namespace TEXT`: O namespace onde o job será executado. O padrão é o namespace do usuário atual. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf sandbox kill $ hf sandbox kill # kills a whole shared host (all its sandboxes) $ hf sandbox kill --all Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf sandbox pool` Mantenha pools de VMs de host aquecidas e crie sandboxes compartilhadas experimentais para cargas de trabalho dentro do mesmo limite de confiança. **Uso**: ```console $ hf sandbox pool [OPTIONS] COMMAND [ARGS]... ``` **Opções**: * `--help`: Exibe esta mensagem e sai. **Comandos**: * `create`: Aquecer um pool: iniciar uma VM de host agora, com uma tag para que possa ser encontrada posteriormente pelo id do pool. * `delete`: Encerra todas as VMs de host de um pool (e, portanto, todos os seus sandboxes). [alias: rm] * `ls`: Lista os pools de sandbox em execução (agrupados a partir de suas VMs host). [alias: list] #### `hf sandbox pool create` Aquecer um pool: inicie uma VM de host agora, com uma tag para que ela possa ser encontrada posteriormente pelo id do pool. **Uso**: ```console $ hf sandbox pool create [OPTIONS] [IMAGE] ``` **Argumentos**: * `[IMAGE]`: imagem Docker para os hosts (requer /bin/sh). **Opções**: * `--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 do hardware. Execute 'hf jobs hardware' para listar os flavors disponíveis. O padrão é `cpu-basic`. * `--per-host INTEGER RANGE`: Sandboxes empacotados por VM de host (padrão 50). [padrão: 50; x>=1] * `--max-hosts INTEGER RANGE`: Limite opcional para o número de VMs de host. [x>=1] * `--idle-timeout TEXT`: Desliga um host após ele ficar sem sandboxes por esse período (por exemplo, '10m'). O padrão é 10m. * `--namespace TEXT`: O namespace onde o job será executado. O padrão é o namespace do usuário atual. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf sandbox pool create $ hf sandbox pool create python:3.12 --flavor cpu-basic $ hf sandbox pool create --per-host 50 --idle-timeout 30m Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli #### `hf sandbox pool delete` Encerrar todas as VMs de host de um pool (e, portanto, todos os seus sandboxes). [alias: rm] **Uso**: ```console $ hf sandbox pool delete [OPTIONS] POOL_ID ``` **Argumentos**: * `POOL_ID`: ID do pool a ser excluído. [obrigatório] **Opções**: * `-y, --yes`: Responde Sim automaticamente aos prompts. * `--namespace TEXT`: O namespace onde o job será executado. O padrão é o namespace do usuário atual. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf sandbox pool delete Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli #### `hf sandbox pool ls` Listar pools de sandbox em execução (agrupados a partir de suas VMs host). [alias: list] **Uso**: ```console $ hf sandbox pool ls [OPTIONS] ``` **Opções**: * `--namespace TEXT`: O namespace onde o job será executado. O padrão é o namespace do usuário atual. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf sandbox pool ls Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf sandbox process` Liste e interrompa processos em segundo plano executados em um sandbox. **Uso**: ```console $ hf sandbox process [OPTIONS] COMMAND [ARGS]... ``` **Opções**: * `--help`: Exibe esta mensagem e sai. **Comandos**: * `kill`: Interrompe um processo em segundo plano executado em um sandbox. * `ls`: Lista os processos em segundo plano em execução em um sandbox (iniciados com `hf sandbox spawn`). [alias: list] #### `hf sandbox process kill` Interrompa um processo em segundo plano executado em um sandbox. **Uso**: ```console $ hf sandbox process kill [OPTIONS] SANDBOX_ID PID ``` **Argumentos**: * `SANDBOX_ID`: O id do sandbox, conforme exibido por `hf sandbox create`. [obrigatório] * `PID`: O pid como impresso por `hf sandbox process ls`. [obrigatório] **Opções**: * `--namespace TEXT`: O namespace onde o job será executado. O padrão é o namespace do usuário atual. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf sandbox process kill Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli #### `hf sandbox process ls` Liste os processos em segundo plano executados em um sandbox (iniciados com `hf sandbox spawn`). [alias: list] **Uso**: ```console $ hf sandbox process ls [OPTIONS] SANDBOX_ID ``` **Argumentos**: * `SANDBOX_ID`: O id do sandbox, conforme exibido por `hf sandbox create`. [obrigatório] **Opções**: * `--namespace TEXT`: O namespace onde o job será executado. O padrão é o namespace do usuário atual. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf sandbox process ls Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf sandbox spawn` Inicie um comando de longa duração em segundo plano e retorne seu pid (não aguarde). Liste os processos de um sandbox com `hf sandbox process ls` e encerre um deles com `hf sandbox process kill`. **Uso**: ```console $ hf sandbox spawn [OPTIONS] SANDBOX_ID COMMAND... ``` **Argumentos**: * `SANDBOX_ID`: O id do sandbox, conforme exibido por `hf sandbox create`. [obrigatório] * `COMMAND...`: O comando a ser executado em segundo plano. [obrigatório] **Opções**: * `-w, --workdir TEXT`: Diretório de trabalho. * `-e, --env TEXT`: Define variáveis de ambiente. Ex.: --env ENV=value * `--env-file TEXT`: Lê um arquivo de variáveis de ambiente. Use `-` para lê-las do stdin. * `--namespace TEXT`: O namespace onde o job será executado. O padrão é o namespace do usuário atual. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf sandbox spawn -- python -m http.server 8000 $ hf sandbox spawn -w /app -- uvicorn app:app Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ## `hf skills` Gerencie habilidades para assistentes de IA. **Uso**: ```console $ hf skills [OPTIONS] COMMAND [ARGS]... ``` **Opções**: * `--help`: Exibe esta mensagem e sai. **Comandos**: * `add`: Instala uma habilidade do Hugging Face para um assistente de IA. * `list`: Lista as habilidades disponíveis no marketplace da Hugging Face. [alias: ls] * `preview`: Imprime o `hf-cli` SKILL.md gerado no stdout. * `update`: Atualiza as habilidades do marketplace da Hugging Face instaladas. ### `hf skills add` Instale uma habilidade do Hugging Face para um assistente de IA. A skill padrão `hf-cli` é gerada localmente a partir da versão do CLI instalada; as outras skills são baixadas do marketplace da Hugging Face. A localização padrão é no diretório atual (.agents/skills) ou no nível do usuário (~/.agents/skills). A skill também é vinculada simbolicamente ao diretório de skills do Claude Code (`.claude/skills` ou `~/.claude/skills`, respeitando `CLAUDE_CONFIG_DIR` quando definido), a menos que `--dest` seja usado. **Uso**: ```console $ hf skills add [OPTIONS] [NAME] ``` **Argumentos**: * `[NAME]`: Nome da habilidade do Marketplace. **Opções**: * `-g, --global`: Instala globalmente (no nível do usuário) em vez de no diretório do projeto atual. * `--dest PATH`: Instala em um destino personalizado (caminho para o diretório de skills). * `--force`: Sobrescreve as habilidades existentes no destino. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf skills add $ hf skills add huggingface-gradio --dest=~/my-skills $ hf skills add --global $ hf skills add huggingface-gradio --global Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf skills list` Liste as habilidades disponíveis no marketplace da Hugging Face. [alias: ls] **Uso**: ```console $ hf skills list [OPTIONS] ``` **Opções**: * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf skills list $ hf skills list --format json Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf skills preview` Imprima o `hf-cli` SKILL.md gerado no stdout. **Uso**: ```console $ hf skills preview [OPTIONS] ``` **Opções**: * `--help`: Exibe esta mensagem e sai. ### `hf skills update` Atualize as habilidades do marketplace da Hugging Face instaladas. **Uso**: ```console $ hf skills update [OPTIONS] [NAME] ``` **Argumentos**: * `[NAME]`: Nome opcional da skill instalada a ser atualizada. **Opções**: * `-g, --global`: Use os diretórios globais de skills em vez do projeto atual. * `--dest PATH`: Atualiza as habilidades em um diretório de habilidades personalizado. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf skills update $ hf skills update hf-cli $ hf skills update huggingface-gradio --dest=~/my-skills $ hf skills update -g Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ## `hf spaces` Interaja com os espaços no Hub. **Uso**: ```console $ hf spaces [OPTIONS] COMMAND [ARGS]... ``` **Opções**: * `--help`: Exibe esta mensagem e sai. **Comandos**: * `card`: Obter o cartão do Space (README) para um Space no Hub. * `dev-mode`: Ativa ou desativa o modo de desenvolvimento em um Space. * `hardware`: Lista as opções de hardware disponíveis para Spaces. * `hot-reload`: Recarrega qualquer arquivo Python de um Space sem necessidade de reconstrução e reinicialização completas. * `info`: Obter informações sobre um espaço no Hub. * `list`: Lista espaços no Hub ou arquivos em um repositório de espaço. [alias: ls] * `logs`: Obter os logs de execução ou compilação de um Space. * `pause`: Pausa um Space. * `restart`: Reinicia um Space. * `search`: Busca espaços no Hub usando busca semântica. * `secrets`: Gerencia segredos para um Space no Hub. * `settings`: Atualiza as configurações de um Space. * `ssh`: Conecta via SSH ao container do Dev Mode de um Space. * `templates`: Lista os templates de Space disponíveis. * `variables`: Gerencia variáveis de ambiente para um Space no Hub. * `volumes`: Gerencia volumes para um Space no Hub. * `wait`: Aguarda que um Space termine de compilar/iniciar. * `zero-gpu`: Gerencie seu uso de ZeroGPU no Hub. ### `hf spaces card` Obtenha o cartão do Space (README) para um Space no Hub. **Uso**: ```console $ hf spaces card [OPTIONS] SPACE_ID ``` **Argumentos**: * `SPACE_ID`: O ID do espaço (por exemplo, `username/repo-name`). [obrigatório] **Opções**: * `--metadata`: Exibe apenas os metadados do card. * `--text`: Exibe apenas o corpo do texto (sem metadados). * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ 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 Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf spaces dev-mode` Ative ou desative o modo de desenvolvimento em um Space. O Spaces Dev Mode facilita o depuramento do seu aplicativo e torna a iteração em Spaces mais rápida, permitindo que você reinicie seu aplicativo sem parar o próprio contêiner do Space. A ativação do dev mode requer um plano PRO ou Team & Enterprise. A desativação (`--stop`) é sempre permitida. Veja a documentação: https://huggingface.co/docs/hub/spaces-dev-mode **Uso**: ```console $ hf spaces dev-mode [OPTIONS] SPACE_ID ``` **Argumentos**: * `SPACE_ID`: O ID do espaço (por exemplo, `username/repo-name`). [obrigatório] **Opções**: * `--stop / --no-stop`: Interrompe o modo de desenvolvimento. [padrão: no-stop] * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf spaces dev-mode my-user-name/deepsite Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf spaces hardware` Liste as opções de hardware disponíveis para Spaces. **Uso**: ```console $ hf spaces hardware [OPTIONS] ``` **Opções**: * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf spaces hardware Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf spaces hot-reload` Recarregue dinamicamente qualquer arquivo Python de um Space sem necessidade de reconstrução e reinicialização completas. ⚠ Este recurso é experimental ⚠ Funciona apenas com o Gradio SDK (6.1+) Abre um editor interativo, a menos que --local-file/-f seja especificado. Este comando aplica patches ao processo Python em execução usando https://github.com/breuleux/jurigged (diferenciação baseada em AST, atualizações de funções in-place, etc.), integrado ao suporte nativo de hot-reload do Gradio (o que significa que as alterações no objeto de demonstração do Gradio são refletidas na interface) O comando cria um commit remoto. Se você estiver trabalhando a partir de um clone local, execute `git pull --autostash` em seguida para trazer o commit de volta e manter o estado local do git sincronizado. **Uso**: ```console $ hf spaces hot-reload [OPTIONS] SPACE_ID [FILENAME] ``` **Argumentos**: * `SPACE_ID`: O ID do espaço (por exemplo, `username/repo-name`). [obrigatório] * `[FILENAME]`: Caminho para o arquivo Python no repositório do Space. Pode ser omitido quando --local-file é especificado e o caminho no repositório corresponde. **Opções**: * `-f, --local-file PATH`: Caminho do arquivo local. Modo de editor interativo se não for especificado * `--skip-checks / --no-skip-checks`: Pula as verificações de compatibilidade de hot-reload. [padrão: no-skip-checks] * `--skip-summary / --no-skip-summary`: Pula a exibição do resumo após o hot-reload ser acionado [padrão: no-skip-summary] * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf spaces hot-reload username/repo-name app.py # Abre um editor interativo para o arquivo remoto app.py $ hf spaces hot-reload username/repo-name -f app.py # Pega a versão local de ./app.py e aplica a correção em app.py remotamente $ hf spaces hot-reload username/repo-name app.py -f src/app.py # Pega a versão local de ./src/app.py Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf spaces info` Obtenha informações sobre um espaço no Hub. **Uso**: ```console $ hf spaces info [OPTIONS] SPACE_ID ``` **Argumentos**: * `SPACE_ID`: O ID do espaço (por exemplo, `username/repo-name`). [obrigatório] **Opções**: * `--revision TEXT`: id da revisão Git, que pode ser um nome de branch, uma tag ou um hash de commit. * `--expand TEXT`: Propriedades separadas por vírgulas para retornar. Quando usado, apenas as propriedades listadas (e id) são retornadas. Exemplo: '--expand=likes,tags'. Válidos: author, cardData, createdAt, datasets, disabled, lastModified, likes, models, private, region, resourceGroup, runtime, sdk, sha, siblings, subdomain, tags, trendingScore, usedStorage. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf spaces info enzostvs/deepsite $ hf spaces info gradio/theme_builder --expand sdk,runtime,likes Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf spaces list` Liste espaços no Hub ou arquivos em um repositório de espaço. [alias: ls] Quando chamado sem argumentos, lista os espaços no Hub. Quando chamado com um ID de espaço, lista os arquivos no repositório desse espaço. **Uso**: ```console $ hf spaces list [OPTIONS] [REPO_ID] ``` **Argumentos**: * `[REPO_ID]`: ID do Space (por exemplo, `username/repo-name`) para listar os arquivos. Se omitido, lista os spaces. **Opções**: * `--search TEXT`: Consulta de pesquisa. * `--author TEXT`: Filtrar por autor ou organização. * `--filter TEXT`: Filtra por tags (por exemplo, 'text-classification'). Pode ser usado várias vezes. * `--sort [created_at|last_modified|likes|trending_score]`: Ordena os resultados. * `--limit INTEGER`: Limita o número de resultados. [padrão: 30] * `--expand TEXT`: Propriedades separadas por vírgulas para retornar. Quando usado, apenas as propriedades listadas (e id) são retornadas. Exemplo: '--expand=likes,tags'. Válidos: author, cardData, createdAt, datasets, disabled, lastModified, likes, models, private, region, resourceGroup, runtime, sdk, sha, siblings, subdomain, tags, trendingScore, usedStorage. * `-h, --human-readable`: Exibe os tamanhos em formato legível por humanos (apenas para listar arquivos). * `--tree`: Lista arquivos em formato de árvore (apenas para listar arquivos). * `-R, --recursive`: Lista arquivos recursivamente (apenas para listar arquivos). * `--revision TEXT`: id da revisão Git, que pode ser um nome de branch, uma tag ou um hash de commit. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ 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 Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf spaces logs` Obtenha os logs de execução ou de compilação de um Space. Por padrão, imprime os logs de execução atualmente disponíveis e sai (não bloqueante, como `docker logs`). Use --follow/-f para transmitir até o servidor fechar o stream. Use --build para ver os logs de build do container em vez disso (útil quando um Space está travado em BUILD_ERROR). **Uso**: ```console $ hf spaces logs [OPTIONS] SPACE_ID ``` **Argumentos**: * `SPACE_ID`: O ID do espaço (por exemplo, `username/repo-name`). [obrigatório] **Opções**: * `--build`: Busca os logs de build do container em vez dos logs de execução. Útil quando um Space está travado em BUILD_ERROR. * `-f, --follow`: Acompanha a saída do log (transmite até o servidor fechar o fluxo). Sem essa flag, apenas os logs atualmente disponíveis são exibidos. * `-n, --tail INTEGER`: Número de linhas a exibir a partir do final dos logs. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ 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 Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf spaces pause` Pausar um Space. **Uso**: ```console $ hf spaces pause [OPTIONS] SPACE_ID ``` **Argumentos**: * `SPACE_ID`: O ID do espaço (por exemplo, `username/repo-name`). [obrigatório] **Opções**: * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf spaces pause username/my-space Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf spaces restart` Reiniciar um Space. **Uso**: ```console $ hf spaces restart [OPTIONS] SPACE_ID ``` **Argumentos**: * `SPACE_ID`: O ID do espaço (por exemplo, `username/repo-name`). [obrigatório] **Opções**: * `--factory-reboot`: Reconstrói o Space do zero sem usar o cache de build. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf spaces restart username/my-space $ hf spaces restart username/my-space --factory-reboot Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf spaces search` Pesquise espaços no Hub usando busca semântica. **Uso**: ```console $ hf spaces search [OPTIONS] QUERY ``` **Argumentos**: * `QUERY`: Consulta de pesquisa. [obrigatório] **Opções**: * `--filter TEXT`: Filtra por tags (por exemplo, 'text-classification'). Pode ser usado várias vezes. * `--sdk TEXT`: Filtrar por SDK (por exemplo, gradio, docker, static). * `--include-non-running / --no-include-non-running`: Inclui espaços não em execução nos resultados. [padrão: no-include-non-running] * `--description / --no-description`: Exibe descrições geradas por IA. [padrão: no-description] * `--limit INTEGER`: Limita o número de resultados. [padrão: 10] * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ 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 Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf spaces secrets` Gerencie segredos para um Space no Hub. **Uso**: ```console $ hf spaces secrets [OPTIONS] COMMAND [ARGS]... ``` **Opções**: * `--help`: Exibe esta mensagem e sai. **Comandos**: * `add`: Adiciona ou atualiza segredos para um Space. * `delete`: Remove um segredo de um Space. * `list`: Lista os segredos de um Space. [alias: ls] #### `hf spaces secrets add` Adicione ou atualize segredos para um Space. **Uso**: ```console $ hf spaces secrets add [OPTIONS] SPACE_ID ``` **Argumentos**: * `SPACE_ID`: O ID do espaço (por exemplo, `username/repo-name`). [obrigatório] **Opções**: * `-s, --secrets TEXT`: Define variáveis de ambiente secretas. Prefira `--secrets SECRET` para ler o valor do seu ambiente (por exemplo, `--secrets HF_TOKEN` para passar seu token do Hugging Face); `--secrets SECRET=value` coloca o valor no histórico do seu shell. * `--secrets-file TEXT`: Lê um arquivo de variáveis de ambiente secretas. Use `-` para lê-las do stdin. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ 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 Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli #### `hf spaces secrets delete` Remove um segredo de um Space. **Uso**: ```console $ hf spaces secrets delete [OPTIONS] SPACE_ID KEY ``` **Argumentos**: * `SPACE_ID`: O ID do espaço (por exemplo, `username/repo-name`). [obrigatório] * `KEY`: Nome do segredo a ser removido. [obrigatório] **Opções**: * `-y, --yes`: Responde Sim automaticamente ao prompt. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf spaces secrets delete username/my-space HF_TOKEN $ hf spaces secrets delete username/my-space HF_TOKEN --yes Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli #### `hf spaces secrets list` Liste os segredos de um Space. Os valores dos segredos são somente para gravação e não são retornados. [alias: ls] **Uso**: ```console $ hf spaces secrets list [OPTIONS] SPACE_ID ``` **Argumentos**: * `SPACE_ID`: O ID do espaço (por exemplo, `username/repo-name`). [obrigatório] **Opções**: * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf spaces secrets ls username/my-space Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf spaces settings` Atualize as configurações de um Space. **Uso**: ```console $ hf spaces settings [OPTIONS] SPACE_ID ``` **Argumentos**: * `SPACE_ID`: O ID do espaço (por exemplo, `username/repo-name`). [obrigatório] **Opções**: * `--sleep-time INTEGER`: Tempo ocioso em segundos após o qual o Space entra em modo de suspensão. Use -1 para nunca suspender. Disponível apenas em hardware atualizado. * `--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]`: Tipo de hardware do Space (por exemplo, 'cpu-basic', 't4-medium', 'l4x4'). Execute 'hf spaces hardware' para listar as opções disponíveis. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf spaces settings username/my-space --sleep-time 300 $ hf spaces settings username/my-space --hardware t4-medium Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf spaces ssh` Faça login via SSH no container do Dev Mode de um Space. Exige que o Dev Mode esteja em execução no Space e que sua chave pública SSH esteja registrada em https://huggingface.co/settings/keys. Veja: https://huggingface.co/docs/hub/spaces-dev-mode **Uso**: ```console $ hf spaces ssh [OPTIONS] SPACE_ID ``` **Argumentos**: * `SPACE_ID`: O ID do espaço (por exemplo, `username/repo-name`). [obrigatório] **Opções**: * `-i, --identity-file PATH`: Caminho para o arquivo de identidade SSH (encaminhado para `ssh -i`). * `--dry-run`: Imprime o comando SSH em vez de executá-lo. * `--auto`: Ativa o Dev Mode sem solicitar confirmação, caso ainda não esteja ativado. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ 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 Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf spaces templates` Liste os modelos de Space disponíveis. O `repo_id` (ou `name`) de um template pode ser passado para `hf repos create --template ...` para criar um novo Space a partir desse template. **Uso**: ```console $ hf spaces templates [OPTIONS] ``` **Opções**: * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos hf spaces templates Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf spaces variables` Gerencie variáveis de ambiente para um Space no Hub. **Uso**: ```console $ hf spaces variables [OPTIONS] COMMAND [ARGS]... ``` **Opções**: * `--help`: Exibe esta mensagem e sai. **Comandos**: * `add`: Adiciona ou atualiza variáveis de ambiente para um Space. * `delete`: Remove uma variável de ambiente de um Space. * `list`: Lista variáveis de ambiente para um Space. [alias: ls] #### `hf spaces variables add` Adicione ou atualize variáveis de ambiente para um Space. **Uso**: ```console $ hf spaces variables add [OPTIONS] SPACE_ID ``` **Argumentos**: * `SPACE_ID`: O ID do espaço (por exemplo, `username/repo-name`). [obrigatório] **Opções**: * `-e, --env TEXT`: Define variáveis de ambiente. Ex.: --env ENV=value * `--env-file TEXT`: Lê um arquivo de variáveis de ambiente. Use `-` para lê-las do stdin. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ 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 Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli #### `hf spaces variables delete` Remove uma variável de ambiente de um Space. **Uso**: ```console $ hf spaces variables delete [OPTIONS] SPACE_ID KEY ``` **Argumentos**: * `SPACE_ID`: O ID do espaço (por exemplo, `username/repo-name`). [obrigatório] * `KEY`: Nome da variável a ser removida. [obrigatório] **Opções**: * `-y, --yes`: Responde Sim automaticamente ao prompt. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf spaces variables delete username/my-space DEBUG $ hf spaces variables delete username/my-space DEBUG --yes Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli #### `hf spaces variables list` Liste as variáveis de ambiente de um Space. [alias: ls] **Uso**: ```console $ hf spaces variables list [OPTIONS] SPACE_ID ``` **Argumentos**: * `SPACE_ID`: O ID do espaço (por exemplo, `username/repo-name`). [obrigatório] **Opções**: * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf spaces variables ls username/my-space Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf spaces volumes` Gerencie volumes para um Space no Hub. **Uso**: ```console $ hf spaces volumes [OPTIONS] COMMAND [ARGS]... ``` **Opções**: * `--help`: Exibe esta mensagem e sai. **Comandos**: * `delete`: Remove todos os volumes de um Space. * `list`: Lista os volumes montados em um Space. [alias: ls] * `set`: Define (substitui) os volumes de um Space. #### `hf spaces volumes delete` Remove todos os volumes de um Space. **Uso**: ```console $ hf spaces volumes delete [OPTIONS] SPACE_ID ``` **Argumentos**: * `SPACE_ID`: O ID do espaço (por exemplo, `username/repo-name`). [obrigatório] **Opções**: * `-y, --yes`: Responde Sim automaticamente ao prompt. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf spaces volumes delete username/my-space $ hf spaces volumes delete username/my-space --yes Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli #### `hf spaces volumes list` Liste os volumes montados em um Space. [alias: ls] **Uso**: ```console $ hf spaces volumes list [OPTIONS] SPACE_ID ``` **Argumentos**: * `SPACE_ID`: O ID do espaço (por exemplo, `username/repo-name`). [obrigatório] **Opções**: * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf spaces volumes ls username/my-space Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli #### `hf spaces volumes set` Set (replace) volumes para um Space. **Uso**: ```console $ hf spaces volumes set [OPTIONS] SPACE_ID ``` **Argumentos**: * `SPACE_ID`: O ID do espaço (por exemplo, `username/repo-name`). [obrigatório] **Opções**: * `-v, --volume TEXT`: Monta um ou mais volumes. Formato: hf://[TYPE/]SOURCE:/MOUNT_PATH[:ro]. TYPE é um dos seguintes: models, datasets, spaces, buckets. Se omitido, TYPE padrão é models. models, datasets e spaces são sempre montados somente leitura. buckets são leitura+escrita por padrão. Ex.: -v hf://org/m:/data ou -v hf://datasets/org/ds:/data ou -v hf://buckets/org/b:/mnt:ro * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ 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 Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf spaces wait` Aguarde a conclusão da construção/inicialização de um Space. Bloqueia até que o Space saia de um estágio intermediário (BUILDING, APP_STARTING, etc.) e atinja um estágio estável. Encerra com código 0 se o Space estiver em RUNNING, ou com um código de saída diferente de zero caso contrário (por exemplo, BUILD_ERROR, RUNTIME_ERROR). **Uso**: ```console $ hf spaces wait [OPTIONS] SPACE_ID ``` **Argumentos**: * `SPACE_ID`: O ID do espaço (por exemplo, `username/repo-name`). [obrigatório] **Opções**: * `--timeout TEXT`: Tempo máximo de espera: int com s (segundos, padrão), m (minutos), h (horas) ou d (dias). * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf spaces wait username/my-space $ hf spaces wait username/my-space --timeout 5m Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf spaces zero-gpu` Gerencie seu uso de ZeroGPU no Hub. **Uso**: ```console $ hf spaces zero-gpu [OPTIONS] COMMAND [ARGS]... ``` **Opções**: * `--help`: Exibe esta mensagem e sai. **Comandos**: * `quota`: Exibe sua cota de ZeroGPU (tempo restante de GPU e data de redefinição). #### `hf spaces zero-gpu quota` Exiba sua cota de ZeroGPU (tempo restante de GPU e data de redefinição). Os valores estão em segundos de GPU. Com `--quiet`, apenas os segundos de GPU restantes são exibidos. **Uso**: ```console $ hf spaces zero-gpu quota [OPTIONS] ``` **Opções**: * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf spaces zero-gpu quota $ hf spaces zero-gpu quota --format json Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ## `hf sync` Sincronize arquivos entre um diretório local e um bucket. **Uso**: ```console $ hf sync [OPTIONS] [SOURCE] [DEST] ``` **Argumentos**: * `[SOURCE]`: Caminho de origem: diretório local ou hf://buckets/namespace/bucket_name(/prefix) * `[DEST]`: Caminho de destino: diretório local ou hf://buckets/namespace/bucket_name(/prefix) **Opções**: * `--delete / --no-delete`: Exclui os arquivos de destino que não estão presentes na origem. [padrão: no-delete] * `--ignore-times`: Pule arquivos com base apenas no tamanho, ignorando os horários de modificação. * `--ignore-sizes`: Pular arquivos com base apenas nos horários de modificação, ignorando os tamanhos. * `--plan TEXT`: Salva o plano de sincronização em um arquivo JSONL para revisão, em vez de executar. * `--apply TEXT`: Aplica um arquivo de plano salvo anteriormente. * `--dry-run`: Imprime o plano de sincronização no stdout como JSONL sem executar. * `--include TEXT`: Inclui arquivos que correspondem ao padrão (pode especificar vários). * `--exclude TEXT`: Exclui arquivos que correspondem ao padrão (pode especificar vários). * `--filter-from TEXT`: Lê os padrões de inclusão/exclusão de um arquivo. * `--existing`: Pula a criação de novos arquivos no receptor (atualiza apenas os arquivos existentes). * `--ignore-existing`: Pula a atualização de arquivos que já existem no receptor (cria apenas arquivos novos). * `-v, --verbose`: Exibe logs detalhados com raciocínio. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. ## `hf update` Atualize o CLI `hf` para a versão mais recente. **Uso**: ```console $ hf update [OPTIONS] ``` **Opções**: * `--help`: Exibe esta mensagem e sai. ## `hf upload` Envie um arquivo ou uma pasta para o Hub. Pastas com muitos arquivos são divididas em vários commits. Se o upload de uma pasta for interrompido, execute novamente o mesmo comando para retomar. **Uso**: ```console $ hf upload [OPTIONS] REPO_ID [LOCAL_PATH] [PATH_IN_REPO] ``` **Argumentos**: * `REPO_ID`: O ID do repositório (por exemplo, `username/repo-name` ou `spaces/username/repo-name`). [obrigatório] * `[LOCAL_PATH]`: Caminho local para o arquivo ou pasta a ser enviado. Padrões de curinga são suportados. O padrão é o diretório atual. * `[PATH_IN_REPO]`: Caminho do arquivo ou pasta no repositório. O padrão é o caminho relativo do arquivo ou pasta. **Opções**: * `--type, --repo-type [model|dataset|space|kernel]`: O tipo de repositório (model, dataset, space ou kernel). [padrão: (model)] * `--revision TEXT`: id da revisão Git, que pode ser um nome de branch, uma tag ou um hash de commit. * `--private / --no-private`: Se deve criar um repositório privado caso o repositório não exista no Hub. Ignorado se o repositório já existir. * `--include TEXT`: Padrões de glob para corresponder aos arquivos a serem enviados. * `--exclude TEXT`: Padrões de glob para excluir dos arquivos a serem enviados. * `--delete TEXT`: Padrões glob para arquivos a serem excluídos do repositório durante o commit. * `--commit-message TEXT`: O resumo / título / primeira linha do commit gerado. * `--commit-description TEXT`: A descrição do commit gerado. * `--create-pr / --no-create-pr`: Se o conteúdo deve ser enviado como uma nova Pull Request. [padrão: no-create-pr] * `--every FLOAT`: Se definido, um job em segundo plano é agendado para criar commits a cada `every` minutos. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ 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 Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ## `hf version` Imprime informações sobre a versão do hf. **Uso**: ```console $ hf version [OPTIONS] ``` **Opções**: * `--help`: Exibe esta mensagem e sai. ## `hf webhooks` Gerencie webhooks no Hub. **Uso**: ```console $ hf webhooks [OPTIONS] COMMAND [ARGS]... ``` **Opções**: * `--help`: Exibe esta mensagem e sai. **Comandos**: * `create`: Cria um novo webhook. * `delete`: Exclui um webhook permanentemente. * `disable`: Desativa um webhook ativo. * `enable`: Habilita um webhook desabilitado. * `info`: Exibe todos os detalhes de um único webhook. * `list`: Lista todos os webhooks do usuário atual. [alias: ls] * `update`: Atualiza um webhook existente. ### `hf webhooks create` Crie um novo webhook. Forneça --url (para fazer ping em um servidor remoto) ou --job-id (para acionar um Job), mas não ambos. Os segredos do Job de origem não são copiados para o webhook: passe-os novamente com --secrets / --secrets-file. **Uso**: ```console $ hf webhooks create [OPTIONS] ``` **Opções**: * `--watch TEXT`: Item para monitorar, no formato 'type:name' (ex.: 'model:bert-base-uncased'). Repetível. [obrigatório] * `--url TEXT`: URL para onde enviar os payloads do webhook. Exclusivo mutuamente com --job-id. * `--job-id TEXT`: ID de um Job para acionar (de job.id) em vez de fazer ping em uma URL. Exclusivo mutuamente com --url. * `--domain [repo|discussion]`: Domínio a ser monitorado: 'repo' ou 'discussion'. Repetível. Padrão: todos os domínios. * `--secret TEXT`: Segredo opcional usado para assinar os payloads do webhook. * `-s, --secrets TEXT`: Define variáveis de ambiente secretas. Prefira `--secrets SECRET` para ler o valor do seu ambiente (por exemplo, `--secrets HF_TOKEN` para passar seu token do Hugging Face); `--secrets SECRET=value` coloca o valor no histórico do seu shell. * `--secrets-file TEXT`: Lê um arquivo de variáveis de ambiente secretas. Use `-` para lê-las do stdin. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ 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 Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf webhooks delete` Exclua um webhook permanentemente. **Uso**: ```console $ hf webhooks delete [OPTIONS] WEBHOOK_ID ``` **Argumentos**: * `WEBHOOK_ID`: O ID do webhook a ser excluído. [obrigatório] **Opções**: * `-y, --yes`: Pula o prompt de confirmação. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf webhooks delete abc123 $ hf webhooks delete abc123 --yes Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf webhooks disable` Desative um webhook ativo. **Uso**: ```console $ hf webhooks disable [OPTIONS] WEBHOOK_ID ``` **Argumentos**: * `WEBHOOK_ID`: O ID do webhook a ser desativado. [obrigatório] **Opções**: * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf webhooks disable abc123 Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf webhooks enable` Ativar um webhook desativado. **Uso**: ```console $ hf webhooks enable [OPTIONS] WEBHOOK_ID ``` **Argumentos**: * `WEBHOOK_ID`: O ID do webhook a ser habilitado. [obrigatório] **Opções**: * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf webhooks enable abc123 Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf webhooks info` Exibir todos os detalhes de um único webhook. **Uso**: ```console $ hf webhooks info [OPTIONS] WEBHOOK_ID ``` **Argumentos**: * `WEBHOOK_ID`: O ID do webhook. [obrigatório] **Opções**: * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf webhooks info abc123 Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf webhooks list` Liste todos os webhooks do usuário atual. [alias: ls] **Uso**: ```console $ hf webhooks list [OPTIONS] ``` **Opções**: * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ hf webhooks ls $ hf webhooks ls --format json $ hf webhooks ls --format quiet Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli ### `hf webhooks update` Atualize um webhook existente. Somente as opções fornecidas são alteradas. Os segredos de trabalho passados com --secrets substituem os valores armazenados com o mesmo nome; os demais são mantidos. **Uso**: ```console $ hf webhooks update [OPTIONS] WEBHOOK_ID ``` **Argumentos**: * `WEBHOOK_ID`: O ID do webhook a ser atualizado. [obrigatório] **Opções**: * `--url TEXT`: Nova URL para enviar os payloads do webhook. * `--job-id TEXT`: ID do Job de origem a ser acionado (pode ser o atual). Obrigatório com --secrets / --secrets-file. * `--watch TEXT`: Nova lista de itens para monitorar, no formato 'type:name'. Repetível. Substitui toda a lista de itens monitorados existente. * `--domain [repo|discussion]`: Nova lista de domínios para monitorar: 'repo' ou 'discussion'. Repetível. * `--secret TEXT`: Novo segredo usado para assinar os payloads do webhook. * `-s, --secrets TEXT`: Define variáveis de ambiente secretas. Prefira `--secrets SECRET` para ler o valor do seu ambiente (por exemplo, `--secrets HF_TOKEN` para passar seu token do Hugging Face); `--secrets SECRET=value` coloca o valor no histórico do seu shell. * `--secrets-file TEXT`: Lê um arquivo de variáveis de ambiente secretas. Use `-` para lê-las do stdin. * `--token TEXT`: Um User Access Token gerado em https://huggingface.co/settings/tokens. * `--help`: Exibe esta mensagem e sai. Exemplos $ 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 Saiba mais Use `hf --help` para obter mais informações sobre um comando. Leia a documentação em https://huggingface.co/docs/huggingface_hub/en/guides/cli