comfy cli

Comfy-Cli: uma ferramenta de linha de comando para ComfyUI

comfy-cli é uma ferramenta de linha de comando que ajuda os usuários a instalar e gerenciar facilmente o ComfyUI, uma poderosa estrutura de aprendizado de máquina de código aberto. Com o comfy-cli, você pode configurar rapidamente o ComfyUI, instalar pacotes e gerenciar nós personalizados, tudo na conveniência do seu terminal.

Demonstração

Características

• Fácil instalação do ComfyUI com um único comando
• ? Gerenciamento perfeito de pacotes para extensões e dependências do ComfyUI
• ? Gerenciamento de nós personalizado para estender a funcionalidade do ComfyUI
• ?️ Baixe pontos de verificação e salve o hash do modelo
• Compatibilidade entre plataformas (Windows, macOS, Linux)
• Documentação abrangente e exemplos

Instalação

1. (Recomendado, mas não necessário) Habilitar ambiente virtual (venv/conda)

2. Para instalar o comfy-cli, certifique-se de ter Python 3.9 ou superior instalado em seu sistema. Em seguida, execute o seguinte comando:

   pip install comfy-cli

Preenchimento automático de shell

Para instalar dicas de preenchimento automático em seu shell, execute:

comfy --install-completion

Isso permite que você digite comfy [TAP] para preencher automaticamente comandos e opções

Uso

Instalando o ComfyUI

Para instalar o ComfyUI usando comfy, basta executar:

comfy install

Este comando irá baixar e configurar a versão mais recente do ComfyUI e do ComfyUI-Manager em seu sistema. Se você executar em um repositório ComfyUI que já foi configurado. O comando simplesmente atualizará o arquivo comfy.yaml para refletir a configuração local

• comfy install --skip-manager : Instale o ComfyUI sem o ComfyUI-Manager.
• comfy --workspace=<path> install : Instale o ComfyUI em <path>/ComfyUI .
• Para comfy install , se nenhuma especificação de caminho como --workspace, --recent, or --here for fornecida, ela será instalada implicitamente em <HOME>/comfy .

Especificando o caminho de execução

• Você pode especificar o caminho do ComfyUI onde o comando será aplicado por meio de indicadores de caminho da seguinte forma:

  • comfy --workspace=<path> : Execute a partir do ComfyUI instalado no espaço de trabalho especificado.
  • comfy --recent : Execute a partir do ComfyUI recentemente executado ou instalado.
  • comfy --here : Execute a partir do ComfyUI localizado no diretório atual.

• As opções --workspace, --recent e --here não podem ser usadas simultaneamente.

• Se não houver indicador de caminho, aplica-se a seguinte prioridade:

  • Execute a partir do ComfyUI padrão no caminho especificado por comfy set-default <path> .
  • Execute a partir do ComfyUI recentemente executado ou instalado.
  • Execute a partir do ComfyUI localizado no diretório atual.

• Exemplo 1: Para executar o ComfyUI executado recentemente:

  • comfy --recent launch

• Exemplo 2: Para instalar um pacote no ComfyUI no diretório atual:

  • comfy --here node install ComfyUI-Impact-Pack

• Exemplo 3: Para atualizar o caminho selecionado automaticamente do ComfyUI e dos nós personalizados com base na prioridade:

  • comfy node update all

• Você pode usar o comando comfy which para verificar o caminho do espaço de trabalho de destino.

  • por exemplo, comfy --recent which , comfy --here which , comfy which , ...

Configuração padrão

O padrão define a opção que será executada por padrão quando nenhum ComfyUI do espaço de trabalho específico tiver sido definido para o comando.

comfy set-default <workspace path> ?[--launch-extras="<extra args>"]

• A opção --launch-extras especifica argumentos extras que são aplicados apenas durante a inicialização por padrão. Entretanto, se extras forem especificados no momento da inicialização, essa configuração será ignorada.

Inicie o ComfyUI

Comfy fornece comandos que permitem executar facilmente o ComfyUI instalado.

comfy launch

• Para executar com opções padrão do ComfyUI:

  comfy launch -- <extra args...>

  comfy launch -- --cpu --listen 0.0.0.0

  • Quando você configura manualmente as opções extras, os extras definidos por padrão serão substituídos.

• Para executar em segundo plano

  comfy launch --background

  comfy --workspace=~/comfy launch --background -- --listen 10.0.0.10 --port 8000

  • As instâncias iniciadas com --background são exibidas na seção "Background ComfyUI" de comfy env , fornecendo funcionalidades de gerenciamento apenas para uma única instância em segundo plano.
  • Como "Comfy Server Running" em comfy env mostra apenas a porta padrão 8188, ele não exibe o ComfyUI em execução em uma porta diferente.
  • O ComfyUI em execução em segundo plano pode ser interrompido com comfy stop .

