Skip to content

Commit b0f291d

Browse files
Merge pull request #3454 from anupras-mohapatra-arm/install-guides
Kiro CLI install guide updates
2 parents c0e1103 + 07caa88 commit b0f291d

1 file changed

Lines changed: 48 additions & 46 deletions

File tree

content/install-guides/kiro-cli.md

Lines changed: 48 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
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.
44

55
author: Jason Andrews
66
minutes_to_complete: 10
@@ -19,42 +19,44 @@ weight: 1
1919

2020
Kiro CLI is a command-line tool powered by a generative AI assistant. You can use it to ask questions about AWS architecture, resources, and general development tasks.
2121

22-
It supports multiple operating systems, including Arm-based Linux distributions and macOS, and you can install it in several ways.
22+
You can install Kiro CLI in several ways on multiple operating systems, including Arm-based Linux distributions and macOS.
2323

24-
## What should I do before installing Kiro CLI?
24+
## Before you begin
2525

2626
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.
2727

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

30-
## How do I download and install Kiro CLI?
30+
## How to download and install Kiro CLI
3131

32-
The CLI is invoked using the `kiro-cli` command.
32+
You can invoke the CLI using the `kiro-cli` command.
3333

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:
3535

3636
```console
3737
curl -fsSL https://cli.kiro.dev/install | bash
3838
```
3939

40-
### Can I use Homebrew to install Kiro CLI on macOS?
40+
### Install Kiro CLI on macOS using Homebrew
4141

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

4446
Install Kiro CLI using Homebrew:
4547

4648
```console
4749
brew install kiro-cli
4850
```
4951

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
5153

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

5456
Before starting, ensure that `curl` and `unzip` are available on your computer.
5557

