Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
55 commits
Select commit Hold shift + click to select a range
304bb41
index review
madeline-underwood May 12, 2025
d41cb52
updates
madeline-underwood May 12, 2025
6bfd298
Merge branch 'ArmDeveloperEcosystem:main' into LP_Azure_IoT
madeline-underwood May 13, 2025
cc2dd0c
updates
madeline-underwood May 13, 2025
16d8581
Merge branch 'LP_Azure_IoT' of https://github.com/madeline-underwood/…
madeline-underwood May 13, 2025
f28acab
v1, needs to be cleaned up
geremyCohen May 14, 2025
ea34ebd
debian tested e2e for install/uninstall
geremyCohen May 14, 2025
cf3dad8
ubuntu tested e2e for install/uninstall
geremyCohen May 14, 2025
a9143d7
centos tested e2e for install/uninstall
geremyCohen May 14, 2025
8ba1c4a
Merge branch 'ArmDeveloperEcosystem:main' into ig_for_ps
geremyCohen May 14, 2025
4e0310f
Merge branch 'ArmDeveloperEcosystem:main' into LP_Azure_IoT
madeline-underwood May 16, 2025
02bc9b3
Merge branch 'ArmDeveloperEcosystem:main' into LP_Azure_IoT
madeline-underwood May 19, 2025
108c4e3
index reviewed
madeline-underwood May 19, 2025
8644563
updates
madeline-underwood May 19, 2025
72818d2
Merge branch 'ArmDeveloperEcosystem:main' into ig_for_ps
geremyCohen May 19, 2025
0df2f01
Adding various OS pages. Added new overview and index.
geremyCohen May 19, 2025
66290fb
Final tweaks made. Will test and style next.
geremyCohen May 20, 2025
260795c
Merge branch 'ArmDeveloperEcosystem:main' into LP_Azure_IoT
madeline-underwood May 20, 2025
b200da1
Updates
madeline-underwood May 20, 2025
5dabcfb
Merge branch 'LP_Azure_IoT' of https://github.com/madeline-underwood/…
madeline-underwood May 20, 2025
09a83ca
Made page size overview more general.
geremyCohen May 20, 2025
b941b23
Removing install guide, added warning to LP
geremyCohen May 20, 2025
5e7d28b
Tech review of MCP server LP
pareenaverma May 20, 2025
e2ac7a4
Merge branch 'content_review' of https://github.com/pareenaverma/arm-…
pareenaverma May 20, 2025
f79d902
Final test of the instructions on each OS
geremyCohen May 20, 2025
8f5efca
update aws-q-cli.md to reflect Q CLI version 1.10.1 and enhance usage…
jasonrandrews May 20, 2025
17023f6
Update stats_current_test_info.yml
jasonrandrews May 20, 2025
3761993
Merge pull request #1971 from pareenaverma/content_review
pareenaverma May 20, 2025
427ce27
Merge pull request #1973 from jasonrandrews/tool-installs
jasonrandrews May 21, 2025
8ff1028
Merge pull request #1972 from geremyCohen/ig_for_ps
jasonrandrews May 21, 2025
31052d8
Set pagesize Learning Path to draft to start review.
jasonrandrews May 21, 2025
6fe1dac
Merge pull request #1975 from jasonrandrews/review
jasonrandrews May 21, 2025
46dca31
Review the 64k page size Learning Path
jasonrandrews May 21, 2025
4de094e
Merge pull request #1976 from jasonrandrews/review
jasonrandrews May 21, 2025
9afb867
Update _index.md
pareenaverma May 21, 2025
0bcf3b2
Update _index.md
pareenaverma May 21, 2025
8e00e28
Update _index.md
pareenaverma May 21, 2025
4500225
Merge pull request #1977 from pareenaverma/content_review
pareenaverma May 21, 2025
6e0e05e
New install guide no Finch
jasonrandrews May 21, 2025
01d7b5e
Updates
madeline-underwood May 22, 2025
b4784fb
updates
madeline-underwood May 22, 2025
42bdc2a
Merge pull request #1978 from jasonrandrews/review
jasonrandrews May 22, 2025
a83db17
Merge branch 'ArmDeveloperEcosystem:main' into LP_Azure_IoT
madeline-underwood May 22, 2025
13f92cd
update
madeline-underwood May 22, 2025
fb2df8d
Merge branch 'LP_Azure_IoT' of https://github.com/madeline-underwood/…
madeline-underwood May 22, 2025
3675b91
updates
madeline-underwood May 22, 2025
d763509
update
madeline-underwood May 22, 2025
41d82b4
Merge pull request #1979 from madeline-underwood/LP_Azure_IoT
jasonrandrews May 22, 2025
00cf61c
Merge pull request #1974 from ArmDeveloperEcosystem/update-stats-curr…
jasonrandrews May 22, 2025
a7217ca
review Azure IoT and update tags
jasonrandrews May 22, 2025
3317e8b
Merge pull request #1980 from jasonrandrews/review
jasonrandrews May 22, 2025
39829cb
spelling updates
jasonrandrews May 22, 2025
9105750
Merge pull request #1981 from jasonrandrews/spelling
jasonrandrews May 22, 2025
3802aad
updates
madeline-underwood May 22, 2025
159f1a9
Merge pull request #1982 from madeline-underwood/Finch
jasonrandrews May 22, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 65 additions & 1 deletion .wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4120,4 +4120,68 @@ pyproject
toml
virtualenv
mebibytes
syscalls
syscalls
ArchSpecificLibrary
Asahi
AsmSource
AutoEncoder
Avx
BuildCommand
BuildYourOwnKernel
CPPLibRecommend
CPPLibVersion
CPPStdCodes
CompilerSpecific
ConfigGuess
ConfigurationInfo
CrossCompile
DefineOtherArch
Denoises
DiT
Drozd
FlatBuffers
GolangInlineAsm
GolangIntrinsic
GolangLinkLibrary
HostCpuDetection
IncompatibleHeaderFile
InlineAsm
JavaJar
JavaPom
JavaSource
NoEquivalentInlineAsm
NoEquivalentIntrinsic
OldCrt
OpenAnolis
PreprocessorError
PythonInlineAsm
PythonIntrinsic
PythonLinkLibrary
PythonPackage
RustInlineAsm
RustIntrinsic
RustLinkLibrary
SentencePiece
SignedChar
Submodule
TUI
Wix’s
audiogen
bazelbuild
centos
cmdline
deadsnakes
flatbuffers
libmagic
litert
mv
ngrok’s
pagesize
runfinch
spiece
subcommand
subgenre
submodule
subword
techcrunch
transformative
169 changes: 144 additions & 25 deletions content/install-guides/aws-q-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ q version
The version is printed:

