feat(scripts): Add Q CLI installation script #823

kkashilk · 2025-10-21T22:11:54Z

Issue #, if available:
Add Q CLI installation script

Description of changes:
Add installation script for Q CLI that:

Detects platform (macOS/Linux) and architecture
Downloads appropriate package from release CDN
Verifies checksums and GPG signatures
Handles both glibc and musl Linux variants
Provides interactive installation with progress feedback
Includes cleanup of temporary files

🤖 Assisted by Amazon Q Developer

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

brandonskiser · 2025-10-22T16:30:11Z

scripts/install.sh

+
+    local glibc_version
+    if command -v ldd >/dev/null 2>&1; then
+        glibc_version=$(ldd --version 2>/dev/null | head -1 | grep -o '[0-9]\+\.[0-9]\+' | head -1)


We know how reliable this check is? Can this be a common function that has multiple checks? https://github.com/aws/amazon-q-developer-cli-autocomplete/blob/main/bundle/linux/install.sh#L83

Also consider defining constants for the supported versions

readonly MIN_GLIBC_MAJOR=2 readonly MIN_GLIBC_MINOR=34

brandonskiser · 2025-10-22T16:36:02Z

scripts/install.sh

@@ -0,0 +1,522 @@
+#!/bin/bash
+
+set -e


Consider adding set -eu as well to avoid silent errors (also set -o pipefail potentially although probably not needed)

scripts/install.sh

brandonskiser · 2025-10-22T16:43:58Z

scripts/install.sh

+    local app_name
+    app_name=$(basename "$app_bundle")
+
+    log "Installing $app_name to $MACOS_APP_DIR..."


What if the desktop app is already running? Won't this break in that case?

I tried this, and didn't see a failure. I think this scenario is unlikely too, IOW most users wouldn't run the install script if they have q-cli/kiro installed already and were running the Desktop app already

brandonskiser · 2025-10-22T23:13:00Z

scripts/install.sh

+
+    mkdir -p "$HOME/.local/bin"
+    local macos_bin="$MACOS_APP_DIR/$app_name/Contents/MacOS"
+    cp -f "$macos_bin/q" "$macos_bin/qchat" "$macos_bin/qterm" "$HOME/.local/bin/"


Shouldn't these be symlinks like they are currently?

akhileshb · 2025-10-22T23:38:30Z

scripts/install.sh

+    fi
+
+    cp -R "$app_bundle" "$MACOS_APP_DIR/"
+


When I try to download the binary from console and open the application, Mac gives a warning

"“Amazon Q” is an app downloaded from the Internet. Are you sure you want to open it?"

Searching in the internet, found that this can flag can be removed. Should we add something like this since we are installing this via CLI and would want to automate this action

xattr -dr com.apple.quarantine "$MACOS_APP_DIR/$app_name" 2>/dev/null || true

Hmm, will this quarantine flag be set when downloading the DMG in the terminal 🤔

https://stackoverflow.com/questions/46198557/understanding-output-of-xattr-p-com-apple-quarantine

No it would not be set, thats my point.

As of today, once the desktop is installed, developers have to open the App atleast one time to setup things up (thats my understanding, correct me if I am wrong and its its not a prerequisite) for thing to be setup during which UX would appear to trust the App which would be set this flag

However, in this new world that user flow is gone and user is NOT going to open the App to get going. Hence setting this flag would enable us to automatically open it (by us behind the scenes if needed) or in future when user opens it they don't have o go through that trust UX flow.

akhileshb · 2025-10-22T23:52:06Z

scripts/install.sh

+
+    hdiutil detach "$mount_path" -quiet
+
+    mkdir -p "$HOME/.local/bin"


Why ~/.local/bin and not /usr/local/bin.

By default, user local is included in the path but don't think .local bin is. I currently see my Q is in local bin, so guessing this is precedence and the desktop App does this symlink today?

iirc, we've always created symlink in the ~/home/.local/bin folder.
See -

amazon-q-developer-cli-autocomplete/crates/fig_desktop/src/install.rs

Line 323 in f2c1658

let dest = local_bin.join(CLI_BINARY_NAME);

akhileshb · 2025-10-22T23:53:50Z

