Misc changes function

- Disable config writing for now: need to coordinate with @DaTa to find
  a viable place to write config file

- Rename from `nodes` to `node` and `models` to `model`

- Refactor to call main function from cmdline.py so init() can get
  called every time.

Author: yoland68

DEV_README.md

@@ -15,9 +15,9 @@ This guide provides an overview of how to develop in this repository.
 
   `comfy --help`
 
-4. Add more commands (follow the [Add New Command](#add-new-command) guide)
+<!-- 4. Add more commands (follow the [Add New Command](#add-new-command) guide)
 
-   pip install .
+   pip install . -->
 
 ## Add New Command
 

README.md

@@ -81,25 +81,42 @@ comfy provides a convenient way to manage custom nodes for extending ComfyUI's f
 
 - Show custom nodes' information:
  ```
-comfy nodes [show|simple-show] [installed|enabled|not-installed|disabled|all|snapshot|snapshot-list] 
+comfy node [show|simple-show] [installed|enabled|not-installed|disabled|all|snapshot|snapshot-list] 
                               ?[--channel <channel name>] 
                               ?[--mode [remote|local|cache]]
 ```
 -
-  `comfy nodes show all --channel recent`
+  `comfy node show all --channel recent`
 
-  `comfy nodes simple-show installed`
+  `comfy node simple-show installed`
 
-  `comfy nodes update all`
+  `comfy node update all`
 
-  `comfy nodes install ComfyUI-Impact-Pack`
+  `comfy node install ComfyUI-Impact-Pack`
 
 
 - Managing snapshot:
 
-  `comfy nodes save-snapshot`
+  `comfy node save-snapshot`
 
-  `comfy nodes restore-snapshot <snapshot name>`
+  `comfy node restore-snapshot <snapshot name>`
+
+
+### Managing Models
+
+- Model downloading
+
+  `comfy model get`
+
+  *Downloading models that have already been installed will 
+
+- Model remove
+
+  `comfy model enable-gui`
+
+- Model list
+
+  `comfy model list`
 
 
 ### Managing ComfyUI-Manager

comfy_cli/__main__.py

@@ -1,5 +1,4 @@
-from comfy_cli.cmdline import init, app
+from comfy_cli.cmdline import main
 
 if __name__ == '__main__':  # pragma: nocover
-    init()
-    app()
+    main()

comfy_cli/cmdline.py

@@ -2,7 +2,7 @@
 
 import typer
 from typing_extensions import Annotated
-from comfy_cli.command.models import models
+from comfy_cli.command.models import models as models_command
 from rich import print
 import os
 import subprocess
@@ -21,13 +21,17 @@
 app = typer.Typer()
 
 
+def main():
+    init()
+    app()
+
 def init():
-    _env_checker = EnvChecker()
+    # TODO(yoland): after this 
     metadata_manager = MetadataManager()
     start_time = time.time()
     metadata_manager.scan_dir()
     end_time = time.time()
-    
+
     print(f"scan_dir took {end_time - start_time:.2f} seconds to run")
 
 
@@ -53,7 +57,7 @@ def install(
         typer.Option(
             show_default=False,
             help="Path to ComfyUI workspace")
-    ] = constants.COMFY_WORKSPACE,
+    ] = "~/comfy",
     skip_manager: Annotated[
         bool,
         lambda: typer.Option(
@@ -87,10 +91,11 @@ def install(
 
 
 def update(self):
+    _env_checker = EnvChecker()
     print(f"Updating ComfyUI in {self.workspace}...")
     os.chdir(self.workspace)
-    subprocess.run(["git", "pull"])
-    subprocess.run(["pip", "install", "-r", "requirements.txt"])
+    subprocess.run(["git", "pull"], check=True)
+    subprocess.run(["pip", "install", "-r", "requirements.txt"], check=True)
 
 
 @app.command(help="Run workflow file")
@@ -101,8 +106,13 @@ def run(
 
 
 def launch_comfyui(_env_checker, cpu):
-    _env_checker.config['DEFAULT']['recent_path'] = os.getcwd()
-    _env_checker.write_config()
+    # TODO(yoland/data): Disabled config writing for now, checking with @data
+    # We need to find a viable place to write config file, e.g. standard place
+    # for macOS:   ~/Library/Application Support/
+    # for linx:    ~/.config/
+    # for windows: C:\Users\<username>\AppData\Local\
+    #_env_checker.config['DEFAULT']['recent_path'] = os.getcwd()
+    #_env_checker.write_config()
 
     env_path = _env_checker.get_isolated_env()
     reboot_path = None
@@ -115,9 +125,9 @@ def launch_comfyui(_env_checker, cpu):
 
     while True:
         if cpu:
-            subprocess.run([sys.executable, "main.py", "--cpu"], env=new_env)
+            subprocess.run([sys.executable, "main.py", "--cpu"], env=new_env, check=False)
         else:
-            subprocess.run([sys.executable, "main.py"], env=new_env)
+            subprocess.run([sys.executable, "main.py"], env=new_env, check=False)
 
         if not os.path.exists(reboot_path):
             return
@@ -158,7 +168,7 @@ def launch(workspace: Annotated[
         os.chdir(comfy_path)
         launch_comfyui(_env_checker, cpu)
     else:
-        print(f"\nComfyUI is not available.\n", file=sys.stderr)
+        print("\nComfyUI is not available.\nTo install ComfyUI, you can run:\n\n\tcomfy install\n\n", file=sys.stderr)
         raise typer.Exit(code=1)
 
 
@@ -168,6 +178,14 @@ def env():
     _env_checker.print()
 
 
-app.add_typer(models.app, name="models", help="Manage models.")
-app.add_typer(custom_nodes.app, name="nodes", help="Manage custom nodes.")
-app.add_typer(custom_nodes.manager_app, name="manager", help="Manager ComfyUI-Manager.")
+@app.command(hidden=True)
+def nodes():
+    print("\n[bold red] No such command, did you mean 'comfy node' instead?[/bold red]\n")
+
+@app.command(hidden=True)
+def models():
+    print("\n[bold red] No such command, did you mean 'comfy model' instead?[/bold red]\n")
+
+app.add_typer(models_command.app, name="model", help="Manage models.")
+app.add_typer(custom_nodes.app, name="node", help="Manage custom nodes.")
+app.add_typer(custom_nodes.manager_app, name="manager", help="Manager ComfyUI-Manager.")

comfy_cli/command/custom_nodes/command.py

@@ -10,6 +10,11 @@
 
 
 def execute_cm_cli(args, channel=None, mode=None, workspace=None):
+    # TODO(yoland/data): Disabled config writing for now, checking with @data
+    # We need to find a viable place to write config file, e.g. standard place
+    # for macOS:   ~/Library/Application Support/
+    # for linx:    ~/.config/
+    # for windows: C:\Users\<username>\AppData\Local\
     _env_checker = EnvChecker()
     _env_checker.write_config()
 
@@ -48,7 +53,7 @@ def execute_cm_cli(args, channel=None, mode=None, workspace=None):
     subprocess.run(cmd, env=new_env)
 
 
-@app.command('save-snapshot')
+@app.command('save-snapshot', help="Save a snapshot of the current ComfyUI environment")
 def save_snapshot():
     execute_cm_cli(['save-snapshot'])
 

comfy_cli/constants.py

@@ -1,7 +1,19 @@
+from enum import Enum
+import os
+
+class OS(Enum):
+    WINDOWS = 'windows'
+    MACOS = 'macos'
+    LINUX = 'linux'
 
 COMFY_GITHUB_URL = 'https://github.com/comfyanonymous/ComfyUI'
 COMFY_MANAGER_GITHUB_URL = 'https://github.com/ltdrdata/ComfyUI-Manager'
-COMFY_WORKSPACE = '~/comfy'
+
+DEFAULT_COMFY_WORKSPACE = {
+    OS.WINDOWS: os.path.join(os.path.expanduser('~'), 'Documents', 'ComfyUI'),
+    OS.MACOS: os.path.join(os.path.expanduser('~'), 'Documents', 'ComfyUI'),
+    OS.LINUX: os.path.join(os.path.expanduser('~'), 'ComfyUI'),
+}
 
 # TODO: figure out a better way to check if this is a comfy repo
 COMFY_ORIGIN_URL_CHOICES = [
@@ -15,4 +27,4 @@
 
 # Referencing supported pt extension from ComfyUI
 # https://github.com/comfyanonymous/ComfyUI/blob/a88b0ebc2d2f933c94e42aa689c42e836eedaf3c/folder_paths.py#L5
-SUPPORTED_PT_EXTENSIONS = set(['.ckpt', '.pt', '.bin', '.pth', '.safetensors'])
+SUPPORTED_PT_EXTENSIONS = ('.ckpt', '.pt', '.bin', '.pth', '.safetensors')

comfy_cli/env_checker.py

@@ -48,6 +48,20 @@ def check_comfy_server_running():
     except requests.exceptions.RequestException:
         return False
 
+def check_comfy_repo(path):
+    try:
+        repo = git.Repo(path, search_parent_directories=False)
+        path_is_comfy_repo = any(
+            remote.url in constants.COMFY_ORIGIN_URL_CHOICES for remote in repo.remotes
+        )
+        if path_is_comfy_repo:
+            return path_is_comfy_repo, repo
+        else:
+            return False, None
+    # Not in a git repo at all
+    except git.exc.InvalidGitRepositoryError:
+        return False, None
+
 
 @singleton
 class EnvChecker(object):
@@ -74,6 +88,7 @@ def __init__(self):
         self.conda_env = None
         self.python_version: None = None
         self.currently_in_comfy_repo = False
+        self.installed_in_default_repo = False
         self.comfy_repo = None
         self.config = configparser.ConfigParser()
         self.check()
@@ -109,24 +124,22 @@ def check(self):
         self.virtualenv_path = (
             os.environ.get("VIRTUAL_ENV")
             if os.environ.get("VIRTUAL_ENV")
-            else "Not Used"
+            else None
         )
         self.conda_env = (
             os.environ.get("CONDA_DEFAULT_ENV")
             if os.environ.get("CONDA_DEFAULT_ENV")
-            else "Not Used"
+            else None
         )
         self.python_version = sys.version_info
 
-        try:
-            repo = git.Repo(os.getcwd(), search_parent_directories=False)
-            self.currently_in_comfy_repo = any(
-                remote.url in constants.COMFY_ORIGIN_URL_CHOICES for remote in repo.remotes
-            )
-            if self.currently_in_comfy_repo:
-                self.comfy_repo = repo
-        except git.exc.InvalidGitRepositoryError:
+        is_comfy_repo, repo = check_comfy_repo(os.getcwd())
+        if is_comfy_repo:
+            self.currently_in_comfy_repo = True
+            self.comfy_repo = repo
+        else:
             self.currently_in_comfy_repo = False
+            self.comfy_repo = None
 
         config_path = self.get_config_path()
         if os.path.exists(config_path):
@@ -137,8 +150,8 @@ def print(self):
         table = Table(":laptop_computer: Environment", "Value")
         table.add_row("Python Version", format_python_version(sys.version_info))
         table.add_row("Python Executable", sys.executable)
-        table.add_row("Virtualenv Path", self.virtualenv_path)
-        table.add_row("Conda Env", self.conda_env)
+        table.add_row("Virtualenv Path", self.virtualenv_path if self.virtualenv_path else "Not Used")
+        table.add_row("Conda Env", self.conda_env if self.conda_env else "Not Used")
         if self.config.has_section('DEFAULT') and self.config.has_option('DEFAULT', 'recent_path'):
             table.add_row("Recent ComfyUI", self.config['DEFAULT']['recent_path'])
         else:

comfy_cli/meta_data.py

@@ -4,6 +4,7 @@
 from pathlib import Path
 import os
 
+from comfy_cli.env_checker import EnvChecker
 from comfy_cli.utils import singleton
 from comfy_cli import constants
 
@@ -16,6 +17,7 @@ class MetadataManager:
     """
     def __init__(self):
         self.metadata_file = None
+        self.env_checker = EnvChecker()
         self.metadata = {}
 
 

pyproject.toml

@@ -14,7 +14,8 @@ keywords = ["comfyui", "stable diffusion"]
 maintainers = [
   {name = "Yoland Yan", email = "yoland@drip.art"},
   {name = "James Kwon", email = "hongilkwon316@gmail.com"},
-  {name = "Robin Huang", email = "robin@drip.art"}
+  {name = "Robin Huang", email = "robin@drip.art"},
+  {name = "Dr.Lt.Data", email = "dr.lt.data@gmail.com"}
 ]
 
 dependencies = [
@@ -33,9 +34,9 @@ classifiers = [
 ]
 
 [project.scripts]
-comfy = "comfy_cli.__main__:app"
-comfy-cli = "comfy_cli.__main__:app"
-comfycli = "comfy_cli.__main__:app"
+comfy = "comfy_cli.__main__:main"
+comfy-cli = "comfy_cli.__main__:main"
+comfycli = "comfy_cli.__main__:main"
 
 [project.urls]
 Repository = "https://github.com/drip-art/comfy-cli.git"