You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
docs(desktop): document the macOS reset script and where the app log lives - #2229
The macOS install page ended at "uninstall + delete the leftovers". It had nothing for the other half of that surface: the app launching in a broken state after a manual update, which is the failure the repo's reset script exists for, and which linux.mdx already documents for Linux. This adds two sections to installation/desktop/macos.mdx:
## If Comfy Desktop Starts Up Broken: what the symptom looks like (no styling, missing translations, buttons and dropdowns that do nothing), why it happens (a Chromium profile or a cached pending update from the previous version), and the reset-mac.sh one-liner from the Comfy-Desktop repository. States that the script lists what it will delete and asks first, refuses to run while the app is open, keeps ~/ComfyUI-Installs and ~/ComfyUI-Shared on disk, deletes the installations registry so instances may need Add Existing Instance afterwards, and reports extra app copies without deleting them.
### Where the App Log Is: the file to attach to a report (app.log under ~/Library/Logs/Comfy Desktop), the per-launch rotation with app.log_<timestamp>.log siblings, the 50-file retention, and the 5 MB rotation, so a reader picks the file from the session that failed.
No existing content or figure is changed; nothing is removed.
Sources
Every claim was checked against Comfy-Org/Comfy-Desktoporigin/main (039fee4a):
scripts/reset-mac.sh: product-name, package-name and bundle-id target lists, the pgrep guard for a running app, "The following will be permanently deleted" + Proceed? [y/N], mdfind app-copy reporting, and the header note that installations.json is removed so installs may need re-adding.
src/main/installations.ts / src/main/lib/paths.ts: the registry lives under the app's data directory, which is inside the folder the script deletes.
locales/en.json: the current label is Add Existing Instance (fileMenu.addExistingInstall), not the script's own older wording.
The table paths already on the page (~/Library/Application Support/Comfy Desktop, ~/Library/Logs/Comfy Desktop) were re-checked and are correct for packaged builds: todesktop.json sets packageJson.productName = "Comfy Desktop", and the repository README documents the dev (comfyui-desktop-2) vs packaged (Comfy Desktop) split.
No screenshot: the subject is a shell script plus a log directory, with no app interface state to capture. The page keeps its two existing figures (.dmg install, Move to Trash).
Translations
zh, ja, ko and es are in this PR with localized headings and prose; the same five files, no docs.json change. sync-hash refreshed translationSourceHash and added the page's translationBlockHashes block (the sibling macOS/Windows/Linux pages already carry one).
Local checks: check-structure-parity --base=upstream/main OK, check-anchors --only-changed OK, verify_content_parity 0 gaps, no em dashes.
No actionable comments were generated in the recent review.
Walkthrough
The macOS installation pages add reset instructions for broken launches and guidance for locating and reporting logs. The localized pages update translation hashes. The Japanese, Korean, and Chinese pages also include shared-model removal in the uninstall steps.
Changes: macOS installation guides
Layer / File(s)
Summary
Reset and log guidance installation/desktop/macos.mdx, es/installation/desktop/macos.mdx, ja/installation/desktop/macos.mdx, ko/installation/desktop/macos.mdx, zh/installation/desktop/macos.mdx
The guides describe running the reset script after quitting Comfy Desktop, its confirmation and app-open checks, and the settings, caches, profiles, and logs it removes. They state which installations and models it preserves and how it handles installation records and extra app copies. The guides also document the log location, retention, and rotation. Japanese, Korean, and Chinese guides add shared-model removal to the uninstall steps. Translation hashes are updated.
Possibly related PRs
Comfy-Org/docs#2101: Reverts a PR that added the Spanish macOS page, which this change also updates.
The guides now explain how to preserve diagnostic logs before resetting Comfy Desktop. The previously identified log-loss concern is addressed across all five languages.
Pre-merge checks: 2
Check name
Status
Explanation
Linked Issues check
Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check
Check skipped because no linked issues were found for this pull request.
Finishing Touches
Generate unit tests (beta)
Create a new PR
Simplify code
Create a new PR
Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
CodeRabbit Verify
Run CodeRabbit Verify to test the changes in this pull request.
Recent review info
Run configuration
Source mode: Auto
Repository: Unavailable
Branch: Unavailable
File: No configuration file from this repository applied
Commit: Unavailable
Layers: Organization UI
Review profile: ASSERTIVE
Plan: Advanced
Run ID: 2795325b-7eb2-4c00-a170-e4d9d441ae72
Commits
Reviewing files that changed from the base of the PR and between 6e1ad33 and b67959f.
Files selected for processing: 5
es/installation/desktop/macos.mdx
installation/desktop/macos.mdx
ja/installation/desktop/macos.mdx
ko/installation/desktop/macos.mdx
zh/installation/desktop/macos.mdx
Included review availability: This review used your included allowance. Your plan provides up to 2 included reviews per hour; 0 remain after this review.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
What this adds
The macOS install page ended at "uninstall + delete the leftovers". It had nothing for the other half of that surface: the app launching in a broken state after a manual update, which is the failure the repo's reset script exists for, and which
linux.mdxalready documents for Linux. This adds two sections toinstallation/desktop/macos.mdx:## If Comfy Desktop Starts Up Broken: what the symptom looks like (no styling, missing translations, buttons and dropdowns that do nothing), why it happens (a Chromium profile or a cached pending update from the previous version), and thereset-mac.shone-liner from the Comfy-Desktop repository. States that the script lists what it will delete and asks first, refuses to run while the app is open, keeps~/ComfyUI-Installsand~/ComfyUI-Sharedon disk, deletes the installations registry so instances may need Add Existing Instance afterwards, and reports extra app copies without deleting them.### Where the App Log Is: the file to attach to a report (app.logunder~/Library/Logs/Comfy Desktop), the per-launch rotation withapp.log_<timestamp>.logsiblings, the 50-file retention, and the 5 MB rotation, so a reader picks the file from the session that failed.No existing content or figure is changed; nothing is removed.
Sources
Every claim was checked against
Comfy-Org/Comfy-Desktoporigin/main(039fee4a):scripts/reset-mac.sh: product-name, package-name and bundle-id target lists, thepgrepguard for a running app, "The following will be permanently deleted" +Proceed? [y/N],mdfindapp-copy reporting, and the header note thatinstallations.jsonis removed so installs may need re-adding.src/main/lib/appLog.ts:BASE_NAME = 'app.log',MAX_BYTES = 5 MB,MAX_FILES = 50, per-launch rotation toapp.log_<timestamp>.log.src/main/installations.ts/src/main/lib/paths.ts: the registry lives under the app's data directory, which is inside the folder the script deletes.locales/en.json: the current label is Add Existing Instance (fileMenu.addExistingInstall), not the script's own older wording.~/Library/Application Support/Comfy Desktop,~/Library/Logs/Comfy Desktop) were re-checked and are correct for packaged builds:todesktop.jsonsetspackageJson.productName = "Comfy Desktop", and the repository README documents the dev (comfyui-desktop-2) vs packaged (Comfy Desktop) split.No screenshot: the subject is a shell script plus a log directory, with no app interface state to capture. The page keeps its two existing figures (
.dmginstall, Move to Trash).Translations
zh, ja, ko and es are in this PR with localized headings and prose; the same five files, no
docs.jsonchange.sync-hashrefreshedtranslationSourceHashand added the page'stranslationBlockHashesblock (the sibling macOS/Windows/Linux pages already carry one).Local checks:
check-structure-parity --base=upstream/mainOK,check-anchors --only-changedOK,verify_content_parity0 gaps, no em dashes.