```output
q 1.7.2
q 1.10.1
```

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

```output
Hi, I'm Amazon Q. Ask me anything.
To learn more about MCP safety, see https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/command-line-mcp-security.html

Things to try
• Fix the build failures in this project.
• List my s3 buckets in us-west-2.
• Write unit tests for my application.
• Help me understand my git status

/acceptall Toggles acceptance prompting for the session.
/profile (Beta) Manage profiles for the chat session
/context (Beta) Manage context files for a profile
/help Show the help dialogue
/quit Quit the application

⢠⣶⣶⣦⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢀⣤⣶⣿⣿⣿⣶⣦⡀⠀
⠀⠀⠀⣾⡿⢻⣿⡆⠀⠀⠀⢀⣄⡄⢀⣠⣤⣤⡀⢀⣠⣤⣤⡀⠀⠀⢀⣠⣤⣤⣤⣄⠀⠀⢀⣤⣤⣤⣤⣤⣤⡀⠀⠀⣀⣤⣤⣤⣀⠀⠀⠀⢠⣤⡀⣀⣤⣤⣄⡀⠀⠀⠀⠀⠀⠀⢠⣿⣿⠋⠀⠀⠀⠙⣿⣿⡆
⠀⠀⣼⣿⠇⠀⣿⣿⡄⠀⠀⢸⣿⣿⠛⠉⠻⣿⣿⠛⠉⠛⣿⣿⠀⠀⠘⠛⠉⠉⠻⣿⣧⠀⠈⠛⠛⠛⣻⣿⡿⠀⢀⣾⣿⠛⠉⠻⣿⣷⡀⠀⢸⣿⡟⠛⠉⢻⣿⣷⠀⠀⠀⠀⠀⠀⣼⣿⡏⠀⠀⠀⠀⠀⢸⣿⣿
⠀⢰⣿⣿⣤⣤⣼⣿⣷⠀⠀⢸⣿⣿⠀⠀⠀⣿⣿⠀⠀⠀⣿⣿⠀⠀⢀⣴⣶⣶⣶⣿⣿⠀⠀⠀⣠⣾⡿⠋⠀⠀⢸⣿⣿⠀⠀⠀⣿⣿⡇⠀⢸⣿⡇⠀⠀⢸⣿⣿⠀⠀⠀⠀⠀⠀⢹⣿⣇⠀⠀⠀⠀⠀⢸⣿⡿
⢀⣿⣿⠋⠉⠉⠉⢻⣿⣇⠀⢸⣿⣿⠀⠀⠀⣿⣿⠀⠀⠀⣿⣿⠀⠀⣿⣿⡀⠀⣠⣿⣿⠀⢀⣴⣿⣋⣀⣀⣀⡀⠘⣿⣿⣄⣀⣠⣿⣿⠃⠀⢸⣿⡇⠀⠀⢸⣿⣿⠀⠀⠀⠀⠀⠀⠈⢿⣿⣦⣀⣀⣀⣴⣿⡿⠃
⠚⠛⠋⠀⠀⠀⠀⠘⠛⠛⠀⠘⠛⠛⠀⠀⠀⠛⠛⠀⠀⠀⠛⠛⠀⠀⠙⠻⠿⠟⠋⠛⠛⠀⠘⠛⠛⠛⠛⠛⠛⠃⠀⠈⠛⠿⠿⠿⠛⠁⠀⠀⠘⠛⠃⠀⠀⠘⠛⠛⠀⠀⠀⠀⠀⠀⠀⠀⠙⠛⠿⢿⣿⣿⣋⠀⠀
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠈⠛⠿⢿⡧

╭─────────────────────────────── Did you know? ────────────────────────────────╮
│ │
│ You can resume the last conversation from your current directory by │
│ launching with q chat --resume │
│ │
╰──────────────────────────────────────────────────────────────────────────────╯

/help all commands • ctrl + j new lines • ctrl + s fuzzy search
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
>
```

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

