comfy-cli 0.0.19__tar.gz → 0.0.20.dev0__tar.gz

{comfy_cli-0.0.19 → comfy_cli-0.0.20.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: comfy-cli
-Version: 0.0.19
+Version: 0.0.20.dev0
 Summary: A CLI tool for installing and using ComfyUI.
 Maintainer-email: Yoland Yan <yoland@drip.art>, James Kwon <hongilkwon316@gmail.com>, Robin Huang <robin@drip.art>, "Dr.Lt.Data" <dr.lt.data@gmail.com>
 License:                     GNU GENERAL PUBLIC LICENSE
@@ -714,10 +714,19 @@ comfy-cli is a command line tool that helps users easily install and manage [Com
 
 ## Installation
 
-To install comfy-cli, make sure you have Python 3.7 or higher installed on your system. Then, run the following command:
+1. (Recommended, but not necessary) Enable virtual environment ([venv](https://docs.python.org/3/library/venv.html)/[conda](https://conda.io/projects/conda/en/latest/user-guide/getting-started.html))
 
-`pip install comfy-cli`
+2. To install comfy-cli, make sure you have Python 3.9 or higher installed on your system. Then, run the following command:
 
+     `pip install comfy-cli`
+
+### Shell Autocomplete
+
+To install autocompletion hints in your shell run:
+
+`comfy --install-completion`
+
+This enables you to type `comfy [TAP]` to autocomplete commands and options
 
 ## Usage
 
@@ -758,6 +767,16 @@ will simply update the comfy.yaml file to reflect the local setup
 * You can use the `comfy which` command to check the path of the target workspace.
   * e.g `comfy --recent which`, `comfy --here which`, `comfy which`, ...
 
+
+### Default Setup
+
+The default sets the option that will be executed by default when no specific workspace's ComfyUI has been set for the command.
+
+  `comfy set-default <workspace path> ?[--launch-extras="<extra args>"]`
+
+  - `--launch-extras` option specifies extra args that are applied only during launch by default. However, if extras are specified at the time of launch, this setting is ignored.
+
+
 ### Launch ComfyUI
 
 Comfy provides commands that allow you to easily run the installed ComfyUI.
@@ -770,6 +789,8 @@ Comfy provides commands that allow you to easily run the installed ComfyUI.
 
   `comfy launch -- --cpu --listen 0.0.0.0`
 
+  - When you manually configure the extra options, the extras set by set-default will be overridden.
+
 - To run background
 
   `comfy launch --background`
@@ -807,6 +828,18 @@ comfy node [show|simple-show] [installed|enabled|not-installed|disabled|all|snap
   `comfy node restore-snapshot <snapshot name>`
 
 
+- Install dependencies:
+
+  `comfy node install-deps --deps=<deps .json file>` 
+
+  `comfy node install-deps --workflow=<workflow .json/.png file>`
+
+
+- Generate deps:
+
+  `comfy node deps-in-workflow --workflow=<workflow .json/.png file>` 
+
+
 ### Managing Models
 
 - Model downloading
@@ -872,22 +905,32 @@ custom_nodes:
     ...
 ```
 
+## Analytics
+
+We track analytics using Mixpanel to help us understand usage patterns and know where to prioritize our efforts. When you first download the cli, it will ask you to give consent. If at any point you wish to opt out:
+
+```
+comfy tracking disable
+```
+
+Check out the usage here: [Mixpanel Board](https://mixpanel.com/p/13hGfPfEPdRkjPtNaS7BYQ)
+
 ## Contributing
 
 We welcome contributions to comfy-cli! If you have any ideas, suggestions, or
 bug reports, please open an issue on our [GitHub
-repository](https://github.com/Comfy-Org/comfy-cli/issues). If you'd like to contribute code,
+repository](https://github.com/yoland68/comfy-cli/issues). If you'd like to contribute code,
 please fork the repository and submit a pull request.
 
 Check out the [Dev Guide](/DEV_README.md) for more details.
 
 ## License
 
-comfy is released under the [GNU General Public License v3.0](https://github.com/drip-art/comfy-cli/blob/master/LICENSE).
+comfy is released under the [GNU General Public License v3.0](https://github.com/yoland68/comfy-cli/blob/master/LICENSE).
 
 ## Support
 
-If you encounter any issues or have questions about comfy-cli, please [open an issue](https://github.com/comfy-cli/issues) on our GitHub repository. We'll be happy to assist you!
+If you encounter any issues or have questions about comfy-cli, please [open an issue](https://github.com/comfy-cli/issues) on our GitHub repository or contact us on [Discord](https://discord.gg/comfycontrib). We'll be happy to assist you!
 
 Happy diffusing with ComfyUI and comfy-cli! 🎉
 

{comfy_cli-0.0.19 → comfy_cli-0.0.20.dev0}/README.md

@@ -13,10 +13,19 @@ comfy-cli is a command line tool that helps users easily install and manage [Com
 
 ## Installation
 
-To install comfy-cli, make sure you have Python 3.7 or higher installed on your system. Then, run the following command:
+1. (Recommended, but not necessary) Enable virtual environment ([venv](https://docs.python.org/3/library/venv.html)/[conda](https://conda.io/projects/conda/en/latest/user-guide/getting-started.html))
 
-`pip install comfy-cli`
+2. To install comfy-cli, make sure you have Python 3.9 or higher installed on your system. Then, run the following command:
 
+     `pip install comfy-cli`
+
+### Shell Autocomplete
+
+To install autocompletion hints in your shell run:
+
+`comfy --install-completion`
+
+This enables you to type `comfy [TAP]` to autocomplete commands and options
 
 ## Usage
 
@@ -57,6 +66,16 @@ will simply update the comfy.yaml file to reflect the local setup
 * You can use the `comfy which` command to check the path of the target workspace.
   * e.g `comfy --recent which`, `comfy --here which`, `comfy which`, ...
 
+
+### Default Setup
+
+The default sets the option that will be executed by default when no specific workspace's ComfyUI has been set for the command.
+
+  `comfy set-default <workspace path> ?[--launch-extras="<extra args>"]`
+
+  - `--launch-extras` option specifies extra args that are applied only during launch by default. However, if extras are specified at the time of launch, this setting is ignored.
+
+
 ### Launch ComfyUI
 
 Comfy provides commands that allow you to easily run the installed ComfyUI.
@@ -69,6 +88,8 @@ Comfy provides commands that allow you to easily run the installed ComfyUI.
 
   `comfy launch -- --cpu --listen 0.0.0.0`
 
+  - When you manually configure the extra options, the extras set by set-default will be overridden.
+
 - To run background
 
   `comfy launch --background`
@@ -106,6 +127,18 @@ comfy node [show|simple-show] [installed|enabled|not-installed|disabled|all|snap
   `comfy node restore-snapshot <snapshot name>`
 
 
+- Install dependencies:
+
+  `comfy node install-deps --deps=<deps .json file>` 
+
+  `comfy node install-deps --workflow=<workflow .json/.png file>`
+
+
+- Generate deps:
+
+  `comfy node deps-in-workflow --workflow=<workflow .json/.png file>` 
+
+
 ### Managing Models
 
 - Model downloading
@@ -171,22 +204,32 @@ custom_nodes:
     ...
 ```
 
+## Analytics
+
+We track analytics using Mixpanel to help us understand usage patterns and know where to prioritize our efforts. When you first download the cli, it will ask you to give consent. If at any point you wish to opt out:
+
+```
+comfy tracking disable
+```
+
+Check out the usage here: [Mixpanel Board](https://mixpanel.com/p/13hGfPfEPdRkjPtNaS7BYQ)
+
 ## Contributing
 
 We welcome contributions to comfy-cli! If you have any ideas, suggestions, or
 bug reports, please open an issue on our [GitHub
-repository](https://github.com/Comfy-Org/comfy-cli/issues). If you'd like to contribute code,
+repository](https://github.com/yoland68/comfy-cli/issues). If you'd like to contribute code,
 please fork the repository and submit a pull request.
 
 Check out the [Dev Guide](/DEV_README.md) for more details.
 
 ## License
 
-comfy is released under the [GNU General Public License v3.0](https://github.com/drip-art/comfy-cli/blob/master/LICENSE).
+comfy is released under the [GNU General Public License v3.0](https://github.com/yoland68/comfy-cli/blob/master/LICENSE).
 
 ## Support
 
-If you encounter any issues or have questions about comfy-cli, please [open an issue](https://github.com/comfy-cli/issues) on our GitHub repository. We'll be happy to assist you!
+If you encounter any issues or have questions about comfy-cli, please [open an issue](https://github.com/comfy-cli/issues) on our GitHub repository or contact us on [Discord](https://discord.gg/comfycontrib). We'll be happy to assist you!
 
 Happy diffusing with ComfyUI and comfy-cli! 🎉
 

{comfy_cli-0.0.19 → comfy_cli-0.0.20.dev0}/comfy_cli/cmdline.py

@@ -16,9 +16,14 @@ from comfy_cli import constants, env_checker, logging, tracking, ui, utils
 from comfy_cli.command import custom_nodes
 from comfy_cli.command import install as install_inner
 from comfy_cli.command.models import models as models_command
+from comfy_cli.update import check_for_updates
 from comfy_cli.config_manager import ConfigManager
 from comfy_cli.env_checker import EnvChecker, check_comfy_server_running
-from comfy_cli.workspace_manager import WorkspaceManager, check_comfy_repo
+from comfy_cli.workspace_manager import (
+    WorkspaceManager,
+    check_comfy_repo,
+    WorkspaceType,
+)
 
 logging.setup_logging()
 app = typer.Typer()
@@ -151,6 +156,7 @@ def install(
         Optional[str], typer.Option(help="Specify commit hash for ComfyUI")
     ] = None,
 ):
+    check_for_updates()
     checker = EnvChecker()
 
     comfy_path = workspace_manager.get_specified_workspace()
@@ -231,31 +237,32 @@ def install(
     print(f"ComfyUI is installed at: {comfy_path}")
 
 
-# @app.command(help="Update ComfyUI custom nodes")
-# @tracking.track_command()
-# def update(target: str = typer.Argument("comfy", help="[all|comfy]")):
-#     if target not in ["all", "comfy"]:
-#         typer.echo(
-#             f"Invalid target: {target}. Allowed targets are 'all', 'comfy'.",
-#             err=True,
-#         )
-#         raise typer.Exit(code=1)
-
-#     comfy_path = workspace_manager.workspace_path
-
-#     if "all" == target:
-#         custom_nodes.command.execute_cm_cli(["update", "all"])
-#     else:
-#         print(f"Updating ComfyUI in {comfy_path}...")
-#         if comfy_path is None:
-#             print("ComfyUI path is not found.")
-#             raise typer.Exit(code=1)
-#         os.chdir(comfy_path)
-#         subprocess.run(["git", "pull"], check=True)
-#         subprocess.run(
-#             [sys.executable, "-m", "pip", "install", "-r", "requirements.txt"],
-#             check=True,
-#         )
+@app.command(help="Update ComfyUI Environment [all|comfy]")
+@tracking.track_command()
+def update(target: str = typer.Argument("comfy", help="[all|comfy]")):
+    if target not in ["all", "comfy"]:
+        typer.echo(
+            f"Invalid target: {target}. Allowed targets are 'all', 'comfy'.",
+            err=True,
+        )
+        raise typer.Exit(code=1)
+
+    _env_checker = EnvChecker()
+    comfy_path = workspace_manager.workspace_path
+
+    if "all" == target:
+        custom_nodes.command.execute_cm_cli(["update", "all"])
+    else:
+        print(f"Updating ComfyUI in {comfy_path}...")
+        if comfy_path is None:
+            print("ComfyUI path is not found.")
+            raise typer.Exit(code=1)
+        os.chdir(comfy_path)
+        subprocess.run(["git", "pull"], check=True)
+        subprocess.run(
+            [sys.executable, "-m", "pip", "install", "-r", "requirements.txt"],
+            check=True,
+        )
 
 
 # @app.command(help="Run workflow file")
@@ -382,6 +389,7 @@ def launch(
     ] = False,
     extra: List[str] = typer.Argument(None),
 ):
+    check_for_updates()
     resolved_workspace = workspace_manager.workspace_path
     if not resolved_workspace:
         print(
@@ -390,6 +398,16 @@ def launch(
         )
         raise typer.Exit(code=1)
 
+    if (
+        extra is None or len(extra) == 0
+    ) and workspace_manager.workspace_type == WorkspaceType.DEFAULT:
+        launch_extras = workspace_manager.config_manager.config["DEFAULT"].get(
+            constants.CONFIG_KEY_DEFAULT_LAUNCH_EXTRAS, ""
+        )
+
+        if launch_extras != "":
+            extra = launch_extras.split(" ")
+
     print(f"\nLaunching ComfyUI from: {resolved_workspace}\n")
 
     # Update the recent workspace
@@ -402,24 +420,27 @@ def launch(
 @app.command("set-default", help="Set default ComfyUI path")
 @tracking.track_command()
 def set_default(
-    # todo: support clear option
-    # clear: Annotated[bool, typer.Option(help="Clear existing default path")] = False,
-    workspace_path: Annotated[
-        str, typer.Argument(help="Path to ComfyUI workspace")
-    ] = None
+    workspace_path: str,
+    launch_extras: Annotated[
+        str, typer.Option(help="Specify extra options for launch")
+    ] = "",
 ):
-    comfy_path = os.path.expanduser(workspace_path)
+    comfy_path = os.path.abspath(os.path.expanduser(workspace_path))
 
     if not os.path.exists(comfy_path):
         print(f"Path not found: {comfy_path}.")
         raise typer.Exit(code=1)
 
-    if not check_comfy_repo(comfy_path)[0]:
+    is_comfy_repo, comfy_repo = check_comfy_repo(comfy_path)
+    if not is_comfy_repo:
         print(f"Specified path is not a ComfyUI path: {comfy_path}.")
         raise typer.Exit(code=1)
 
+    comfy_path = comfy_repo.working_dir
+
     print(f"Specified path is set as default ComfyUI path: {comfy_path} ")
     workspace_manager.set_default_workspace(comfy_path)
+    workspace_manager.set_default_launch_extras(launch_extras)
 
 
 @app.command(help="Show which ComfyUI is selected.")
@@ -438,6 +459,7 @@ def which():
 @app.command(help="Print out current environment variables.")
 @tracking.track_command()
 def env():
+    check_for_updates()
     _env_checker = EnvChecker()
     _env_checker.print()
 
@@ -493,4 +515,5 @@ def feedback():
 
 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.")
+app.add_typer(custom_nodes.manager_app, name="manager", help="Manage ComfyUI-Manager.")
+app.add_typer(tracking.app, name="tracking", help="Manage analytics tracking settings.")