Prettify README + setup script (#976)

Author: GoodluckH

.github/media/amazon-q-cli-features.jpeg

@@ -1,49 +1,66 @@
-# Amazon Q Developer for command line Monorepo
 
-The **`amazon-q-developer-cli`** monorepo houses most of the core code for the Amazon Q Developer desktop
-app and CLI.
-
-## Installation
-
-To install Amazon Q Developer for command line see the AWS public documentation [here](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/command-line-installing.html).
-
-## Overview
-
-Several projects live here:
-
-- [`autocomplete`](packages/autocomplete/) - The autocomplete react app
-- [`dashboard`](packages/dashboard/) - The dashboard react app
-- [`figterm`](crates/figterm/) - figterm, our headless terminal/pseudoterminal that
-  intercepts the user’s terminal edit buffer.
-- [`q_cli`](crates/q_cli/) - the `q` CLI, allows users to interface with Amazon Q Developer from
-  the command line
-- [`fig_desktop`](crates/fig_desktop/) - the Rust desktop app, uses
-  [`tao`](https://docs.rs/tao/latest/tao/)/[`wry`](https://docs.rs/wry/latest/wry/)
-  for windowing/webviews
-- [`fig_input_method`](crates/fig_input_method/) - The input method used to get cursor
-  position on macOS
-- [`vscode`](extensions/vscode/) - Contains the VSCode plugin needed
-  for the Amazon Q Developer for command line to work in VSCode
-- [`jetbrains`](extensions/jetbrains/) - Contains the VSCode plugin
-  needed for the Amazon Q Developer for command line to work in Jetbrains IDEs
-
-Other folder to be aware of
-
-- [`build-scripts/`](build-scripts/) - Contains all python scripts to build,
-  sign, and test the project on macOS and Linux
-- [`crates/`](crates/) - Contains all internal rust crates
-- [`packages/`](packages/) - Contains all internal npm packages
-- [`proto/`](proto/) -
-  [protocol buffer](https://developers.google.com/protocol-buffers/) message
-  specification for inter-process communication
-- [`tests/`](tests/) - Contain integration tests for the projects
-
-Below is a high level architecture of how the different components of the app and
-their IPC:
-
-![architecture](docs/assets/architecture.svg)
-
-## Setup
+<p align="center">
+  <a href="https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/command-line-installing.html">
+    <picture>
+      <img src="./.github/media/amazon-q-logo.avif" alt="Amazon Q"
+        width="200px"
+      >
+    </picture>
+  </a>
+</p>
+
+<h4 align="center">
+  Amazon Q CLI brings IDE-style autocomplete and agentic capabilities to your terminal.
+</h4>
+
+
+<div align="center">
+  <a href="https://github.com/aws/amazon-q-developer-cli/graphs/commit-activity"><img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/m/aws/amazon-q-developer-cli"/></a>
+  <a href="https://github.com/aws/amazon-q-developer-cli/issues"><img alt="GitHub open issues" src="https://img.shields.io/github/issues/aws/amazon-q-developer-cli"/></a>
+</div>
+
+
+<div align="center">
+
+[![Rust Test](https://github.com/aws/amazon-q-developer-cli/actions/workflows/rust.yml/badge.svg)](https://github.com/aws/amazon-q-developer-cli/actions/workflows/rust.yml)
+[![Typos Test](https://github.com/aws/amazon-q-developer-cli/actions/workflows/typos.yml/badge.svg)](https://github.com/aws/amazon-q-developer-cli/actions/workflows/typos.yml)
+[![Typescript Test](https://github.com/aws/amazon-q-developer-cli/actions/workflows/typescript.yml/badge.svg)](https://github.com/aws/amazon-q-developer-cli/actions/workflows/typescript.yml)
+</div>
+
+<p align="center">
+  <a href="https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/command-line-installing.html">
+    <picture>
+      <img src="./.github/media/amazon-q-cli-features.jpeg" alt="Amazon Q CLI Features"
+      >
+    </picture>
+  </a>
+</p>
+
+## 😍 Features
+-   🔮 [**Auto Completion**](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/command-line-autocomplete.html): IDE-style completions to hundreds of popular CLIs like `git`, `npm`, `docker`, and `aws`.
+-   💬 [**Natural Language Chat**](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/command-line-chat.html): Interact with your terminal using natural language to ask questions, debug issues, or explore the codebase.
+-   🧠 [**Contextual Awareness**](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/command-line-chat.html#command-line-chat-context-integration): Integrates context from your local development environment, so answers are tailored to your specific code and setup.
+-   🤖 [**Agentic Execution**](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/command-line-autocomplete.html): Let Amazon Q take action: generate code, edit files, automate Git workflows, resolve merge conflicts, and more — with your permission.
+
+## ⚡️ Installation
+
+- **macOS**:
+  - **DMG**: Download from AWS:
+    [aws.amazon.com](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/command-line-getting-started-installing.html)
+  - **Homebrew**: `brew install amazon-q`
+- **Linux**:
+  - [Ubuntu/Debian](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/command-line-installing.html#command-line-installing-ubuntu)
+  - [AppImage](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/command-line-installing.html#command-line-installing-appimage)
+  - [Alternative Linux builds](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/command-line-installing.html#command-line-installing-alternative-linux)
+- **Windows**:
+  - Follow the discussions for
+    [Windows](https://github.com/aws/q-command-line-discussions/discussions/15)
+  - Or [use it on Window with WSL](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/command-line-installing.html#command-line-installing-windows)
+- **Remote machines**
+  - [Autocomplete in SSH](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/command-line-autocomplete-ssh.html)
+
+
+## 🚀 Start Contributing
 
 ### Prerequisites
 
@@ -57,39 +74,26 @@ their IPC:
 git clone https://github.com/aws/amazon-q-for-command-line.git
 ```
 
-### 2. Install platform dependencies
-
-This is all the dep
-
-For Debian/Ubuntu:
-
+### 2. Setup
+Hassle-free setup:
 ```shell
-sudo apt update
-sudo apt install build-essential pkg-config jq dpkg curl wget cmake clang libssl-dev libgtk-3-dev libayatana-appindicator3-dev librsvg2-dev libdbus-1-dev libwebkit2gtk-4.1-dev libjavascriptcoregtk-4.1-dev valac libibus-1.0-dev libglib2.0-dev sqlite3 libxdo-dev protobuf-compiler
+npm run setup
 ```
 
-For Arch:
-
-```shell
-sudo pacman -Syu
-sudo pacman -S --needed webkit2gtk base-devel curl wget openssl appmenu-gtk-module gtk3 libappindicator-gtk3 librsvg libvips cmake jq pkgconf
-```
+Or if you'd like to DIY:
 
-For Fedora:
+<details>
+<summary>Manual Setup</summary>
+<div>
 
-```shell
-sudo dnf check-update
-sudo dnf install webkit2gtk3-devel.x86_64 openssl-devel curl wget libappindicator-gtk3 librsvg2-devel jq
-sudo dnf group install "C Development Tools and Libraries"
-```
+### 1. Install platform dependencies
 
-For MacOS:
+For Debian/Ubuntu:
 
 ```shell
-xcode-select --install
-brew install mise pnpm protobuf zsh bash fish shellcheck jq
+sudo apt update
+sudo apt install build-essential pkg-config jq dpkg curl wget cmake clang libssl-dev libgtk-3-dev libayatana-appindicator3-dev librsvg2-dev libdbus-1-dev libwebkit2gtk-4.1-dev libjavascriptcoregtk-4.1-dev valac libibus-1.0-dev libglib2.0-dev sqlite3 libxdo-dev protobuf-compiler
 ```
-
 ### 2. Install Rust toolchain using [Rustup](https://rustup.rs):
 
 ```shell
@@ -145,7 +149,13 @@ Run `pnpm` in root directory to add pre-commit hooks:
 pnpm install --ignore-scripts
 ```
 
-## 💡 Quick Tip for Onboarding
+</div>
+</details>
+
+
+
+
+### 💡 Quick Tip for Onboarding
 
 Use Q CLI to help you onboard Q CLI! 
 
@@ -172,11 +182,52 @@ This enables Q to answer onboarding questions like:
 Great for speeding up your ramp-up and navigating the repo more effectively.
 
 
-## Security
+
+
+## 🏗️ Project Layout
+
+Several projects live here:
+
+- [`autocomplete`](packages/autocomplete/) - The autocomplete react app
+- [`dashboard`](packages/dashboard/) - The dashboard react app
+- [`figterm`](crates/figterm/) - figterm, our headless terminal/pseudoterminal that
+  intercepts the user’s terminal edit buffer.
+- [`q_cli`](crates/q_cli/) - the `q` CLI, allows users to interface with Amazon Q Developer from
+  the command line
+- [`fig_desktop`](crates/fig_desktop/) - the Rust desktop app, uses
+  [`tao`](https://docs.rs/tao/latest/tao/)/[`wry`](https://docs.rs/wry/latest/wry/)
+  for windowing/webviews
+- [`fig_input_method`](crates/fig_input_method/) - The input method used to get cursor
+  position on macOS
+- [`vscode`](extensions/vscode/) - Contains the VSCode plugin needed
+  for the Amazon Q Developer for command line to work in VSCode
+- [`jetbrains`](extensions/jetbrains/) - Contains the VSCode plugin
+  needed for the Amazon Q Developer for command line to work in Jetbrains IDEs
+
+Other folder to be aware of
+
+- [`build-scripts/`](build-scripts/) - Contains all python scripts to build,
+  sign, and test the project on macOS and Linux
+- [`crates/`](crates/) - Contains all internal rust crates
+- [`packages/`](packages/) - Contains all internal npm packages
+- [`proto/`](proto/) -
+  [protocol buffer](https://developers.google.com/protocol-buffers/) message
+  specification for inter-process communication
+- [`tests/`](tests/) - Contain integration tests for the projects
+
+Below is a high level architecture of how the different components of the app and
+their IPC:
+
+![architecture](docs/assets/architecture.svg)
+
+
+
+
+## 🛡️ Security
 
 See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.
 
-## Licensing
+## 📜 Licensing
 
 This repo is dual licensed under MIT and Apache 2.0 licenses.
 

.github/media/amazon-q-logo.avif

@@ -25,7 +25,8 @@
     "preview:dashboard": "pnpm -C packages/dashboard preview",
     "clean": "turbo clean --parallel",
     "prepare": "husky",
-    "precommit": "lint-staged --config .lintstagedrc.mjs"
+    "precommit": "lint-staged --config .lintstagedrc.mjs",
+    "setup": "bash scripts/setup.sh"
   },
   "devDependencies": {
     "@vitest/coverage-v8": "^3.0.8",

README.md

@@ -0,0 +1,112 @@
+#!/usr/bin/env bash
+
+set -e
+
+OS="$(uname -s)"
+
+install_linux_deps() {
+  if [ -f /etc/debian_version ]; then
+    echo "Detected Debian/Ubuntu"
+    sudo apt update
+    sudo apt install build-essential pkg-config jq dpkg curl wget cmake clang libssl-dev libgtk-3-dev libayatana-appindicator3-dev librsvg2-dev libdbus-1-dev libwebkit2gtk-4.1-dev libjavascriptcoregtk-4.1-dev valac libibus-1.0-dev libglib2.0-dev sqlite3 libxdo-dev protobuf-compiler
+  elif [ -f /etc/arch-release ]; then
+    echo "Detected Arch"
+    sudo pacman -Syu --noconfirm
+    sudo pacman -S --noconfirm --needed webkit2gtk base-devel curl wget openssl appmenu-gtk-module gtk3 libappindicator-gtk3 librsvg libvips cmake jq pkgconf
+  elif [ -f /etc/fedora-release ]; then
+    echo "Detected Fedora"
+    sudo dnf check-update
+    sudo dnf install -y webkit2gtk3-devel.x86_64 openssl-devel curl wget libappindicator-gtk3 librsvg2-devel jq
+    sudo dnf group install -y "C Development Tools and Libraries"
+  else
+    echo "Unsupported Linux distribution. Check the docs for manual installation instructions."
+    exit 1
+  fi
+}
+
+install_macos_deps() {
+  echo "Detected macOS"
+  xcode-select --install || true
+  brew install mise pnpm protobuf zsh bash fish shellcheck jq
+}
+
+install_rust() {
+  echo "Installing Rust toolchain..."
+  curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
+    # Detect shell and source the correct env file
+
+  SHELL_NAME=$(basename "$SHELL")
+  case "$SHELL_NAME" in
+    fish)
+      source "$HOME/.cargo/env.fish"
+      ;;
+    nu)
+      source "$HOME/.cargo/env.nu"
+      ;;
+    *)
+      . "$HOME/.cargo/env"
+      ;;
+  esac
+
+  rustup default stable
+  rustup toolchain install nightly
+  cargo install typos-cli
+
+  if [[ "$OS" == "Darwin" ]]; then
+    rustup target add x86_64-apple-darwin
+    rustup target add aarch64-apple-darwin
+  fi
+}
+add_mise_to_shell() {
+  echo "Adding mise integration to shell..."
+
+  SHELL_NAME=$(basename "$SHELL")
+
+  case "$SHELL_NAME" in
+    zsh)
+      ZSHRC="${ZDOTDIR:-$HOME}/.zshrc"
+      grep -qxF 'eval "$(mise activate zsh)"' "$ZSHRC" || echo 'eval "$(mise activate zsh)"' >> "$ZSHRC"
+      ;;
+    bash)
+      BASHRC="$HOME/.bashrc"
+      grep -qxF 'eval "$(mise activate bash)"' "$BASHRC" || echo 'eval "$(mise activate bash)"' >> "$BASHRC"
+      ;;
+    fish)
+      FISH_CONFIG="$HOME/.config/fish/config.fish"
+      mkdir -p "$(dirname "$FISH_CONFIG")"
+      grep -qxF 'mise activate fish | source' "$FISH_CONFIG" || echo 'mise activate fish | source' >> "$FISH_CONFIG"
+      ;;
+    *)
+      echo "⚠️  Unknown shell '$SHELL_NAME'. Please add mise manually to your shell config."
+      ;;
+  esac
+}
+
+setup_mise() {
+  echo "Installing Python and Node with mise..."
+  add_mise_to_shell
+  mise trust
+  mise install
+}
+
+setup_precommit() {
+  echo "Installing pre-commit hooks..."
+  pnpm install --ignore-scripts
+}
+
+echo "Setting up project dependencies..."
+
+if [[ "$OS" == "Linux" ]]; then
+  install_linux_deps
+elif [[ "$OS" == "Darwin" ]]; then
+  install_macos_deps
+else
+  echo "Unsupported OS: $OS"
+  exit 1
+fi
+
+install_rust
+setup_mise
+setup_precommit
+
+echo "✅ Setup complete! Follow the instructions in the README to get started."