Skip to content

Commit 9cd41a5

Browse files
Merge pull request #1772 from jasonrandrews/tool-installs
New install guide for Amazon Q CLI
2 parents 5496cd9 + daa043c commit 9cd41a5

File tree

3 files changed

+150
-0
lines changed

3 files changed

+150
-0
lines changed
460 KB
Loading
Lines changed: 146 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,146 @@
1+
---
2+
title: Amazon Q Developer CLI
3+
4+
draft: true
5+
6+
author: Jason Andrews
7+
minutes_to_complete: 10
8+
official_docs: https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/command-line.html
9+
10+
test_maintenance: true
11+
test_images:
12+
- ubuntu:latest
13+
14+
layout: installtoolsall
15+
multi_install: false
16+
multitool_install_part: false
17+
tool_install: true
18+
weight: 1
19+
---
20+
21+
Amazon Q Developer for the command line is a CLI tool for Amazon Q, a generative artificial intelligence (AI) powered assistant. You can use it to ask questions about AWS architecture and resources in addition to general developer tasks.
22+
23+
It is available for a variety of operating systems and Linux distributions, supports the Arm architecture, and has multiple ways to install it.
24+
25+
## What should I do before installing Amazon Q Developer CLI?
26+
27+
You need a Builder ID to use the Amazon Q Developer CLI. If you don't have one, visit [Do more with AWS Builder ID](https://community.aws/builderid) and use the Sign up button to create your Builder ID.
28+
29+
This guide explains how to install the latest version of the Amazon Q Developer CLI on computers running Arm Linux and macOS.
30+
31+
## How do I download and install Amazon Q Developer CLI?
32+
33+
The CLI is invoked with the `q` command, and you can install it on macOS and Arm Linux.
34+
35+
### How do I install the Q CLI on macOS?
36+
37+
Install [Homebrew](https://brew.sh/) if it is not already available on your computer.
38+
39+
Install the Q CLI:
40+
41+
```console
42+
brew install amazon-q
43+
```
44+
45+
### How do I install the Q CLI on Arm Linux?
46+
47+
The easiest way to install the latest version of the Q CLI for any Arm Linux distribution is to download and run the installer.
48+
49+
Before starting, make sure `curl` and `unzip` are available on your computer.
50+
51+
The commands for Debian-based distributions such as Ubuntu are below. For other Linux distributions use the package manager to install `curl` and `unzip`.
52+
53+
```bash { target="ubuntu:latest" }
54+
sudo apt update
55+
sudo apt install curl unzip -y
56+
```
57+
58+
Download the zip file with `curl`:
59+
60+
```bash { target="ubuntu:latest" }
61+
curl --proto '=https' --tlsv1.2 -sSf "https://desktop-release.codewhisperer.us-east-1.amazonaws.com/latest/q-aarch64-linux.zip" -o "q.zip"
62+
```
63+
64+
Extract the installer and run it:
65+
66+
```console
67+
unzip q.zip
68+
bash ./q/install.sh
69+
```
70+
71+
Answer the question about updating your shell config.
72+
73+
```output
74+
✔ Do you want q to modify your shell config (you will have to manually do this otherwise)?
75+
```
76+
77+
To automate the install add the `--no-confirm` flag to the `install.sh` command.
78+
79+
{{% notice Note %}}
80+
If you have a Linux distribution with an older version of the GNU C Library or one which does not use the GNU C Library such as Alpine Linux, you can download an alternative package which uses the musl C library and has no external dependencies.
81+
82+
Substitute the `curl` command above with this one and use the same install instructions:
83+
84+
```bash { target="ubuntu:latest" }
85+
curl "https://desktop-release.codewhisperer.us-east-1.amazonaws.com/latest/q-aarch64-linux-musl.zip" -o "q.zip"
86+
```
87+
88+
{{% /notice %}}
89+
90+
### How do I confirm the Q CLI is working?
91+
92+
You now have the latest version of the Amazon Q Developer CLI installed.
93+
94+
Confirm the CLI is available by invoking the `q` command to print the version.
95+
96+
```console
97+
q version
98+
```
99+
100+
The version is printed:
101+
102+
```output
103+
q 1.7.2
104+
```
105+
106+
## How can I configure my AWS account to get the most from the Q CLI?
107+
108+
The Q CLI can answer questions and solve problems related to your AWS resources and help you develop faster on AWS. To get the maximum benefit, you can configure the AWS CLI to use your account.
109+
110+
Follow the [AWS CLI install guide](/install-guides/aws_access_keys/) and the [AWS Credentials install guide](/install-guides/aws_access_keys/) to set up the AWS CLI and generate and configure access keys.
111+
112+
This allows you to use the Amazon Q Developer CLI to ask questions and solve issues specific to your AWS account.
113+
114+
## What is an example of using the Q CLI?
115+
116+
You can use `q chat` to find information about your AWS resources.
117+
118+
```console
119+
q chat
120+
```
121+
122+
When the chat session starts you see:
123+
124+
```output
125+
Hi, I'm Amazon Q. Ask me anything.
126+
127+
Things to try
128+
• Fix the build failures in this project.
129+
• List my s3 buckets in us-west-2.
130+
• Write unit tests for my application.
131+
• Help me understand my git status
132+
133+
/acceptall Toggles acceptance prompting for the session.
134+
/profile (Beta) Manage profiles for the chat session
135+
/context (Beta) Manage context files for a profile
136+
/help Show the help dialogue
137+
/quit Quit the application
138+
```
139+
140+
For example, you can ask for the IP address of an EC2 instance instead of going to the AWS console or looking up the AWS CLI command to get it.
141+
142+
An example is shown below:
143+
144+
![Connect #center](/install-guides/_images/q.gif)
145+
146+
You are ready to use the Q CLI.

data/stats_current_test_info.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,10 @@ sw_categories:
7171
aws-copilot:
7272
readable_title: AWS Copilot CLI
7373
tests_and_status: []
74+
aws-q-cli:
75+
readable_title: Amazon Q Developer CLI
76+
tests_and_status:
77+
- ubuntu:latest: passed
7478
azure-cli:
7579
readable_title: Azure CLI
7680
tests_and_status:

0 commit comments

Comments
 (0)