@unity-china/codely-cli 1.0.0-rc.36 → 1.0.0-rc.37

package/README.md

@@ -327,6 +327,40 @@ If you encounter issues, please check the error messages and ensure:
 - All dependencies are properly installed
 - API keys are correctly configured in settings
 
+### Crash Logs
+
+When Codely CLI exits unexpectedly, it writes a best-effort crash report to:
+
+```text
+~/.codely-cli/crash-logs/crash-YYYYMMDD-HHmmss-<pid>.log
+```
+
+On Windows, this usually expands to:
+
+```text
+%USERPROFILE%\.codely-cli\crash-logs\crash-YYYYMMDD-HHmmss-<pid>.log
+```
+
+To inspect the newest crash log in PowerShell:
+
+```powershell
+Get-ChildItem "$env:USERPROFILE\.codely-cli\crash-logs" -Filter "*.log" |
+  Sort-Object LastWriteTime -Descending |
+  Select-Object -First 1 |
+  Get-Content
+```
+
+Set `CODELY_CRASH_LOG_DIR` to redirect crash reports for reproduction:
+
+```powershell
+$env:CODELY_CRASH_LOG_DIR="C:\Temp\codely-crash-logs"
+codely
+```
+
+Crash reports include the crash type, error message, stack trace, platform,
+Node.js version, memory usage, and current working directory. Review paths before
+sharing logs externally and redact sensitive information if needed.
+
 ## License
 
 [LICENSE](./LICENSE)