Install experience: PATH setup, CLI card in General, condensed README, install-modal copy - #1035
Merged
Conversation
Split the intro into shorter beats and fix its typos, replace the six-row feature table with a 2x2 grid of the four surfaces (desktop, web, terminal, mobile), and restructure Install around them: the one-liner leads and states what it gets you, GitHub Releases is framed as the same outcome by another route, and ade connect is described as what it is -- linking a machine to your account, run for you by the installer and by desktop sign-in. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub. |
|
Warning Review limit reached
Next review available in: 15 minutes You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: ⛔ Files ignored due to path filters (3)
📒 Files selected for processing (4)
📝 WalkthroughWalkthroughChangesInstallation experience
Estimated code review effort: 3 (Moderate) | ~25 minutes Possibly related PRs
Suggested labels: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
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. Comment |
Updated installation instructions and clarified the functionality of the ADE Brain and UI clients.
…e the README The POSIX installer now writes ~/.ade/env and, with consent, appends one marker-guarded line to the right shell profile, so the promoted one-liner no longer ends in 'ade: command not found'. It is idempotent, skips non-interactive and fish/unknown shells with a printed hint, honors ADE_INSTALL_NO_PATH=1, and runs before sign-in. Windows gains the closing next-step it was missing under -NoPath. The 'ADE command' settings card moves from Integrations to General, and its not-on-PATH copy now points at the same install story. The README's CLI-through-Develop block drops from 285 lines to 41; the detail moves verbatim to docs/development/local-development.md. Install prompts now say 'sign in or create your ADE account'. Website install modals lose the redundant subtitles and blurbs, and the app download column reads 'or Download from file'. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
arul28
changed the title
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@apps/ade-cli/README.md`:
- Line 74: Update the PowerShell installer’s path-handling logic around the
NoPath option so install-runtime.ps1 also sets $NoPath when the
ADE_INSTALL_NO_PATH environment variable equals "1", preventing persistent user
PATH updates; keep the existing -NoPath behavior unchanged.
In `@apps/ade-cli/scripts/install-runtime.ps1`:
- Around line 480-486: Update the -NoPath branch in the install-runtime output
flow to emit a valid PowerShell invocation when $adeCommand contains spaces:
format the command with the call operator (&) and quoted executable path,
followed by connect --status --text. Keep the existing output behavior for the
non--NoPath branch unchanged.
In `@apps/ade-cli/scripts/install-runtime.sh`:
- Around line 262-267: Update the zsh profile selection logic in the install
script to always use $HOME/.zshrc for PATH setup, including when only .zprofile
exists; create .zshrc when it is missing instead of selecting .zprofile.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: d98a779b-aabd-4fbf-a16e-e007bc9d359b
⛔ Files ignored due to path filters (4)
README.mdis excluded by!*.mddocs/README.mdis excluded by!docs/**docs/development/local-development.mdis excluded by!docs/**docs/features/onboarding-and-settings/README.mdis excluded by!docs/**
📒 Files selected for processing (10)
apps/ade-cli/README.mdapps/ade-cli/scripts/install-runtime.ps1apps/ade-cli/scripts/install-runtime.shapps/ade-cli/src/cli.tsapps/desktop/src/renderer/components/app/SettingsPage.tsxapps/desktop/src/renderer/components/settings/AdeCliSection.tsxapps/desktop/src/renderer/components/settings/settingsManifest.tsapps/web/src/components/editorial/Lede.tsxapps/web/src/components/install/InstallDialog.tsxapps/web/src/lib/installTargets.ts
| For an unpublished Windows proof bundle, run `install.ps1 -AssetDirectory <bundle-directory>` (or set `ADE_RELEASE_ASSET_DIR`) to install the local checksum, executable, and native archive without creating a GitHub Release. | ||
|
|
||
| The POSIX script downloads `ade-<platform-arch>` to `$ADE_INSTALL_DIR/ade`; the PowerShell script downloads `ade-win32-x64.exe` to `$ADE_INSTALL_DIR\ade.exe`. Both verify the binary and matching `.native.tar.gz` against `SHA256SUMS`, extract native dependencies under `$ADE_HOME/runtime/<platform-arch>/`, run `ade --version`, and register the per-user login service. The PowerShell installer also adds the install directory to the current user's `PATH` unless `-NoPath` is passed; use `-NoService` to skip startup registration. | ||
| The POSIX script downloads `ade-<platform-arch>` to `$ADE_INSTALL_DIR/ade`; the PowerShell script downloads `ade-win32-x64.exe` to `$ADE_INSTALL_DIR\ade.exe`. Both verify the binary and matching `.native.tar.gz` against `SHA256SUMS`, extract native dependencies under `$ADE_HOME/runtime/<platform-arch>/`, run `ade --version`, and register the per-user login service. Both put `ade` on `PATH`. The PowerShell installer adds the install directory to the current user's `PATH` (idempotently, then broadcasts `WM_SETTINGCHANGE`) and tells you to open a new terminal. The POSIX installer writes `$ADE_HOME/env` — a guarded `case ":${PATH}:" in ... esac` prepend that is safe to source repeatedly — and, with consent on a tty, appends one marker-commented block (`# >>> ade >>>` / `. "$HOME/.ade/env"` / `# <<< ade <<<`) to `~/.zshrc` (zsh; `~/.zprofile` only when no `~/.zshrc` exists), `~/.bash_profile` (bash on macOS) or `~/.bashrc` (bash on Linux). It greps for the marker first, so re-running the installer — which is also the update path — never duplicates the block. fish and unrecognized shells are never edited: the installer prints `fish_add_path "<dir>"` or the source line instead, as it does with no tty or with `ADE_INSTALL_NO_PATH=1`. After a profile edit the closing output tells you to run `. "$HOME/.ade/env"` or open a new terminal. Both accept `-NoPath` / `ADE_INSTALL_NO_PATH=1`; use `-NoService` to skip startup registration. |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟠 Major | ⚡ Quick win
Map ADE_INSTALL_NO_PATH in the PowerShell installer.
This line says install.ps1 accepts ADE_INSTALL_NO_PATH=1. However, install-runtime.ps1 only checks the -NoPath switch before it updates the user PATH. An environment-only opt-out still changes persistent user state.
Set $NoPath = $true when ADE_INSTALL_NO_PATH is 1, or remove this claim.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@apps/ade-cli/README.md` at line 74, Update the PowerShell installer’s
path-handling logic around the NoPath option so install-runtime.ps1 also sets
$NoPath when the ADE_INSTALL_NO_PATH environment variable equals "1", preventing
persistent user PATH updates; keep the existing -NoPath behavior unchanged.
The worktree-graph image and its catch-all caption leave the README. The signed-release section leaves CONTRIBUTING, which now says the thing that actually matters: contributions are wanted, and good PRs get merged. 115 lines to 33. Also repoints two stale README anchors at the new local-development doc. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The blanket *.png ignore already carried negations for docs, web public, and iOS assets; assets/ was missing, so hero.png had to be force-added. Add the negation so README captures track normally. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Three failure modes, all post-install: an unset HOME crashed the script under set -u once ADE_HOME was supplied (docker RUN, systemd units, some CI images), an unwritable env file aborted under set -e and could leave a profile sourcing a file that does not exist, and the marker block was three writes so concurrent installs could interleave into one another. HOME is now guarded, the env write degrades to a printed hint, and the block is a single append. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
… command, always use .zshrc Review findings, all real. The README promised install.ps1 accepts ADE_INSTALL_NO_PATH=1 but it only read the -NoPath switch, and `irm ... | iex` cannot take parameters, so the env var was the only possible opt-out on the one-liner we promote and it did nothing. Under -NoPath the printed next step interpolated a bare absolute path, which stops being runnable once it contains a space. And zsh only read .zshrc for interactive shells, so preferring an existing .zprofile left PATH missing in the non-login shells editors and multiplexers spawn. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Install / onboarding
adeon PATH. Previously the POSIX installer only printed a hint, so the promoted command ended inade: command not foundin the next shell. It now writes a guarded~/.ade/envand, after asking, appends one marker-wrapped line to the right profile (zsh →.zshrc; bash →.bash_profileon macOS,.bashrcon Linux). Idempotent, so the update path never re-prompts or duplicates. Non-interactive runs, fish, and unknown shells get a printed hint instead of an edited dotfile;ADE_INSTALL_NO_PATH=1opts out. Runs before sign-in, and when it edits a profile it tells you how to fix the current shell. Verified by a 10-case sandbox harness that extracts the real block and runs it against a tempHOME.-NoPathended the install with no next step.Desktop
?integration=clideep link follow automatically; Integrations is now just GitHub + Linear. Not-on-PATH copy ties into the install story and names the platform-correct one-liner for machines without the desktop app.README
## CLIthrough the Validate line: 285 lines → 41. Nothing deleted: the glossary, brain-vs-manual-runtime table, what-to-rebuild matrix, dev command matrix, lane-worktree instructions, browser preview, socket warning, and Alpha/Beta packaging all move verbatim todocs/development/local-development.md, linked from Develop and added to the docs nav map.Website
Verification
sh -n/dash -nclean · 10/10 installer PATH sandbox cases · desktop typecheck + eslint clean · 53 desktop tests (settings manifest, SettingsPage, adeCliService) · web build + 9 analytics tests ·validate-docsclean apart from the known placeholder below.Follow-up before merge
assets/readme/web-client.pngis still referenced by the web-client grid cell and not yet added (TODO(readme)comment marks it). Drop the capture at that path and the tile renders.Note: the install scripts ship as release assets, so the live
install.shkeeps the old PATH behavior until the next release cut.🤖 Generated with Claude Code
Summary by CodeRabbit
New Features
Improvements