Skip to content

Commit d7abeae

Browse files
Merge pull request #1802 from ArmDeveloperEcosystem/main
Production update
2 parents 2af8b7a + 1d8180e commit d7abeae

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+1598
-207
lines changed

.wordlist.txt

Lines changed: 43 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3916,4 +3916,46 @@ truncations
39163916
ulp
39173917
unmangled
39183918
unportable
3919-
zeropoint
3919+
zeropoint
3920+
AO
3921+
Autoware
3922+
CCC
3923+
ECUs
3924+
HTTPs
3925+
Hawksbill
3926+
HelloworldPublisher
3927+
HelloworldSubscriber
3928+
IMU
3929+
Jalisco
3930+
LiDAR
3931+
MLPerf’s
3932+
OTA
3933+
OpenAD
3934+
OpenADKit
3935+
ROS
3936+
RViz
3937+
Rviz
3938+
SDV
3939+
SDVs
3940+
SOAFEE
3941+
SSO
3942+
Unsloth’s
3943+
Veraison's
3944+
amazonq
3945+
autoware
3946+
autowarefoundation
3947+
casted
3948+
certifiability
3949+
codewhisperer
3950+
cyclonedds
3951+
distros
3952+
dlrm
3953+
musl
3954+
openadkit
3955+
printenv
3956+
qdeveloper
3957+
ros
3958+
rviz
3959+
testbed
3960+
ug
3961+
vnc

assets/contributors.csv

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,4 +82,5 @@ Odin Shen,Arm,odincodeshen,odin-shen-lmshen,,
8282
Avin Zarlez,Arm,AvinZarlez,avinzarlez,,https://www.avinzarlez.com/
8383
Shuheng Deng,Arm,,,,
8484
Yiyang Fan,Arm,,,,
85-
Geremy Cohen,Arm,geremyCohen,,,
85+
Julien Jayat,Arm,,,,
86+
Geremy Cohen,Arm,geremyCohen,geremyinanutshell,,

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

Lines changed: 68 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
---
22
title: Amazon Q Developer CLI
33

4-
draft: true
5-
64
author: Jason Andrews
75
minutes_to_complete: 10
86
official_docs: https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/command-line.html
@@ -18,37 +16,39 @@ tool_install: true
1816
weight: 1
1917
---
2018

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.
19+
Amazon Q Developer CLI is a command-line tool for Amazon Q, a generative AI-powered assistant. You can use it to ask questions about AWS architecture, resources, and general development tasks.
2220

23-
It is available for a variety of operating systems and Linux distributions, supports the Arm architecture, and has multiple ways to install it.
21+
It supports multiple operating systems, including Arm-based Linux distributions and macOS, supports the Arm architecture, and you can install it in several ways.
2422

2523
## What should I do before installing Amazon Q Developer CLI?
2624

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.
25+
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 click **Sign up with Builder ID** to create your AWS Builder ID.
2826

29-
This guide explains how to install the latest version of the Amazon Q Developer CLI on computers running Arm Linux and macOS.
27+
This guide explains how to install Amazon Q Developer CLI on macOS and Arm Linux.
3028

3129
## How do I download and install Amazon Q Developer CLI?
3230

33-
The CLI is invoked with the `q` command, and you can install it on macOS and Arm Linux.
31+
The CLI is invoked using the `q` command.
3432

35-
### How do I install the Q CLI on macOS?
33+
### How do I install Amazon Q Developer CLI on macOS?
3634