5658
{{% 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`.
5860
{{% /notice %}}
5961

6062
```bash { target="ubuntu:latest" }
@@ -75,7 +77,7 @@ unzip kirocli.zip
7577
bash ./kirocli/install.sh
7678
```
7779

78-
The installer prompts you about updating your shell configuration:
80+
You'll be prompted by the installer about updating your shell configuration:
7981

8082
```output
8183
✔ 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
8688
{{% notice Note %}}
8789
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.
8890

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:
9092

9193
```bash { target="ubuntu:latest" }
9294
curl --proto '=https' --tlsv1.2 -sSf 'https://desktop-release.q.us-east-1.amazonaws.com/latest/kirocli-aarch64-linux-musl.zip' -o 'kirocli.zip'
9395
```
9496

9597
{{% /notice %}}
9698

97-
### How do I confirm Kiro CLI is working?
99+
## Confirm Kiro CLI is working
98100

99101
You now have the latest version of Kiro CLI installed.
100102

@@ -104,25 +106,21 @@ Confirm the CLI is available by printing the version:
104106
kiro-cli version
105107
```
106108

107-
The output shows the version:
109+
The output shows the version, and is similar to:
108110

109111
```output
110112
kiro-cli 1.28.1
111113
```
112114

113-
## How can I configure my AWS account to get the most from Kiro CLI?
114-
115-
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.
115+
## Configure your AWS account to get the most from Kiro CLI
116116

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.
117+
Kiro CLI can answer questions and solve problems related to your AWS resources. 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. Kiro CLI accesses your AWS resources and returns the information you ask for.
118118

119-
This allows you to use Kiro CLI to ask questions and solve issues specific to your AWS account.
119+
To get account-specific answers, configure AWS CLI credentials.
120120

121-
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.
121+
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/).
122122

123-
Kiro accesses your AWS resources and prints the information you ask for.
124-
125-
## How can I set the Kiro CLI context to tailor responses?
123+
## Set the Kiro CLI context to tailor responses
126124

127125
Kiro CLI can read your context. If you provide more information about yourself, you get tailored responses that match your development environment.
128126

@@ -134,7 +132,7 @@ Use the `/context` command to see the possible locations to store your context.
134132
/context show
135133
```
136134

137-
The help information is printed.
135+
The output is similar to:
138136

139137
```output
140138
@@ -149,7 +147,7 @@ Session (temporary)
149147
No files in the current directory matched the rules above.
150148
```
151149

152-
For example, you can create a new file to store your context as shown below:
150+
For example, you can create a new file to store your context as follows:
153151

154152
```console
155153
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 +161,13 @@ Load the context file:
163161
/context add ~/.kiro/context.md
164162
```
165163

166-
Confirm it was read:
164+
Confirm the context file was read:
167165

168166
```console
169167
did you read my context information?
170168
```
171169

172-
The response confirms the context file was read:
170+
The response confirms the context file was read, and is similar to:
173171

174172
```output
175173
Yes, I read your context information. You're an Arm Linux developer who prefers Ubuntu and other Debian-based
@@ -179,7 +177,7 @@ information about those when you specifically ask for them.
179177

180178
Ask questions like "How do I install the AWS CLI?" to verify that the answers match the provided context.
181179

182-
## How do I change the model Kiro uses?
180+
## Change the model Kiro uses
183181

184182
When you start `kiro-cli chat`, the model is printed:
185183

@@ -193,7 +191,7 @@ Use the `/model` command to list other available models:
193191
/model
194192
```
195193

196-
The model options are displayed:
194+
The output is similar to:
197195

198196
```output
199197
Press (↑↓) to navigate · Enter(⏎) to select model
@@ -207,23 +205,23 @@ Use the arrow keys to select the model you want to use.
207205

208206
You can ask Kiro to set the default model for future sessions.
209207

210-
## Install a local MCP server
208+
## Configure the Arm MCP Server for Kiro CLI
209+
210+
You can use a Model Context Protocol (MCP) such as the Arm MCP Server with Kiro CLI.
211211

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.
212+
The Arm MCP Server provides AI assistants with tools and knowledge for Arm architecture development, migration, and optimization. You can configure the Arm MCP Server locally using Docker.
213213

214214
First, pull the MCP server image to your local machine:
215215

216216
```console
217217
docker pull armlimited/arm-mcp:latest
218218
```
219219

220-
You also need Docker running on the system. See the [Docker install guide](/install-guides/docker/) for instructions.
220+
You also need Docker running on the system. For instructions, see the [Docker install guide](/install-guides/docker/).
221221

222-
### How do I configure the Arm MCP server?
222+
Modify the file `~/.kiro/settings/mcp.json` to add the Arm MCP Server via a Docker container.
223223

224-
Modify the file `~/.kiro/settings/mcp.json` to add the Arm MCP server via a Docker container.
225-
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.
224+
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.
227225

228226
Replace the path `/path/to/your/workspace` with the path to your local codebase:
229227

@@ -254,9 +252,9 @@ Replace the path `/path/to/your/workspace` with the path to your local codebase:
254252

255253
To enable Arm Performix features through the Arm MCP Server, replace `/path/to/your/ssh/private_key` and `/path/to/your/ssh/known_hosts` with the SSH private key and `known_hosts` file used for your target device.
256254

257-
### Optional: Use a Docker replacement containerization tool
255+
### (Optional) Use an alternative containerization tool
258256

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`.
257+
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` to configure the Arm MCP Server.
260258

261259
{{< tabpane-normal >}}
262260
{{< tab header="Podman" >}}
@@ -357,7 +355,7 @@ Add the following configuration to the user-level `~/.kiro/settings/mcp.json` fi
357355
{{< tab header="Rancher Desktop" >}}
358356
Install: [Rancher Desktop](https://docs.rancherdesktop.io/getting-started/installation/)
359357

360-
Rancher Desktop uses the Docker container engine via Morby.
358+
Rancher Desktop uses the Docker container engine via Moby.
361359

362360
Pull the Arm MCP Server image:
363361
```console
@@ -389,9 +387,9 @@ Add the following configuration to the user-level `~/.kiro/settings/mcp.json` fi
389387
{{< /tab >}}
390388
{{< /tabpane-normal >}}
391389

392-
### How do I verify the Arm MCP server is working?
390+
### Verify that the Arm MCP Server is working
393391

394-
Start Kiro CLI chat from your local shell and list the tools from the MCP server to verify it is working:
392+
Start Kiro CLI chat from your local shell and list the tools from the MCP server to verify it's working:
395393

396394
```console
397395
kiro-cli chat
@@ -403,9 +401,9 @@ Use the `/tools` command to list the available tools:
403401
/tools
404402
```
405403

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.
404+
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.
407405

408-
### Use Arm prompt files with the MCP Server
406+
### Use Arm prompt files with the Arm MCP Server
409407

410408
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.
411409

@@ -419,4 +417,8 @@ Each prompt file is a Markdown configuration that you can reference in your Kiro
419417

420418
If you're facing issues or have questions, reach out to mcpserver@arm.com.
421419

422-
You're now ready to use Kiro CLI with the Arm MCP server for Arm-specific development assistance.
420+
## Next steps
421+
422+
You're now ready to use Kiro CLI with the Arm MCP Server for Arm-specific development assistance.
423+
424+
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

Comments
 (0)