Gerenciando nós personalizados

comfy fornece uma maneira conveniente de gerenciar nós personalizados para estender a funcionalidade do ComfyUI. Aqui estão alguns exemplos:

• Mostrar informações dos nós personalizados:

 comfy node [show|simple-show] [installed|enabled|not-installed|disabled|all|snapshot|snapshot-list]
                             ?[--channel <channel name>]
                             ?[--mode [remote|local|cache]]

• comfy node show all --channel recent

  comfy node simple-show installed

  comfy node update all

  comfy node install ComfyUI-Impact-Pack

• Gerenciando instantâneo:

  comfy node save-snapshot

  comfy node restore-snapshot <snapshot name>

• Instale dependências:

  comfy node install-deps --deps=<deps .json file>

  comfy node install-deps --workflow=<workflow .json/.png file>

• Gerar dependências:

  comfy node deps-in-workflow --workflow=<workflow .json/.png file> --output=<output deps .json file>

Dividir nós personalizados

Se você encontrar bugs apenas com nós personalizados habilitados e quiser descobrir quais nós personalizados causam o bug, a ferramenta bisect pode ajudá-lo a identificar o nó personalizado que causa o problema.

• comfy node bisect start : inicie uma nova sessão bisect com argumentos de inicialização opcionais do ComfyUI. Ele marca automaticamente o estado inicial como ruim e usa todos os nós habilitados quando o comando é executado como conjunto de teste.
• comfy node bisect good : marca o conjunto ativo atual como bom, indicando que o problema não está no conjunto de teste.
• comfy node bisect bad : marca o conjunto ativo atual como ruim, indicando que o problema está no conjunto de teste.
• comfy node bisect reset : redefina a sessão bisect atual.

Gerenciando Modelos

• Download de modelo

  comfy model download --url <URL> ?[--relative-path <PATH>] ?[--set-civitai-api-token <TOKEN>]

  • URL: CivitAI, url do arquivo huggingface, ...

• Remover modelo

  comfy model remove ?[--relative-path <PATH>] --model-names <model names>

• Lista de modelos

  comfy model list ?[--relative-path <PATH>]

Gerenciando o ComfyUI-Manager

• desabilitar GUI do ComfyUI-Manager (desabilitar menu Gerenciador e Servidor)

  comfy manager disable-gui

• habilitar GUI do ComfyUI-Manager

  comfy manager enable-gui

• Limpar ação de inicialização reservada:

  comfy manager clear

Recurso Beta: formato de comfy-lock.yaml (WIP)

 basic:

models:
  - model: [name of the model]
    url: [url of the source, e.g. https://huggingface.co/...]
    paths: [list of paths to the model]
      - path: [path to the model]
      - path: [path to the model]
    hashes: [hashes for the model]
      - hash: [hash]
        type: [AutoV1, AutoV2, SHA256, CRC32, and Blake3]
    type: [type of the model, e.g. diffuser, lora, etc.]

  - model:
  ...

# compatible with ComfyUI-Manager's .yaml snapshot
custom_nodes:
  comfyui: [commit hash]
  file_custom_nodes:
  - disabled: [bool]
    filename: [.py filename]
    ...
  git_custom_nodes:
    [git-url]:
      disabled: [bool]
      hash: [commit hash]
    ...

Análise

Rastreamos análises usando o Mixpanel para nos ajudar a entender os padrões de uso e saber onde priorizar nossos esforços. Ao baixar o cli pela primeira vez, ele solicitará seu consentimento. Se em algum momento você desejar cancelar:

 comfy tracking disable

Confira o uso aqui: Mixpanel Board

Contribuindo

Aceitamos contribuições para o comfy-cli! Se você tiver alguma ideia, sugestão ou relatório de bug, abra um problema em nosso repositório GitHub. Se você quiser contribuir com código, bifurque o repositório e envie uma solicitação pull.

Confira o Guia do Desenvolvedor para mais detalhes.

Licença

comfy é lançado sob a Licença Pública Geral GNU v3.0.

Apoiar

Se você encontrar algum problema ou tiver dúvidas sobre o comfy-cli, abra um problema em nosso repositório GitHub ou entre em contato conosco no Discord. Ficaremos felizes em ajudá-lo!

Boa difusão com ComfyUI e comfy-cli! ?