Add docs for --no-enable-telemetry

[christian-byrne]

Describe the solution you'd like
The --no-enable-telemetry option should be in the help screen or documentation.

Additional context
I spent a long time attempting to bypass that prompt while trying to use comfy-cli in a sandbox 💀. Also when I run this:

python3 -m venv venv; source venv/bin/activate && \
firejail --noprofile --whitelist="/home/c_byrne/temp/venv/*" -- bash -c "python -m pip install comfy-cli; comfy-cli tracking disable; comfy-cli --workspace ./mock-ComfyUI"

it will say:

Tracking is now disabled.
Do you agree to enable tracking to improve the application? [y/N]: 

[robinjhuang]

So you can do this to bypass telemetry prompt.

comfy --skip-prompt --no-enable-telemetry env

And add --skip-prompt to subsequent commands to skip those. Did you want this in the README?

[christian-byrne]

I will use that, thanks for the info.

For for README it could be good. Like in a section on using it for automation or cloud setup. It's going to be the CLI for node package management system right? So I thought, it will be common to use it to setup environments automatically, but I couldn't figure out how to bypass the prompt. Sorry if posting this issue caused bad things to happen.

[polarathene]

Did you want this in the README?

It would be good to clarify if --no-enable-telemetry is required to opt-out while actively choosing to opt-out with comfy-cli tracking disable.

I've seen it used elsewhere but when I performed a GH search on the repo for this flag, the only result in source code was an E2E test, so I assume it's been removed since?:

$ grep -R '\--no-enable-telemetry'

tests/e2e/test_e2e.py:            comfy --skip-prompt --no-enable-telemetry env
tests/e2e/test_e2e.py:    exec("comfy --skip-prompt --no-enable-telemetry env")

Seems to be handled here with a default of false already?:

comfy-cli/comfy_cli/cmdline.py

Lines 102 to 110 in 38fa4b2

	enable_telemetry: Annotated[
	bool,
	typer.Option(
	show_default=False,
	hidden=True,
	is_flag=True,
	help="Enable tracking",
	),
	] = False,

comfy-cli/comfy_cli/cmdline.py

Line 125 in 38fa4b2

tracking.prompt_tracking_consent(skip_prompt, default_value=enable_telemetry)

The option is hidden from help output: #264 (comment)

---

--no-enable-telemetry doesn't seem necessary then? Same behaviour with/without it:

$ comfy --skip-prompt tracking disable
warn: The recent workspace None is not a valid ComfyUI path.
Tracking is now disabled.


$ cat ~/.config/comfy-cli/config.ini
[DEFAULT]
enable_tracking = False

$ rm -f ~/.config/comfy-cli/config.ini
$ comfy --skip-prompt env

warn: The recent workspace None is not a valid ComfyUI path.
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ 💻 Environment                       ┃ Value                                              ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ Python Version                       │ 3.13.3                                             │
│ Python Executable                    │ /root/.local/share/pipx/venvs/comfy-cli/bin/python │
│ Virtualenv Path                      │ Not Used                                           │
│ Conda Env                            │ Not Used                                           │
│ Config Path                          │ /root/.config/comfy-cli/config.ini                 │
│ Default ComfyUI workspace            │ No default ComfyUI workspace                       │
│ Default ComfyUI launch extra options │ None                                               │
│ Recent ComfyUI workspace             │ No recent run                                      │
│ Tracking Analytics                   │ Disabled                                           │
│ Background ComfyUI                   │ No                                                 │
│ Comfy Server Running                 │ No                                                 │
│ Current selected workspace           │ → /root/comfy/ComfyUI                              │
└──────────────────────────────────────┴────────────────────────────────────────────────────┘


$ cat ~/.config/comfy-cli/config.ini
[DEFAULT]
enable_tracking = False

I suppose it's relevant if the default was ever changed? 🤔