Skip to content

Commit 427ce27

Browse files
Merge pull request #1973 from jasonrandrews/tool-installs
update aws-q-cli.md to reflect Q CLI version 1.10.1 and enhance usage…
2 parents 3761993 + 8f5efca commit 427ce27

File tree

1 file changed

+144
-25
lines changed

1 file changed

+144
-25
lines changed

content/install-guides/aws-q-cli.md

Lines changed: 144 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ q version
100100
The version is printed:
101101

102102
```output
103-
q 1.7.2
103+
q 1.10.1
104104
```
105105

106106
## How can I configure my AWS account to get the most from the Q CLI?
@@ -122,19 +122,28 @@ q chat
122122
When the chat session starts you see:
123123

124124
```output
125-
Hi, I'm Amazon Q. Ask me anything.
125+
To learn more about MCP safety, see https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/command-line-mcp-security.html
126126
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
132127
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
128+
129+
⢠⣶⣶⣦⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢀⣤⣶⣿⣿⣿⣶⣦⡀⠀
130+
⠀⠀⠀⣾⡿⢻⣿⡆⠀⠀⠀⢀⣄⡄⢀⣠⣤⣤⡀⢀⣠⣤⣤⡀⠀⠀⢀⣠⣤⣤⣤⣄⠀⠀⢀⣤⣤⣤⣤⣤⣤⡀⠀⠀⣀⣤⣤⣤⣀⠀⠀⠀⢠⣤⡀⣀⣤⣤⣄⡀⠀⠀⠀⠀⠀⠀⢠⣿⣿⠋⠀⠀⠀⠙⣿⣿⡆
131+
⠀⠀⣼⣿⠇⠀⣿⣿⡄⠀⠀⢸⣿⣿⠛⠉⠻⣿⣿⠛⠉⠛⣿⣿⠀⠀⠘⠛⠉⠉⠻⣿⣧⠀⠈⠛⠛⠛⣻⣿⡿⠀⢀⣾⣿⠛⠉⠻⣿⣷⡀⠀⢸⣿⡟⠛⠉⢻⣿⣷⠀⠀⠀⠀⠀⠀⣼⣿⡏⠀⠀⠀⠀⠀⢸⣿⣿
132+
⠀⢰⣿⣿⣤⣤⣼⣿⣷⠀⠀⢸⣿⣿⠀⠀⠀⣿⣿⠀⠀⠀⣿⣿⠀⠀⢀⣴⣶⣶⣶⣿⣿⠀⠀⠀⣠⣾⡿⠋⠀⠀⢸⣿⣿⠀⠀⠀⣿⣿⡇⠀⢸⣿⡇⠀⠀⢸⣿⣿⠀⠀⠀⠀⠀⠀⢹⣿⣇⠀⠀⠀⠀⠀⢸⣿⡿
133+
⢀⣿⣿⠋⠉⠉⠉⢻⣿⣇⠀⢸⣿⣿⠀⠀⠀⣿⣿⠀⠀⠀⣿⣿⠀⠀⣿⣿⡀⠀⣠⣿⣿⠀⢀⣴⣿⣋⣀⣀⣀⡀⠘⣿⣿⣄⣀⣠⣿⣿⠃⠀⢸⣿⡇⠀⠀⢸⣿⣿⠀⠀⠀⠀⠀⠀⠈⢿⣿⣦⣀⣀⣀⣴⣿⡿⠃
134+
⠚⠛⠋⠀⠀⠀⠀⠘⠛⠛⠀⠘⠛⠛⠀⠀⠀⠛⠛⠀⠀⠀⠛⠛⠀⠀⠙⠻⠿⠟⠋⠛⠛⠀⠘⠛⠛⠛⠛⠛⠛⠃⠀⠈⠛⠿⠿⠿⠛⠁⠀⠀⠘⠛⠃⠀⠀⠘⠛⠛⠀⠀⠀⠀⠀⠀⠀⠀⠙⠛⠿⢿⣿⣿⣋⠀⠀
135+
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠈⠛⠿⢿⡧
136+
137+
╭─────────────────────────────── Did you know? ────────────────────────────────╮
138+
│ │
139+
│ You can resume the last conversation from your current directory by │
140+
│ launching with q chat --resume │
141+
│ │
142+
╰──────────────────────────────────────────────────────────────────────────────╯
143+
144+
/help all commands • ctrl + j new lines • ctrl + s fuzzy search
145+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
146+
>
138147
```
139148

140149
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.
@@ -158,12 +167,16 @@ Use the `/context` command to see the possible locations to store your context.
158167
The help information is printed.
159168

160169
```output
161-
current profile: default
162170
163-
global:
164-
.amazonq/rules/**/*.md
165-
README.md
166-
AmazonQ.md
171+
🌍 global:
172+
.amazonq/rules/**/*.md
173+
README.md
174+
AmazonQ.md
175+
176+
👤 profile (default):
177+
<none>
178+
179+
No files in the current directory matched the rules above.
167180
```
168181

169182
For example, you can create a new file to store your context.
@@ -182,15 +195,121 @@ did you read my context information?
182195
The response confirms the context file was read:
183196

184197
```output
185-
Yes, I've read your context information. I understand that you're an Arm Linux developer who prefers
186-
Ubuntu and other Debian-based distributions. You don't use x86 computers, so I should provide
187-
information assuming you're working on Arm Linux. You sometimes use macOS and Windows on Arm, but I
188-
should only provide information about those operating systems when you specifically ask for it.
198+
Yes, I've read your context information. I understand that you're an Arm Linux developer who primarily
199+
uses Ubuntu and other Debian-based distributions. You don't use x86 computers, so I'll provide all
200+
information assuming you're working on Arm Linux. You occasionally use macOS and Windows on Arm, but I'
201+
ll only provide information about those operating systems when you specifically ask for it.
189202
190-
I'll keep this context in mind when answering your questions, focusing on Arm Linux-specific
191-
information and Debian-based distributions by default.
203+
I'll tailor my responses to be relevant for Arm Linux development, particularly focusing on Debian-
204+
based distributions like Ubuntu, which is your preference.
192205
```
193206

194-
Give it a try by asking questions such as `how do I install the aws cli?` and check that the answers match the provided context.
207+
Give it a try by asking questions like "How do I install the AWS CLI?" and verify that the answers match the provided context.
208+
209+
## Install an MCP server
210+
211+
As an example of using MCP with Amazon Q, you can configure the Github MCP server.
212+
213+
Go to your GitHub account developer settings and create a personal access token with the following permissions:
214+
215+
- repo (Full control of private repositories)
216+
- read:org (Read organization membership)
217+
- read:user (Read user profile data)
218+
219+
220+
Use an editor to add the content below to the file `$HOME/.amazonq/mcp.json`
221+
222+
```console
223+
{
224+
"mcpServers": {
225+
"github": {
226+
"command": "docker",
227+
"args": [
228+
"run",
229+
"-i",
230+
"--rm",
231+
"-e",
232+
"GITHUB_PERSONAL_ACCESS_TOKEN",
233+
"ghcr.io/github/github-mcp-server"
234+
],
235+
"env": {
236+
"GITHUB_PERSONAL_ACCESS_TOKEN": "<your-github-pat>"
237+
}
238+
}
239+
}
240+
}
241+
```
242+
243+
Replace `<your-github-pat>` with your GitHub token.
244+
245+
You also need Docker running on the system. Refer to the [Docker install guide](/install-guides/docker/) for instructions.
246+
247+
Restart `q` with the new MCP configuration:
248+
249+
```console
250+
q chat
251+
```
252+
253+
You see the GitHub MCP server loaded and running:
254+
255+
```output
256+
✓ github loaded in 0.14 s
257+
✓ 1 of 1 mcp servers initialized.
258+
259+
⢠⣶⣶⣦⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢀⣤⣶⣿⣿⣿⣶⣦⡀⠀
260+
⠀⠀⠀⣾⡿⢻⣿⡆⠀⠀⠀⢀⣄⡄⢀⣠⣤⣤⡀⢀⣠⣤⣤⡀⠀⠀⢀⣠⣤⣤⣤⣄⠀⠀⢀⣤⣤⣤⣤⣤⣤⡀⠀⠀⣀⣤⣤⣤⣀⠀⠀⠀⢠⣤⡀⣀⣤⣤⣄⡀⠀⠀⠀⠀⠀⠀⢠⣿⣿⠋⠀⠀⠀⠙⣿⣿⡆
261+
⠀⠀⣼⣿⠇⠀⣿⣿⡄⠀⠀⢸⣿⣿⠛⠉⠻⣿⣿⠛⠉⠛⣿⣿⠀⠀⠘⠛⠉⠉⠻⣿⣧⠀⠈⠛⠛⠛⣻⣿⡿⠀⢀⣾⣿⠛⠉⠻⣿⣷⡀⠀⢸⣿⡟⠛⠉⢻⣿⣷⠀⠀⠀⠀⠀⠀⣼⣿⡏⠀⠀⠀⠀⠀⢸⣿⣿
262+
⠀⢰⣿⣿⣤⣤⣼⣿⣷⠀⠀⢸⣿⣿⠀⠀⠀⣿⣿⠀⠀⠀⣿⣿⠀⠀⢀⣴⣶⣶⣶⣿⣿⠀⠀⠀⣠⣾⡿⠋⠀⠀⢸⣿⣿⠀⠀⠀⣿⣿⡇⠀⢸⣿⡇⠀⠀⢸⣿⣿⠀⠀⠀⠀⠀⠀⢹⣿⣇⠀⠀⠀⠀⠀⢸⣿⡿
263+
⢀⣿⣿⠋⠉⠉⠉⢻⣿⣇⠀⢸⣿⣿⠀⠀⠀⣿⣿⠀⠀⠀⣿⣿⠀⠀⣿⣿⡀⠀⣠⣿⣿⠀⢀⣴⣿⣋⣀⣀⣀⡀⠘⣿⣿⣄⣀⣠⣿⣿⠃⠀⢸⣿⡇⠀⠀⢸⣿⣿⠀⠀⠀⠀⠀⠀⠈⢿⣿⣦⣀⣀⣀⣴⣿⡿⠃
264+
⠚⠛⠋⠀⠀⠀⠀⠘⠛⠛⠀⠘⠛⠛⠀⠀⠀⠛⠛⠀⠀⠀⠛⠛⠀⠀⠙⠻⠿⠟⠋⠛⠛⠀⠘⠛⠛⠛⠛⠛⠛⠃⠀⠈⠛⠿⠿⠿⠛⠁⠀⠀⠘⠛⠃⠀⠀⠘⠛⠛⠀⠀⠀⠀⠀⠀⠀⠀⠙⠛⠿⢿⣿⣿⣋⠀⠀
265+
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠈⠛⠿⢿⡧
266+
267+
╭─────────────────────────────── Did you know? ────────────────────────────────╮
268+
│ │
269+
│ You can execute bash commands by typing ! followed by the command │
270+
│ │
271+
╰──────────────────────────────────────────────────────────────────────────────╯
272+
273+
/help all commands • ctrl + j new lines • ctrl + s fuzzy search
274+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
275+
>
276+
```
195277

196-
You're ready to use the Q CLI.
278+
You can now use the GitHub MCP server to interact with GitHub repositories and do things like:
279+
280+
**Repository Management**
281+
- Create new repositories
282+
- Fork existing repositories
283+
- List branches and tags
284+
- Create new branches
285+
286+
**Code Management**
287+
- Get file contents from repositories
288+
- Create or update files
289+
- Delete files
290+
- Push multiple files in a single commit
291+
- Search code across repositories
292+
293+
**Pull Requests**
294+
- Create pull requests
295+
- List pull requests
296+
- Get pull request details
297+
- Update pull requests
298+
- Merge pull requests
299+
- Review pull requests
300+
- Request GitHub Copilot reviews
301+
- Get pull request files and comments
302+
303+
**Issues**
304+
- Create issues
305+
- List issues
306+
- Get issue details
307+
- Update issues
308+
- Add comments to issues
309+
- Search issues
310+
311+
**Commits**
312+
- List commits
313+
- Get commit details
314+
315+
You're ready to use the Q CLI.

0 commit comments

Comments
 (0)