```output
current profile: default

global:
.amazonq/rules/**/*.md
README.md
AmazonQ.md
🌍 global:
.amazonq/rules/**/*.md
README.md
AmazonQ.md

👤 profile (default):
<none>

No files in the current directory matched the rules above.
```

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

```output
Yes, I've read your context information. I understand that you're an Arm Linux developer who prefers
Ubuntu and other Debian-based distributions. You don't use x86 computers, so I should provide
information assuming you're working on Arm Linux. You sometimes use macOS and Windows on Arm, but I
should only provide information about those operating systems when you specifically ask for it.
Yes, I've read your context information. I understand that you're an Arm Linux developer who primarily
uses Ubuntu and other Debian-based distributions. You don't use x86 computers, so I'll provide all
information assuming you're working on Arm Linux. You occasionally use macOS and Windows on Arm, but I'
ll only provide information about those operating systems when you specifically ask for it.

I'll keep this context in mind when answering your questions, focusing on Arm Linux-specific
information and Debian-based distributions by default.
I'll tailor my responses to be relevant for Arm Linux development, particularly focusing on Debian-
based distributions like Ubuntu, which is your preference.
```

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.
Give it a try by asking questions like "How do I install the AWS CLI?" and verify that the answers match the provided context.

## Install an MCP server

As an example of using MCP with Amazon Q, you can configure the Github MCP server.

Go to your GitHub account developer settings and create a personal access token with the following permissions:

- repo (Full control of private repositories)
- read:org (Read organization membership)
- read:user (Read user profile data)


Use an editor to add the content below to the file `$HOME/.amazonq/mcp.json`

```console
{
"mcpServers": {
"github": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"-e",
"GITHUB_PERSONAL_ACCESS_TOKEN",
"ghcr.io/github/github-mcp-server"
],
"env": {
"GITHUB_PERSONAL_ACCESS_TOKEN": "<your-github-pat>"
}
}
}
}
```

Replace `<your-github-pat>` with your GitHub token.

You also need Docker running on the system. Refer to the [Docker install guide](/install-guides/docker/) for instructions.

Restart `q` with the new MCP configuration:

```console
q chat
```

