Skip to content

chore: v2 CLI rollback steps are easier to follow - #1076

Merged
hatayama merged 1 commit into
v3-betafrom
feature/hatayama/document-v2-cli-rollback
May 8, 2026
Merged

chore: v2 CLI rollback steps are easier to follow#1076
hatayama merged 1 commit into
v3-betafrom
feature/hatayama/document-v2-cli-rollback

Conversation

@hatayama

@hatayama hatayama commented May 8, 2026

Copy link
Copy Markdown
Owner

Summary

  • Document the UI-first path for returning to the v2 CLI line from Settings.
  • Add terminal fallback commands for users whose uloop command still resolves to the v3 CLI.

User Impact

  • Users who decide to go back to the latest v2 release can follow the downgrade flow without learning internal CLI implementation terms.
  • The English and Japanese README copies now describe the same rollback path.

Changes

  • Added v2 rollback guidance to the Quickstart CLI install section.
  • Added macOS/Linux and Windows terminal fallback commands using uloop-cli@2.1.1.
  • Synced the package README copies from the root README files.

Verification

  • scripts/sync-readmes.sh --check

Overview

This pull request updates documentation across the root and package READMEs to provide clearer guidance for users who need to downgrade from the v3 CLI back to v2. The changes are replicated in both English and Japanese versions to ensure consistency.

Changes

Documentation Updates (English & Japanese versions synchronized):

  • README.md / README_ja.md (+20 lines): Enhanced the Quickstart/installation instructions with a new "Return to v2 CLI" section that guides users through the UI-based downgrade path via Settings, including steps to uninstall the CLI, downgrade the U-LOOP package to v2, and reinstall.

  • README.md / README_ja.md: Extended the CLI-only terminal install section with fallback commands for users whose uloop command still resolves to the v3 CLI, including:

    • POSIX shell: Remove existing ~/.local/bin/uloop and reinstall uloop-cli@2.1.1
    • Windows PowerShell: Remove v3 launcher and reinstall uloop-cli@2.1.1
  • Packages/src/README.md / Packages/src/README_ja.md (+21 lines): Mirrored the same rollback guidance to package-level documentation and updated the settings configuration filename reference from UserSettings/UnityCliLoopSettings.json to UserSettings/UnityMcpSettings.json, noting it as a historical compatibility filename.

Verification

  • All documentation changes are UI-first with terminal-based fallback instructions
  • English and Japanese versions now document the same rollback path consistently
  • Changes are documentation-only with no impact to exported or public code entities

@coderabbitai

coderabbitai Bot commented May 8, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 8117a95b-f000-4673-b8d8-529c31de4498

📥 Commits

Reviewing files that changed from the base of the PR and between bc3c654 and cc2bb22.

📒 Files selected for processing (4)
  • Packages/src/README.md
  • Packages/src/README_ja.md
  • README.md
  • README_ja.md

📝 Walkthrough

Walkthrough

Documentation across four README files (English and Japanese, main and package) updated with instructions for downgrading from CLI v3 to v2, including both Settings-based and terminal-based recovery paths. Settings filename reference updated from UnityCliLoopSettings.json to UnityMcpSettings.json.

Changes

CLI v2 Downgrade Instructions

Layer / File(s) Summary
Settings File Reference
Packages/src/README.md, Packages/src/README_ja.md
Settings filename documentation updated from UserSettings/UnityCliLoopSettings.json to UserSettings/UnityMcpSettings.json with clarification that it is a historical compatibility name for per-user local-only editor state.
GUI-Based v2 Return Path
README.md, README_ja.md, Packages/src/README.md, Packages/src/README_ja.md
Quickstart instructions added explaining how to return to v2 CLI by uninstalling via Settings, downgrading the U-LOOP package to a v2 version (example 2.1.1), and reinstalling the CLI.
Terminal-Based v2 Recovery
README.md, README_ja.md, Packages/src/README.md, Packages/src/README_ja.md
Terminal install instructions extended with remediation steps for cases where the Unity UI path is unavailable or uloop resolves to the v3 CLI. Includes commands to remove the existing uloop executable and install uloop-cli@2.1.1 with separate blocks for POSIX shells and Windows PowerShell, including verification commands.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • hatayama/unity-cli-loop#851: Updates the UserSettings filename reference to UnityMcpSettings.json alongside related CLI documentation changes.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feature/hatayama/document-v2-cli-rollback

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@hatayama
hatayama merged commit c41c952 into v3-beta May 8, 2026
3 of 4 checks passed
@hatayama
hatayama deleted the feature/hatayama/document-v2-cli-rollback branch May 8, 2026 13:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant