You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/install-guides/kiro-cli.md
+41-35Lines changed: 41 additions & 35 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
---
2
2
title: Kiro CLI
3
-
description: Install Kiro CLI on macOS or Arm Linux and verify authentication so you can use AWS-focused AI assistance from the command line.
3
+
description: Install and verify the Kiro CLI on macOS or Arm Linux so you can access AWS-focused AI assistance from the command line.
4
4
5
5
author: Jason Andrews
6
6
minutes_to_complete: 10
@@ -21,40 +21,42 @@ Kiro CLI is a command-line tool powered by a generative AI assistant. You can us
21
21
22
22
It supports multiple operating systems, including Arm-based Linux distributions and macOS, and you can install it in several ways.
23
23
24
-
## What should I do before installing Kiro CLI?
24
+
## Before you begin
25
25
26
26
You need a Builder ID to use Kiro CLI. If you don't have one, visit [Do more with AWS Builder ID](https://community.aws/builderid) and select **Sign up with Builder ID** to create your AWS Builder ID.
27
27
28
-
This guide explains how to install Kiro CLI on macOS and Arm Linux.
28
+
You'll learn how to install Kiro CLI on macOS and Arm Linux.
29
29
30
-
## How do I download and install Kiro CLI?
30
+
## How to download and install Kiro CLI
31
31
32
-
The CLI is invoked using the `kiro-cli` command.
32
+
You can invoke the CLI using the `kiro-cli` command.
33
33
34
-
The easiest way to install Kiro CLI on Linux and macOS is with a single command:
34
+
Install Kiro CLI on Linux and macOS with a single command:
35
35
36
36
```console
37
37
curl -fsSL https://cli.kiro.dev/install | bash
38
38
```
39
39
40
-
### Can I use Homebrew to install Kiro CLI on macOS?
40
+
### Install Kiro CLI on macOS using Homebrew
41
41
42
-
Yes, you can install [Homebrew](https://brew.sh/) if it's not already available on your computer.
42
+
You can also use [Homebrew](https://brew.sh/) to install Kiro CLI.
43
+
44
+
Start by installing Homebrew if it's not already available on your computer.
43
45
44
46
Install Kiro CLI using Homebrew:
45
47
46
48
```console
47
49
brew install kiro-cli
48
50
```
49
51
50
-
### Can I install Kiro CLI on Arm Linux by downloading a ZIP file?
52
+
### Install Kiro CLI on Arm Linux by downloading a ZIP file
51
53
52
-
Yes, you can download and install Kiro CLI on any Arm Linux distribution using the installer.
54
+
You can download and install Kiro CLI on any Arm Linux distribution using the installer.
53
55
54
56
Before starting, ensure that `curl` and `unzip` are available on your computer.
55
57
56
58
{{% notice Note %}}
57
-
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`.
59
+
For Debian-based distributions such as Ubuntu, use the following commands. For other Linux distributions, use the appropriate package manager to install `curl` and `unzip`.
58
60
{{% /notice %}}
59
61
60
62
```bash { target="ubuntu:latest" }
@@ -75,7 +77,7 @@ unzip kirocli.zip
75
77
bash ./kirocli/install.sh
76
78
```
77
79
78
-
The installer prompts you about updating your shell configuration:
80
+
You'll be prompted by the installer about updating your shell configuration:
79
81
80
82
```output
81
83
✔ Do you want kiro to modify your shell config (you will have to manually do this otherwise)?
@@ -86,15 +88,15 @@ To automate the install, add the `--no-confirm` flag to the `install.sh` command
86
88
{{% notice Note %}}
87
89
If you're using a Linux distribution with an older version of the GNU C Library, or one that doesn't use it at all (such as Alpine), you can download an alternative package. This package is built with the musl C library and has no external dependencies.
88
90
89
-
Substitute the `curl` command above with this one and use the same install instructions:
91
+
Substitute the `curl` command with this one and use the same install instructions:
You now have the latest version of Kiro CLI installed.
100
102
@@ -104,25 +106,25 @@ Confirm the CLI is available by printing the version:
104
106
kiro-cli version
105
107
```
106
108
107
-
The output shows the version:
109
+
The output shows the version, and is similar to:
108
110
109
111
```output
110
112
kiro-cli 1.28.1
111
113
```
112
114
113
-
## How can I configure my AWS account to get the most from Kiro CLI?
115
+
## Configure your AWS account to get the most from Kiro CLI
114
116
115
117
Kiro 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.
116
118
117
-
Follow the [AWS CLI Install Guide](/install-guides/aws-cli/) and the [AWS Credentials Install Guide](/install-guides/aws_access_keys/) to set up the AWS CLI and generate and configure access keys.
119
+
To set up the AWS CLI and generate and configure access keys, follow the [AWS CLI Install Guide](/install-guides/aws-cli/) and the [AWS Credentials Install Guide](/install-guides/aws_access_keys/).
118
120
119
-
This allows you to use Kiro CLI to ask questions and solve issues specific to your AWS account.
121
+
By setting up credentials, you can use the Kiro CLI to ask questions and solve issues specific to your AWS account.
120
122
121
123
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.
122
124
123
-
Kiro accesses your AWS resources and prints the information you ask for.
125
+
Kiro accesses your AWS resources and returns the information you ask for.
124
126
125
-
## How can I set the Kiro CLI context to tailor responses?
127
+
## Set the Kiro CLI context to tailor responses
126
128
127
129
Kiro CLI can read your context. If you provide more information about yourself, you get tailored responses that match your development environment.
128
130
@@ -134,7 +136,7 @@ Use the `/context` command to see the possible locations to store your context.
134
136
/context show
135
137
```
136
138
137
-
The help information is printed.
139
+
The output is similar to:
138
140
139
141
```output
140
142
@@ -149,7 +151,7 @@ Session (temporary)
149
151
No files in the current directory matched the rules above.
150
152
```
151
153
152
-
For example, you can create a new file to store your context as shown below:
154
+
For example, you can create a new file to store your context as follows:
153
155
154
156
```console
155
157
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." > ~/.kiro/context.md
@@ -163,13 +165,13 @@ Load the context file:
163
165
/context add ~/.kiro/context.md
164
166
```
165
167
166
-
Confirm it was read:
168
+
Confirm the context file was read:
167
169
168
170
```console
169
171
did you read my context information?
170
172
```
171
173
172
-
The response confirms the context file was read:
174
+
The response confirms the context file was read, and is similar to:
173
175
174
176
```output
175
177
Yes, I read your context information. You're an Arm Linux developer who prefers Ubuntu and other Debian-based
@@ -179,7 +181,7 @@ information about those when you specifically ask for them.
179
181
180
182
Ask questions like "How do I install the AWS CLI?" to verify that the answers match the provided context.
181
183
182
-
## How do I change the model Kiro uses?
184
+
## Change the model Kiro uses
183
185
184
186
When you start `kiro-cli chat`, the model is printed:
185
187
@@ -193,7 +195,7 @@ Use the `/model` command to list other available models:
193
195
/model
194
196
```
195
197
196
-
The model options are displayed:
198
+
The output is similar to:
197
199
198
200
```output
199
201
Press (↑↓) to navigate · Enter(⏎) to select model
@@ -209,21 +211,21 @@ You can ask Kiro to set the default model for future sessions.
209
211
210
212
## Install a local MCP server
211
213
212
-
The Arm MCP Server is an MCP server providing AI assistants with tools and knowledge for Arm architecture development, migration, and optimization. This section shows how to configure the Arm MCP server locally using Docker.
214
+
The Arm MCP Server is an MCP server providing AI assistants with tools and knowledge for Arm architecture development, migration, and optimization. You can configure the Arm MCP server locally using Docker.
213
215
214
216
First, pull the MCP server image to your local machine:
215
217
216
218
```console
217
219
docker pull armlimited/arm-mcp:latest
218
220
```
219
221
220
-
You also need Docker running on the system. See the [Docker install guide](/install-guides/docker/) for instructions.
222
+
You also need Docker running on the system. For instructions, see the [Docker install guide](/install-guides/docker/).
221
223
222
-
### How do I configure the Arm MCP server?
224
+
### Configure the Arm MCP server for Kiro CLI
223
225
224
226
Modify the file `~/.kiro/settings/mcp.json` to add the Arm MCP server via a Docker container.
225
227
226
-
To analyze a local codebase, use a `-v` command to mount a volume to the Arm MCP server `/workspace` folder so it can access code you want to analyze with migrate-ease and other tools.
228
+
To analyze a local codebase, use a `-v` command to mount a volume to the Arm MCP server `/workspace` folder so it can access code you want to analyze with `migrate-ease` and other tools.
227
229
228
230
Replace the path `/path/to/your/workspace` with the path to your local codebase:
229
231
@@ -256,7 +258,7 @@ To enable Arm Performix features through the Arm MCP Server, replace `/path/to/y
256
258
257
259
### Optional: Use a Docker replacement containerization tool
258
260
259
-
You can use other containerization tools besides Docker that are free and do not require licenses, such as Podman, Finch, Colima, and Rancher Desktop. Choose one of the options below and use its CLI in place of `docker`.
261
+
You can use other containerization tools besides Docker that are free and don't require licenses, such as Podman, Finch, Colima, and Rancher Desktop. Choose one of the following options and use its CLI in place of `docker`.
260
262
261
263
{{< tabpane-normal >}}
262
264
{{< tab header="Podman" >}}
@@ -389,9 +391,9 @@ Add the following configuration to the user-level `~/.kiro/settings/mcp.json` fi
389
391
{{< /tab >}}
390
392
{{< /tabpane-normal >}}
391
393
392
-
### How do I verify the Arm MCP server is working?
394
+
### Verify that the Arm MCP server is working
393
395
394
-
Start Kiro CLI chat from your local shell and list the tools from the MCP server to verify it is working:
396
+
Start Kiro CLI chat from your local shell and list the tools from the MCP server to verify it's working:
395
397
396
398
```console
397
399
kiro-cli chat
@@ -403,9 +405,9 @@ Use the `/tools` command to list the available tools:
403
405
/tools
404
406
```
405
407
406
-
You should see the Arm MCP server tools listed in the output. If the arm-mcp server says it's still loading, wait a moment and run `/tools` again.
408
+
You'll see the Arm MCP server tools listed in the output. If the arm-mcp server says it's still loading, wait a moment and run `/tools` again.
407
409
408
-
### Use Arm prompt files with the MCP Server
410
+
### Use Arm prompt files with the Arm MCP Server
409
411
410
412
The Arm MCP Server provides a rich set of tools and knowledge base, but to make the best use of it, you should pair it with Arm-specific prompt files. These prompt files supply task-oriented context, best practices, and structured workflows that guide the agent in using MCP tools more effectively across common Arm development tasks.
411
413
@@ -419,4 +421,8 @@ Each prompt file is a Markdown configuration that you can reference in your Kiro
419
421
420
422
If you're facing issues or have questions, reach out to mcpserver@arm.com.
421
423
424
+
## Next steps
425
+
422
426
You're now ready to use Kiro CLI with the Arm MCP server for Arm-specific development assistance.
427
+
428
+
For an AI-assisted x86-to-Arm migration walkthrough, see [Automate x86-to-Arm application migration using the Arm MCP Server](/learning-paths/servers-and-cloud-computing/arm-mcp-server/).
0 commit comments