You see the GitHub MCP server loaded and running:

```output
✓ github loaded in 0.14 s
✓ 1 of 1 mcp servers initialized.

⢠⣶⣶⣦⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢀⣤⣶⣿⣿⣿⣶⣦⡀⠀
⠀⠀⠀⣾⡿⢻⣿⡆⠀⠀⠀⢀⣄⡄⢀⣠⣤⣤⡀⢀⣠⣤⣤⡀⠀⠀⢀⣠⣤⣤⣤⣄⠀⠀⢀⣤⣤⣤⣤⣤⣤⡀⠀⠀⣀⣤⣤⣤⣀⠀⠀⠀⢠⣤⡀⣀⣤⣤⣄⡀⠀⠀⠀⠀⠀⠀⢠⣿⣿⠋⠀⠀⠀⠙⣿⣿⡆
⠀⠀⣼⣿⠇⠀⣿⣿⡄⠀⠀⢸⣿⣿⠛⠉⠻⣿⣿⠛⠉⠛⣿⣿⠀⠀⠘⠛⠉⠉⠻⣿⣧⠀⠈⠛⠛⠛⣻⣿⡿⠀⢀⣾⣿⠛⠉⠻⣿⣷⡀⠀⢸⣿⡟⠛⠉⢻⣿⣷⠀⠀⠀⠀⠀⠀⣼⣿⡏⠀⠀⠀⠀⠀⢸⣿⣿
⠀⢰⣿⣿⣤⣤⣼⣿⣷⠀⠀⢸⣿⣿⠀⠀⠀⣿⣿⠀⠀⠀⣿⣿⠀⠀⢀⣴⣶⣶⣶⣿⣿⠀⠀⠀⣠⣾⡿⠋⠀⠀⢸⣿⣿⠀⠀⠀⣿⣿⡇⠀⢸⣿⡇⠀⠀⢸⣿⣿⠀⠀⠀⠀⠀⠀⢹⣿⣇⠀⠀⠀⠀⠀⢸⣿⡿
⢀⣿⣿⠋⠉⠉⠉⢻⣿⣇⠀⢸⣿⣿⠀⠀⠀⣿⣿⠀⠀⠀⣿⣿⠀⠀⣿⣿⡀⠀⣠⣿⣿⠀⢀⣴⣿⣋⣀⣀⣀⡀⠘⣿⣿⣄⣀⣠⣿⣿⠃⠀⢸⣿⡇⠀⠀⢸⣿⣿⠀⠀⠀⠀⠀⠀⠈⢿⣿⣦⣀⣀⣀⣴⣿⡿⠃
⠚⠛⠋⠀⠀⠀⠀⠘⠛⠛⠀⠘⠛⠛⠀⠀⠀⠛⠛⠀⠀⠀⠛⠛⠀⠀⠙⠻⠿⠟⠋⠛⠛⠀⠘⠛⠛⠛⠛⠛⠛⠃⠀⠈⠛⠿⠿⠿⠛⠁⠀⠀⠘⠛⠃⠀⠀⠘⠛⠛⠀⠀⠀⠀⠀⠀⠀⠀⠙⠛⠿⢿⣿⣿⣋⠀⠀
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠈⠛⠿⢿⡧

╭─────────────────────────────── Did you know? ────────────────────────────────╮
│ │
│ You can execute bash commands by typing ! followed by the command │
│ │
╰──────────────────────────────────────────────────────────────────────────────╯

/help all commands • ctrl + j new lines • ctrl + s fuzzy search
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
>
```

You're ready to use the Q CLI.
You can now use the GitHub MCP server to interact with GitHub repositories and do things like:

**Repository Management**
- Create new repositories
- Fork existing repositories
- List branches and tags
- Create new branches

**Code Management**
- Get file contents from repositories
- Create or update files
- Delete files
- Push multiple files in a single commit
- Search code across repositories

**Pull Requests**
- Create pull requests
- List pull requests
- Get pull request details
- Update pull requests
- Merge pull requests
- Review pull requests
- Request GitHub Copilot reviews
- Get pull request files and comments

**Issues**
- Create issues
- List issues
- Get issue details
- Update issues
- Add comments to issues
- Search issues

**Commits**
- List commits
- Get commit details

You're ready to use the Q CLI.
Loading
Loading