37-
Install [Homebrew](https://brew.sh/) if it is not already available on your computer.
35+
Install [Homebrew](https://brew.sh/) if it's not already available on your computer.
3836

39-
Install the Q CLI:
37+
Then install the Q CLI:
4038

4139
```console
4240
brew install amazon-q
4341
```
4442

4543
### How do I install the Q CLI on Arm Linux?
4644

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.
45+
The easiest way to install the Q CLI on any Arm Linux distribution is to download and run the installer.
4846

49-
Before starting, make sure `curl` and `unzip` are available on your computer.
47+
Before starting, ensure that `curl` and `unzip` are available on your computer.
5048

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`.
49+
{{% notice Note %}}
50+
For Debian-based distributions such as Ubuntu, use the commands below. For other Linux distributions, use the appropriate package manager to install `curl` and `unzip`.
51+
{{% /notice %}}
5252

5353
```bash { target="ubuntu:latest" }
5454
sudo apt update
@@ -68,16 +68,16 @@ unzip q.zip
6868
bash ./q/install.sh
6969
```
7070

71-
Answer the question about updating your shell config.
71+
You'll then be prompted about updating your shell config:
7272

7373
```output
7474
✔ Do you want q to modify your shell config (you will have to manually do this otherwise)?
7575
```
7676

77-
To automate the install add the `--no-confirm` flag to the `install.sh` command.
77+
To automate the install, add the `--no-confirm` flag to the `install.sh` command.
7878

7979
{{% 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.
80+
If you're using a Linux distribution with an older version of the GNU C Library - or one that does not use it at all, such as Alpine - you can download an alternative package built with the musl C library and has no external dependencies.
8181

8282
Substitute the `curl` command above with this one and use the same install instructions:
8383

@@ -107,7 +107,7 @@ q 1.7.2
107107

108108
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.
109109

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.
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.
111111

112112
This allows you to use the Amazon Q Developer CLI to ask questions and solve issues specific to your AWS account.
113113

@@ -143,4 +143,54 @@ An example is shown below:
143143

144144
![Connect #center](/install-guides/_images/q.gif)
145145

146-
You are ready to use the Q CLI.
146+
## How can I set the Q CLI context to tailor responses?
147+
148+
The Q CLI reads your context when you start it. If you provide more information about yourself, you will get tailored responses that match your development environment.
149+
150+
There are multiple options to store context.
151+
152+
Use the `/context` command to see the possible locations to store your context.
153+
154+
```console
155+
/context show
156+
```
157+
158+
The help information is printed.
159+
160+
```output
161+
current profile: default
162+
163+
global:
164+
.amazonq/rules/**/*.md
165+
README.md
166+
AmazonQ.md
167+
```
168+
169+
For example, you can create a new file to store your context.
170+
171+
```console
172+
mkdir -p ~/.amazonq/rules/context
173+
echo "I am an Arm Linux developer. I prefer Ubuntu and other Debian based distributions. I don't use any x86 computers so please provide all information assuming I'm working on Arm Linux. Sometimes I use macOS and Windows on Arm, but please only provide information about these operating systems when I ask for it." > ~/.amazonq/rules/context/context.md
174+
```
175+
176+
When you invoke `q chat` you can confirm your context information was read by asking.
177+
178+
```console
179+
did you read my context information?
180+
```
181+
182+
The response confirms the context file was read:
183+
184+
```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.
189+
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.
192+
```
193+
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.
195+
196+
You're ready to use the Q CLI.
Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
---
2+
title: Cyclone DDS
3+
author: Odin Shen
4+
minutes_to_complete: 20
5+
official_docs: https://cyclonedds.io/
6+
7+
additional_search_terms:
8+
- linux
9+
- automotive
10+
11+
test_images:
12+
- ubuntu:latest
13+
test_maintenance: true
14+
15+
layout: installtoolsall
16+
multi_install: false
17+
multitool_install_part: false
18+
tool_install: true
19+
weight: 1
20+
---
21+
22+
The [Eclipse Cyclone DDS](https://cyclonedds.io/) is an open-source implementation of the Data Distribution Service ([DDS](https://en.wikipedia.org/wiki/Data_Distribution_Service)) standard, designed for high-performance, real-time, and scalable communication in autonomous systems, robotics, industrial IoT, and aerospace applications.
23+
24+
It is part of the Eclipse Foundation and is widely used in Robotic Operating System (ROS) 2 as a key middleware framework for inter-process communication.
25+
26+
## Before you begin
27+
28+
This article provides a quick solution to install Cyclone DDS on Arm Linux.
29+
30+
Confirm you are using an Arm Linux machine by running:
31+
32+
```bash
33+
uname -m
34+
```
35+
36+
The output should be:
37+
38+
```output
39+
aarch64
40+
```
41+
42+
If you see a different result, you are not using an Arm computer running 64-bit Linux.
43+
44+
You need to install the following before building Cyclone DDS:
45+
46+
- C and C++ compilers (such as GCC).
47+
- Git.
48+
- CMake see [How do I install CMake?](/install-guides/cmake/)).
49+
- OpenSSL.
50+
51+
For Ubuntu Linux, run the commands below. For other Linux distributions, use the package manager to install the software listed above.
52+
53+
```bash
54+
sudo apt update
55+
sudo apt install -y gcc g++ git cmake libssl-dev
56+
```
57+
58+
## How do I build Cyclone DDS?
59+
60+
You can install Cyclone DDS by building the source code.
61+
62+
Clone the GitHub repository to create a build folder:
63+
64+
```bash
65+
cd $HOME
66+
git clone https://github.com/eclipse-cyclonedds/cyclonedds.git
67+
```
68+
69+
Once downloaded, you can build and install Cyclone DDS.
70+
71+
Enable the flags `BUILD_EXAMPLES` (to compile the example applications included) and `BUILD_TESTING` (to compile the test suite).
72+
73+
Here are the build and install commands:
74+
75+
```console
76+
cd cyclonedds
77+
mkdir build && cd build
78+
cmake -DBUILD_EXAMPLES=ON -DBUILD_TESTING=ON ..
79+
cmake --build .
80+
sudo cmake --build . --target install
81+
```
82+
83+
Cyclone DDS is now installed in `/usr/local`.
84+
85+
{{% notice Note %}}
86+
If you don't want to install Cyclone DDS in the default location of `/usr/local`, you can specify another location
87+
by adding `-DCMAKE_INSTALL_PREFIX=<install-prefix>` to the first `cmake` command with your alternative location.
88+
{{% /notice %}}
89+
90+
## How can I test Cyclone DDS?
91+
92+
To verify the installation, you can run the `Hello World` example from the build directory.
93+
94+
Open two terminals and navigate to the `bin/` directory in each.
95+
96+
Run the commands shown below in each tab in each of your two terminals:
97+
98+
{{< tabpane code=true >}}
99+
{{< tab header="Publisher" language="bash">}}
100+
cd $HOME/cyclonedds/build/bin/
101+
./HelloworldPublisher
102+
{{< /tab >}}
103+
{{< tab header="Subscriber" language="bash">}}
104+
cd $HOME/cyclonedds/build/bin/
105+
./HelloworldSubscriber
106+
{{< /tab >}}
107+
{{< /tabpane >}}
108+
109+
If you observe the following output from each of the terminals, Cyclone DDS is running correctly on your Arm Linux machine.
110+
111+
{{< tabpane code=true >}}
112+
{{< tab header="Publisher" language="log">}}
113+
=== [Publisher] Waiting for a reader to be discovered ...
114+
=== [Publisher] Writing : Message (1, Hello World)
115+
{{< /tab >}}
116+
{{< tab header="Subscriber" language="log">}}
117+
=== [Subscriber] Waiting for a sample ...
118+
=== [Subscriber] Received : Message (1, Hello World)
119+
{{< /tab >}}
120+
{{< /tabpane >}}
121+
122+
You are now ready to use Cyclone DDS.

0 commit comments

Comments
 (0)