scripts/install.sh

+    echo
+    success "$CLI_NAME installation completed successfully!"
+    echo
+    echo "Next steps:"
+    echo "1. Run: $COMMAND_NAME --help to get started"


If we end sticking with ~/.local/bin for the application location. We should check if it exists in the path and if not warn users to add that in your shell profile. If not this command would not work for them.

Also, we should show where we installed the binary so that its clear where the finally executable is

Do we need to print it out, or is it enough to document it?

If its in the path, we could omit it. But when its not in the path, we need to print it and suggest to add that to their path

akhileshb · 2025-10-23T00:01:49Z

scripts/install.sh

+}
+
+# Cleanup function - only removes files/dirs we created
+cleanup() {


For a happy case, we show "install complete". However due to whatever issue, we fail we need to communicate that as well

This might be a good place to show that since this cleanup would be called after the script ends "Installation failed. Cleaning up"

SUCCESS=false cleanup() { if [ "$SUCCESS" = false ]; then echo "Installation failed. Cleaning up" fi // clean code }

akhileshb · 2025-10-23T00:58:21Z

scripts/install.sh

+    fi
+
+    local mount_path
+    mount_path=$(hdiutil attach "$dmg_path" -nobrowse | grep Volumes | cut -f 3)


Let's just do -readonly just to be safe

akhileshb · 2025-10-23T01:06:05Z

scripts/install.sh

+
+    cp -R "$app_bundle" "$MACOS_APP_DIR/"
+
+    hdiutil detach "$mount_path" -quiet


Should we add this in the cleanup as independent of any success/fails we want to unmount it?

For example, say the above copy files, we want to un mount. I know you already add this in few if conditions above, rather it might make sense to handle this in catch all.

Sure, makes sense to detach in the finally block

Add comprehensive installation script for Q CLI that: - Detects platform (macOS/Linux) and architecture - Downloads appropriate package from release CDN - Verifies checksums and GPG signatures - Handles both glibc and musl Linux variants - Provides interactive installation with progress feedback - Includes cleanup of temporary files 🤖 Assisted by Amazon Q Developer

…install

- Check if ~/.local/bin is on PATH after installation and warn users - Skip setup commands when Linux install.sh is called from main installer - Add Q_SKIP_SETUP environment variable to control setup execution

kkashilk requested a review from a team as a code owner October 21, 2025 22:11

kkashilk force-pushed the install-script branch from 733f728 to 2a97966 Compare October 21, 2025 22:34

brandonskiser reviewed Oct 22, 2025

View reviewed changes

brandonskiser approved these changes Oct 22, 2025

View reviewed changes

akhileshb reviewed Oct 22, 2025

View reviewed changes

akhileshb reviewed Oct 23, 2025

View reviewed changes

akhileshb approved these changes Oct 24, 2025

View reviewed changes

kkashilk added 7 commits October 24, 2025 11:28

Remove GPG verification for simplicity

9b94da7

Update glibc detection logic and address comments

f326d59

Use manifest.json to extract sha256 hash

9aafc3d

refactor(install): Use symlinks instead of copying binaries in macOS …

aaa2295

…install

Address comments

4254693

refactor(install): Add PATH check and skip setup in nested install

4589172

- Check if ~/.local/bin is on PATH after installation and warn users - Skip setup commands when Linux install.sh is called from main installer - Add Q_SKIP_SETUP environment variable to control setup execution

kkashilk force-pushed the install-script branch from 39f6c1a to 4589172 Compare October 24, 2025 18:28

kkashilk merged commit 340c07c into main Oct 24, 2025
19 of 27 checks passed

kkashilk deleted the install-script branch October 24, 2025 18:31


		hdiutil detach "$mount_path" -quiet

		mkdir -p "$HOME/.local/bin"


		cp -R "$app_bundle" "$MACOS_APP_DIR/"

		hdiutil detach "$mount_path" -quiet

feat(scripts): Add Q CLI installation script #823

feat(scripts): Add Q CLI installation script #823

Uh oh!

Conversation

kkashilk commented Oct 21, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

akhileshb Oct 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

akhileshb Oct 22, 2025 •

edited

Loading