Skip to content
This repository was archived by the owner on May 15, 2025. It is now read-only.

Commit f47c160

Browse files
DevelopmentCatsDevelopmentCats
committed
docs(amazon-q): update README with image and variable formatting
- Added a screenshot of Amazon Q in action to enhance visual understanding. - Removed unverified instructions regarding `zstd` installation for macOS. - Add variables for System and Task Prompts
1 parent 87c34b7 commit f47c160

File tree

1 file changed

+19
-22
lines changed

1 file changed

+19
-22
lines changed

‎amazon-q/README.md

Lines changed: 19 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ module "amazon-q" {
2121
}
2222
```
2323

24+
![Amazon-Q in action](../.images/amazonq.png)
25+
2426
## Prerequisites
2527

2628
- You must generate an authenticated Amazon Q tarball on another machine:
@@ -44,16 +46,11 @@ module "amazon-q" {
4446

4547
**3. Generate the tarball:**
4648

47-
- Run the following command in your terminal (Linux/macOS):
49+
- Run the following command in your terminal:
4850
```sh
4951
cd ~/.local/share/amazon-q
5052
tar -c . | zstd | base64 -w 0
5153
```
52-
- If you are on macOS and do not have `zstd`, you can install it with Homebrew:
53-
```sh
54-
brew install zstd
55-
```
56-
- If your version of `base64` does not support `-w 0`, use `| base64` instead (the output will just be wrapped).
5754

5855
**4. Copy the output:**
5956

@@ -119,25 +116,25 @@ module "amazon-q" {
119116

120117
## Variables
121118

122-
| Name | Required | Default | Description |
123-
| -------------------------------- | -------- | -------------------- | ----------------------------------------------------------------------------------------- |
124-
| `agent_id` | Yes | — | The ID of a Coder agent. |
125-
| `experiment_auth_tarball` | Yes | — | Base64-encoded, zstd-compressed tarball of a pre-authenticated Amazon Q config directory. |
126-
| `install_amazon_q` | No | `true` | Whether to install Amazon Q. |
127-
| `amazon_q_version` | No | `latest` | Version to install. |
128-
| `experiment_use_screen` | No | `false` | Use GNU screen for background operation. |
129-
| `experiment_use_tmux` | No | `false` | Use tmux for background operation. |
130-
| `experiment_report_tasks` | No | `false` | Enable task reporting to Coder. |
131-
| `experiment_pre_install_script` | No | `null` | Custom script to run before install. |
132-
| `experiment_post_install_script` | No | `null` | Custom script to run after install. |
133-
| `icon` | No | `/icon/amazon-q.svg` | The icon to use for the app. |
134-
| `folder` | No | `/home/coder` | The folder to run Amazon Q in. |
135-
| `order` | No | `null` | The order determines the position of app in the UI presentation. |
119+
| Name | Required | Default | Description |
120+
| -------------------------------- | -------- | ------------------------ | ----------------------------------------------------------------------------------------------- |
121+
| `agent_id` | Yes | — | The ID of a Coder agent. |
122+
| `experiment_auth_tarball` | Yes | — | Base64-encoded, zstd-compressed tarball of a pre-authenticated Amazon Q config directory. |
123+
| `install_amazon_q` | No | `true` | Whether to install Amazon Q. |
124+
| `amazon_q_version` | No | `latest` | Version to install. |
125+
| `experiment_use_screen` | No | `false` | Use GNU screen for background operation. |
126+
| `experiment_use_tmux` | No | `false` | Use tmux for background operation. |
127+
| `experiment_report_tasks` | No | `false` | Enable task reporting to Coder. |
128+
| `experiment_pre_install_script` | No | `null` | Custom script to run before install. |
129+
| `experiment_post_install_script` | No | `null` | Custom script to run after install. |
130+
| `icon` | No | `/icon/amazon-q.svg` | The icon to use for the app. |
131+
| `folder` | No | `/home/coder` | The folder to run Amazon Q in. |
132+
| `order` | No | `null` | The order determines the position of app in the UI presentation. |
133+
| `system_prompt` | No | See [main.tf](./main.tf) | The system prompt to use for Amazon Q. This should instruct the agent how to do task reporting. |
134+
| `task_prompt` | No | See [main.tf](./main.tf) | The initial task prompt to send to Amazon Q. |
136135

137136
## Notes
138137

139138
- Only one of `experiment_use_screen` or `experiment_use_tmux` can be true at a time.
140139
- If neither is set, Amazon Q runs in the foreground.
141140
- For more details, see the [main.tf](./main.tf) source.
142-
143-
<!-- TODO: Add Screenshot of Amazon-Q In Action -->

0 commit comments

Comments
 (0)