Skip to content

fix(install): print node up/down in the quick start - #1918

Open
khaliqgant wants to merge 5 commits into
mainfrom
fix/installer-quickstart-node-commands
Open

khaliqgant wants to merge 5 commits into
mainfrom
fix/installer-quickstart-node-commands

Conversation

@khaliqgant

@khaliqgant khaliqgant commented Oct 8, 2026 •

Copy link
Copy Markdown
Member

Bug

After installing, install.sh prints:

agent-relay up --background
agent-relay down

Both commands moved under node. agent-relay up fails with error: unknown command 'up', and agent-relay down prints the top-level help. A new user's first command fails. This was reported as a known issue on our agent's live knowledge page.

Fix

  • The quick start now says agent-relay node up --background and agent-relay node down; agent-relay status is unchanged.
  • Regression test in bootstrap.test.ts: it extracts every agent-relay … line from print_usage and resolves each word against createProgram()'s real command tree. It fails on the old script (agent-relay up --background: no "up" command) and passes with the fix, so the quick start can't drift from the CLI again.

Note: node up on 11.3.0 and earlier printed the workspace key; the installer installs the current 13.x, which masks it.

🤖 Generated with Claude Code

View guided diff


Note

Low Risk
Installer messaging and tests only; no runtime broker or auth behavior changes.

Overview
Fixes post-install Quick Start text so it matches the current CLI: agent-relay node up --background and agent-relay node down instead of removed top-level up/down that error on first run.

install.sh picks the printed form from AGENT_RELAY_VERSION: pinned releases before 9.2.2 still show the legacy agent-relay up/down lines.

Adds regression coverage in bootstrap.test.ts that runs print_usage for several versions and walks each suggested command against createProgram(), so installer hints cannot drift from real subcommands again.

Reviewed by Cursor Bugbot for commit 7279644. Bugbot is set up for automated code reviews on this repo. Configure here.


Agent Relay sessions

  • claude session 1e2adfbe · opened via gh pr create · last active 2026-10-08

The installer's quick start printed `agent-relay up --background` and
`agent-relay down` after both moved under `node`; `up` fails with
"unknown command 'up'" and `down` prints the top-level help. A test now
resolves every quick-start command against the real command tree.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 8, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-08T05:02:10.275660Z 7279644 Manual request
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@coderabbitai

coderabbitai Bot commented Oct 8, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: b198e6b1-1207-4780-be35-c6250cc04fd6
📥 Commits

Reviewing files that changed from the base of the PR and between 1bbd4e9 and 7279644.

📒 Files selected for processing (3)
  • CHANGELOG.md
  • install.sh
  • packages/cli/src/cli/bootstrap.test.ts
🚧 Files skipped from review as they are similar to previous changes (1)
  • CHANGELOG.md

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 3 remain after this review.


📝 Walkthrough

Walkthrough

The installer selects Quick Start up and down commands based on VERSION. Versions below 9.2.2 use top-level commands; other versions use the node group. Tests check the displayed commands, and the changelog records the update.

Changes

Quick Start commands

Layer / File(s) Summary
Select commands by version
install.sh
The installer uses top-level up and down commands for parsed versions below 9.2.2. For other versions, it uses node up and node down. The status example is unchanged.
Validate and document command forms
packages/cli/src/cli/bootstrap.test.ts, CHANGELOG.md
Tests check that current Quick Start commands match the CLI command tree and that versions 9.2.1, 9.2.2, and 13.1.5 use the expected command forms. The changelog records the command update and version condition.

Priority: ➖ Normal

Estimated code review effort: 2 (Simple) | ~8 minutes

Change: Bug fix

Merge Risk: ⚪ Minimal · up to 72796

The Quick Start commands are selected by the documented version threshold, and no supported pin incompatibility is established. No actionable merge-blocking risk remains.

🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (2 warnings)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description explains the bug, fix, and regression test, but it does not use the required template sections. It omits the RelayFlow Proof fields and the required test-plan checklist. Add the required ## Summary, ## Test Plan, ## RelayFlow Proof, and ## Screenshots sections. Complete the test-plan checkboxes and set the RelayFlow Proof to feature or bugfix with exactly one valid case under `tests/relayflows/c…
Docstring Coverage ⚠️ Warning Docstring coverage is 50.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 2 functions across 2 files. (1 skipped: 1… Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the primary change: updating installer Quick Start commands to use node up and node down.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Full details: Description check

Resolution

Add the required ## Summary, ## Test Plan, ## RelayFlow Proof, and ## Screenshots sections. Complete the test-plan checkboxes and set the RelayFlow Proof to feature or bugfix with exactly one valid case under tests/relayflows/cases/&lt;case-id&gt;/. Use non-functional and n/a only if runtime behavior is unchanged.

Full details: Docstring Coverage

Explanation

Docstring coverage is 50.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 2 functions across 2 files. (1 skipped: 1 unsupported.)

  • Fix all pre-merge checks with AI
✨ Finishing Touches 💡 1
📝 Generate docstrings 💡
  • Commit to this branch
  • Create a new PR
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

A rabbit checks the commands in a row
Below nine-two-two, the old forms show
Then node up and node down appear
Tests check each path with twitching ear
The changelog notes what changed this year

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

@devin-ai-integration devin-ai-integration Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔍 Devin Review: 2 flags

Not posted on this PR by your GitHub settings — view them in Devin Review. (Configure)

Devin Review

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 21017cfa24

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread install.sh Outdated

@cubic-dev-ai cubic-dev-ai Bot left a comment •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All reported issues were addressed across 2 files

Reply with feedback, questions, or to request a fix.

View guided diff | Re-trigger cubic

Comment thread packages/cli/src/cli/bootstrap.test.ts Outdated
Comment thread install.sh Outdated
Proactive Runtime Bot and others added 3 commits October 7, 2026 20:10
Add an [Unreleased - Patch] Fixed entry for the installer's node up/down
commands, and let the quick start test skip <placeholders> and words after
a leaf command so a future positional value does not fail it.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@khaliqgant

Copy link
Copy Markdown
Member Author

CI note on head 1bbd4e95e: the two non-green checks don't come from this PR's changes.

test (macos-latest, 22.14.0) failed (job)

  • The one failing test is tests/fixtures/pr-proof-contract.test.ts > process timeout contract > terminates descendants that inherit output pipes instead of hanging after the parent exits. It timed out at 5000 ms, and Vitest reported an uncaught kill EPERM from scripts/pr-proof/process-runner.mjs:41 (process.kill(-child.pid, signal) inside signalProcessTree / forceKill). That is a macOS race: the runner signals a process group that has already exited.
  • This PR changes only install.sh, packages/cli/src/cli/bootstrap.test.ts and CHANGELOG.md. It doesn't touch scripts/pr-proof/ or that test. 3654 other tests passed, the new bootstrap quick-start test among them, and test (ubuntu-latest, 22.14.0) passed on the same head.
  • The previous Test run on this branch (37721497576) failed only on lint, which the Prettier commit fixed. Its macOS test job passed. The last 7 Test runs on main passed, so this is a flaky test and not a regression on main.
  • I've re-run the failed job.

Test on ubuntu-20.04 (with-node) stays queued

  • GitHub retired the ubuntu-20.04 hosted runner, so this matrix entry (.github/workflows/test-install.yml:55) never gets a runner. The same Test Install Script workflow is still queued on the v13.1.3, v13.1.4 and v13.1.5 tag runs too. It isn't a required check, and every other install-script job passed: ubuntu-latest and macos-latest with and without Node, Fedora, Alpine, and no-gunzip. This should be handled in a separate PR.

@khaliqgant

Copy link
Copy Markdown
Member Author

@codex review

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 1bbd4e95e3

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread install.sh Outdated
@khaliqgant

Copy link
Copy Markdown
Member Author

Re-run result: test (macos-latest, 22.14.0) passed on the same head 1bbd4e95e (run 37723873554). That confirms the pr-proof-contract failure was flaky. The only check still not green is Test on ubuntu-20.04 (with-node), which stays queued because that runner was retired. It isn't a required check.

… pinned installs

The node command group arrived in 9.2.2, so an AGENT_RELAY_VERSION pin to
an older release would be told to run commands it lacks. The quick-start
test now executes print_usage for latest, 9.2.1 and later versions.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@khaliqgant

Copy link
Copy Markdown
Member Author

@codex review

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. Nice work!

Reviewed commit: 7279644157

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

This branch has not been deployed

No deployments
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