feat: Add support for CIVITAI_TOKEN and HF_TOKEN environment variables

Closes #280.

Adds support for the standardized Hugging Face and CivitAI API token environment variables.

This provides a safe and easy way to provide transient secrets without leaking them to disk (nothing gets written to the config).

It also makes it much easier to integrate Comfy-CLI with scripting, since the user no longer has to infinitely provide the "--set-X-token" flags every single time they run the command anymore (which they had to do in the past, just to be sure that the latest token was always used).

The order of priority is `--set-X-token`, then the environment variables (if they exist), and lastly the static config fallback values.

This new feature is now documented in the README and in various error messages.

The code has also been refactored, and the error messages have been improved for clarity and consistency.

Author: Arcitec

README.md

@@ -173,9 +173,11 @@ the bisect tool can help you pinpoint the custom node that causes the issue.
 
 - Model downloading
 
-  `comfy model download --url <URL> ?[--relative-path <PATH>] ?[--set-civitai-api-token <TOKEN>]`
+  `comfy model download --url <URL> ?[--relative-path <PATH>] ?[--set-civitai-api-token <TOKEN>] ?[--set-hf-api-token <TOKEN>]`
 
-  - URL: CivitAI, huggingface file url, ...
+  - URL: CivitAI page, Hugging Face file URL, etc...
+  - You can also specify your API tokens via the `CIVITAI_API_TOKEN` and `HF_API_TOKEN` environment variables. The order of priority is `--set-X-token` (always highest priority), then the environment variables if they exist, and lastly your config's stored tokens from previous `--set-X-token` usage (which remembers your most recently set token values).
+  - Tokens provided via the environment variables are never stored persistently in your config file. They are intended as a way to easily and safely provide transient secrets.
 
 - Model remove
 

comfy_cli/command/models/models.py

@@ -106,13 +106,13 @@ def check_civitai_url(url: str) -> Tuple[bool, bool, int, int]:
                 model_id = subpath.split("/")[1]
                 return True, False, int(model_id), None
     except (ValueError, IndexError):
-        print("Error parsing Civitai model URL")
+        print("Error parsing CivitAI model URL")
 
     return False, False, None, None
 
 
 def request_civitai_model_version_api(version_id: int, headers: Optional[dict] = None):
-    # Make a request to the Civitai API to get the model information
+    # Make a request to the CivitAI API to get the model information
     response = requests.get(
         f"https://civitai.com/api/v1/model-versions/{version_id}",
         headers=headers,
@@ -131,7 +131,7 @@ def request_civitai_model_version_api(version_id: int, headers: Optional[dict] =
 
 
 def request_civitai_model_api(model_id: int, version_id: int = None, headers: Optional[dict] = None):
-    # Make a request to the Civitai API to get the model information
+    # Make a request to the CivitAI API to get the model information
     response = requests.get(f"https://civitai.com/api/v1/models/{model_id}", headers=headers, timeout=10)
     response.raise_for_status()  # Raise an error for bad status codes
 
@@ -163,7 +163,7 @@ def download(
     _ctx: typer.Context,
     url: Annotated[
         str,
-        typer.Option(help="The URL from which to download the model", show_default=False),
+        typer.Option(help="The URL from which to download the model.", show_default=False),
     ],
     relative_path: Annotated[
         Optional[str],
@@ -183,15 +183,15 @@ def download(
         Optional[str],
         typer.Option(
             "--set-civitai-api-token",
-            help="Set the CivitAI API token to use for model listing.",
+            help="Set the CivitAI API token to use for model downloading.",
             show_default=False,
         ),
     ] = None,
     set_hf_api_token: Annotated[
         Optional[str],
         typer.Option(
             "--set-hf-api-token",
-            help="Set the HuggingFace API token to use for model listing.",
+            help="Set the Hugging Face API token to use for model downloading.",
             show_default=False,
         ),
     ] = None,
@@ -202,17 +202,12 @@ def download(
     local_filename = None
     headers = None
 
-    if set_civitai_api_token is not None:
-        config_manager.set(constants.CIVITAI_API_TOKEN_KEY, set_civitai_api_token)
-        civitai_api_token = set_civitai_api_token
-    else:
-        civitai_api_token = config_manager.get(constants.CIVITAI_API_TOKEN_KEY)
-
-    if set_hf_api_token is not None:
-        config_manager.set(constants.HF_API_TOKEN_KEY, set_hf_api_token)
-        hf_api_token = set_hf_api_token
-    else:
-        hf_api_token = config_manager.get(constants.HF_API_TOKEN_KEY)
+    civitai_api_token = config_manager.get_or_override(
+        constants.CIVITAI_API_TOKEN_ENV_KEY, constants.CIVITAI_API_TOKEN_KEY, set_civitai_api_token
+    )
+    hf_api_token = config_manager.get_or_override(
+        constants.HF_API_TOKEN_ENV_KEY, constants.HF_API_TOKEN_KEY, set_hf_api_token
+    )
 
     is_civitai_model_url, is_civitai_api_url, model_id, version_id = check_civitai_url(url)
     is_huggingface_url, repo_id, hf_filename, hf_folder_name, hf_branch_name = check_huggingface_url(url)
@@ -281,7 +276,7 @@ def download(
     if is_huggingface_url and check_unauthorized(url, headers):
         if hf_api_token is None:
             print(
-                "Unauthorized access to Hugging Face model. Please set the HuggingFace API token using --set-hf-api-token"
+                f"Unauthorized access to Hugging Face model. Please set the Hugging Face API token using `comfy model download --set-hf-api-token` or via the `{constants.HF_API_TOKEN_ENV_KEY}` environment variable"
             )
             return
         else:

comfy_cli/constants.py

@@ -42,7 +42,9 @@ class PROC(str, Enum):
 CONFIG_KEY_BACKGROUND = "background"
 
 CIVITAI_API_TOKEN_KEY = "civitai_api_token"
+CIVITAI_API_TOKEN_ENV_KEY = "CIVITAI_API_TOKEN"
 HF_API_TOKEN_KEY = "hf_api_token"
+HF_API_TOKEN_ENV_KEY = "HF_API_TOKEN"
 
 DEFAULT_TRACKING_VALUE = True
 

comfy_cli/file_utils.py

@@ -7,7 +7,7 @@
 import httpx
 import requests
 
-from comfy_cli import ui
+from comfy_cli import constants, ui
 
 
 class DownloadException(Exception):
@@ -36,7 +36,7 @@ def parse_json(input_data):
         msg_json = parse_json(message)
         if msg_json is not None:
             if "message" in msg_json:
-                return f"Unauthorized download ({status_code}).\n{msg_json['message']}\nor you can set civitai api token using `comfy model download --set-civitai-api-token <token>`"
+                return f"Unauthorized download ({status_code}).\n{msg_json['message']}\nor you can set a CivitAI API token using `comfy model download --set-civitai-api-token` or via the `{constants.CIVITAI_API_TOKEN_ENV_KEY}` environment variable"
         return f"Unauthorized download ({status_code}), you might need to manually log into a browser to download this"
     elif status_code == 403:
         return f"Forbidden url ({status_code}), you might need to manually log into a browser to download this"