Kiro CLI

https://kiro.dev/docs/cli
Admin
Kiro CLI brings AI-assisted development to your terminal, enabling natural language commands and...
Tokens:134,387
Snippets:1,301
Trust Score:10
Update:5 hours ago
Show doc for...
Tokens:
Raw
### Example questions for the guide agent

Source: https://kiro.dev/docs/cli/setup/

Example prompts to ask the guide agent about capabilities, project setup, code reviews, and GitHub connection.

```bash
[guide] > What can you help me with?

[guide] > How should I set up this project to work well with Kiro?

[guide] > What's the best way to do code reviews with Kiro?

[guide] > How do I connect my GitHub account?
```

--------------------------------

### Open the guide agent with /guide

Source: https://kiro.dev/docs/cli/setup/

Type /guide in a Kiro CLI session to start the built-in guide agent, which can answer questions and create configuration files.

```bash
> /guide
```

--------------------------------

### Cloud setup helper command

Source: https://kiro.dev/docs/cli/voice/

Starts the local voice server and opens a reverse tunnel to the specified cloud hostname. The helper verifies SSH connectivity and starts voice-serve locally, but does not configure voice.serverUrl on the cloud desktop.

```bash
kiro-cli voice-cloud-setup <cloud-hostname>
```

--------------------------------

### Start complex task with TODO list

Source: https://kiro.dev/docs/cli/experimental/todo-lists/

User input to start a complex task that triggers the TODO list feature. The example asks to set up CI/CD for the project.

```text
> I need to set up CI/CD for our project
```

--------------------------------

### Resume TODO list with /todo resume

Source: https://kiro.dev/docs/cli/experimental/todo-lists/

User input to resume a TODO list using the /todo resume command, followed by Kiro's prompt to select a list. The example shows the CI/CD Setup list with 4 out of 7 tasks completed.

```text
> /todo resume

? Select a to-do list to resume: ›
❯ ✗ CI/CD Setup (4/7)

# Continue where you left off
```

--------------------------------

### V3 prompts with arguments examples

Source: https://kiro.dev/docs/cli/chat/manage-prompts/

Examples of V3 prompts with arguments, demonstrating how to pass multiple arguments to a prompt.

```plaintext
# Examples: V3 prompts with arguments
/analyze "performance issue" "detailed"
/scan "web-app" "high-severity"
```

--------------------------------

### Example: Compare files

Source: https://kiro.dev/docs/cli/chat/file-references/

Example of using file references to compare two files.

```plaintext
> What's different between @v1/handler.py and @v2/handler.py?
```

--------------------------------

### Example workflow using /tangent and /tangent tail

Source: https://kiro.dev/docs/cli/experimental/tangent-mode/

Shows a typical conversation flow where a tangent is started with /tangent, explored, and then kept with /tangent tail before returning to the main task.

```text
> Help me refactor this React component

# Main conversation starts...

> /tangent
↯ > What's the difference between useMemo and useCallback?

# Get clarification...

↯ > /tangent tail  # This was useful, keep it

> Now I understand. Let's use useMemo for the expensive calculation...
```

--------------------------------

### Example: Explore structure

Source: https://kiro.dev/docs/cli/chat/file-references/

Example of using a directory reference to explore the structure of a directory.

```plaintext
> What's the structure of @infra/cdk/?
```

--------------------------------

### Install Kiro CLI on macOS, Linux, or Windows

Source: https://kiro.dev/docs/cli/

Install the Kiro CLI using the official installation script. This command downloads and runs the installer from cli.kiro.dev.

```bash
curl -fsSL https://cli.kiro.dev/install | bash
```

--------------------------------

### Example: Review a file

Source: https://kiro.dev/docs/cli/chat/file-references/

Example of using a file reference to request a security review.

```plaintext
> Review @src/auth.ts for security issues
```

--------------------------------

### /knowledge add examples

Source: https://kiro.dev/docs/cli/experimental/knowledge-management/

Examples of adding knowledge entries with different options: using long and short flags, and specifying index types.

```bash
/knowledge add --name "project-docs" --path /path/to/documentation
/knowledge add -n "config-files" -p /path/to/config.json
/knowledge add --name "fast-search" --path /path/to/logs --index-type Fast
/knowledge add -n "semantic-search" -p /path/to/docs --index-type Best
```

--------------------------------

### Example of automatic TODO list creation

Source: https://kiro.dev/docs/cli/experimental/todo-lists/

Shows an example interaction where a user requests a TODO list with 3 read-only tasks, and Kiro creates it using the todo_list tool. The output displays the created tasks and completion time.

```text
> Make a todo list with 3 read-only tasks.

I'll create a todo list with 3 read-only tasks for you.

🛠️  Using tool: todo_list (trusted)
 ⋮ 
 ● TODO:
[ ] Review project documentation
[ ] Check system status
[ ] Read latest updates
 ⋮ 
 ● Completed in 0.4s
```

--------------------------------

### Ask Guide agent to create a code review agent

Source: https://kiro.dev/docs/cli/setup/

Use this command in the TUI to have the Guide agent generate a custom agent configuration file.

```bash
> /guide Create an agent for code review
```

--------------------------------

### Show task results

Source: https://kiro.dev/docs/cli/experimental/delegate/

Example prompts to retrieve results from a completed background task.

```text
> Show me the results from [task name]
> What did the background task find?
```

--------------------------------

### Start using Kiro CLI

Source: https://kiro.dev/docs/cli/

Navigate to your project directory and launch the Kiro CLI interactive terminal.

```bash
cd my-project
kiro-cli
```

--------------------------------

### Install delta on macOS and Ubuntu/Debian

Source: https://kiro.dev/docs/cli/chat/diff-tools/

Installation commands for the `delta` diff tool on macOS using Homebrew and on Ubuntu/Debian using apt. These are provided as an example for troubleshooting the 'Couldn't find the diff tool' error.

```bash
# macOS
brew install git-delta

# Ubuntu/Debian
sudo apt install git-delta
```

--------------------------------

### initialize

Source: https://kiro.dev/docs/cli/v3/acp-migration.md

Negotiates the protocol, authentication, and capabilities. Use the returned capabilities to decide which UI and protocol behavior to enable.

```APIDOC
## initialize

### Description
Negotiates the protocol, authentication, and capabilities. Use the returned capabilities to decide which UI and protocol behavior to enable.

### Method
JSON-RPC

### Request
```json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "initialize",
  "params": {}
}
```

### Response
- `agentCapabilities` (object) - Contains `_meta.kiro.extensionMethods` (array of strings) listing optional Kiro request methods.
- `agentCapabilities._meta.kiro.extensionMethods` (array of strings) - Optional Kiro request methods.
- `agentCapabilities._meta.kiro.sessionSources` (array) - Advertised session sources.
- `agentCapabilities._meta.kiro.listScopes` (array) - Advertised list scopes.
- `agentCapabilities._meta.kiro.executionTargets` (array) - Advertised execution targets.
- `agentCapabilities._meta.kiro.replayMarking` (object) - Replay marking configuration.
- `agentCapabilities._meta.kiro.logging` (object) - Logging configuration.

### Notes
- Do not infer support from a Kiro CLI version or a hard-coded method list.
- The running server's advertisement is authoritative.
- Gate every optional request on the advertised method list.
- Ignore unknown fields and preserve unknown `_meta` data through relays and replay.
```

--------------------------------

### Manual remote voice server setup

Source: https://kiro.dev/docs/cli/voice/

Manual setup for using a remote voice server when working on a cloud desktop without a microphone. Run the voice server on your local machine, open a reverse tunnel via SSH, and set the KIRO_VOICE_SERVER_URL environment variable on the cloud desktop before starting Kiro.

```bash
# On your local machine (the one with a microphone):
kiro-cli voice-serve

# Open a reverse tunnel when you SSH to the cloud desktop:
ssh -R 19876:localhost:19876 cloud-desktop

# On the cloud desktop, point voice mode at the tunnel before starting Kiro:
export KIRO_VOICE_SERVER_URL=http://127.0.0.1:19876
kiro-cli
```

--------------------------------

### Tracking multi-step implementations with TODO list

Source: https://kiro.dev/docs/cli/experimental/todo-lists/

Example interaction where the user asks to implement user authentication and the CLI breaks it into steps.

```plaintext
> Help me implement user authentication

I'll break this down into manageable steps:

🛠️  Using tool: todo
 ● TODO: User Authentication Implementation
[ ] Set up authentication library
[ ] Create user model and database schema
[ ] Implement registration endpoint
[ ] Implement login endpoint
[ ] Add password hashing
[ ] Create JWT token generation
[ ] Add authentication middleware
[ ] Write tests for auth flow
```

--------------------------------

### Examples of prompt and file references

Source: https://kiro.dev/docs/cli/chat/manage-prompts/

Shows usage of a local prompt, file inclusion, and directory structure display.

```bash
/code-review
# Uses your local code-review prompt in V3

@src/auth.rs
# Includes the contents of src/auth.rs file

@crates/agent/
# Shows the directory structure of crates/agent/
```

--------------------------------

### Kiro creates TODO list for CI/CD setup

Source: https://kiro.dev/docs/cli/experimental/todo-lists/

Kiro's response showing the TODO list tool usage and the generated list of tasks for CI/CD setup. The list includes choosing a platform, creating pipeline configuration, setting up build and test stages, configuring deployment, setting environment variables, and testing the pipeline.

```text
🛠️  Using tool: todo_list
 ● TODO: CI/CD Setup
[ ] Choose CI/CD platform
[ ] Create pipeline configuration
[ ] Set up build stage
[ ] Add test stage
[ ] Configure deployment stage
[ ] Set up environment variables
[ ] Test pipeline
```

--------------------------------

### Check if diff tool is installed

Source: https://kiro.dev/docs/cli/chat/diff-tools/

Verifies that a diff tool is installed and accessible in your PATH. If nothing is returned, the tool is not installed.

```bash
which delta
```

--------------------------------

### Basic file-based prompt creation and usage

Source: https://kiro.dev/docs/cli/chat/manage-prompts/

Shows how to create a simple prompt without arguments and then use it in V3.

```bash
# Create a simple prompt without arguments
/prompts create --name code-review --content "Please review this code for best practices, security issues, and potential improvements:"

# Use the prompt in V3
/code-review
```

--------------------------------

### Start V3 session with kiro-cli --v3

Source: https://kiro.dev/docs/cli/v3/migration-guide/

Run this command in the workspace you want to migrate. V3 uses a different session store from V2; existing V2 sessions are not converted or deleted. Use `kiro-cli chat --v2 --resume-picker` to return to V2 sessions.

```bash
kiro-cli --v3
```

--------------------------------

### Start a chat session

Source: https://kiro.dev/docs/cli/chat/

Run `kiro-cli` to start an interactive chat session in the terminal.

```bash
kiro-cli
```

--------------------------------

### Pattern filtering examples

Source: https://kiro.dev/docs/cli/experimental/knowledge-management/

Examples of using include and exclude patterns to control which files are indexed.

```bash
/knowledge add "rust-code" /path/to/project --include "*.rs" --exclude "target/**"
/knowledge add "docs" /path/to/project --include "**/*.md" --include "**/*.txt" --exclude "node_modules/**"
```

--------------------------------

### Build task patterns

Source: https://kiro.dev/docs/cli/experimental/delegate/

Example prompts for build tasks that can be run as background tasks, such as building the project, compiling and running tests, and generating production bundles.

```text
> Build the project in the background
> Compile and run tests as a background task
> Generate production bundle in background
```

--------------------------------

### Start a chat with a specific agent

Source: https://kiro.dev/docs/cli/chat/

Use `--agent` to start a chat with a specific agent context.

```bash
kiro-cli --agent myagent
```

--------------------------------

### Diagnostics output example

Source: https://kiro.dev/docs/cli/v3/upgrade-agent/

Example output from the diagnostics command showing two agents with warnings: regex-shell-pattern and deny-by-default-readonly.

```text
2 Universal agents

  my-agent     Workspace   ⚠ regex-shell-pattern: ^git\s
  strict-dev   Global      ⚠ deny-by-default-readonly
```

--------------------------------

### Switch agents and manage knowledge bases

Source: https://kiro.dev/docs/cli/experimental/knowledge-management/

Shows how to add knowledge to the default agent, switch to a custom agent, add agent-specific docs, switch back, and verify that the default agent only sees its original docs.

```bash
# Working with default agent
/knowledge add /path/to/docs

# Switch to custom agent
kiro chat --agent my-custom-agent

# Creates separate knowledge base for my-custom-agent
/knowledge add /path/to/agent/docs

# Switch back to default
kiro chat

# Only sees original docs, not agent-specific docs
/knowledge show
```

--------------------------------

### Example: Mixed context

Source: https://kiro.dev/docs/cli/chat/file-references/

Example of using multiple file references in a single message to provide mixed context.

```plaintext
> Using the config in @serverless.yml, update @src/lambda/index.ts
```

--------------------------------

### initialize

Source: https://kiro.dev/docs/cli/acp.md

Initializes a connection with Kiro, negotiating protocol version and capabilities.

```APIDOC
## initialize

### Description
Initializes a connection with Kiro, negotiating protocol version and capabilities.

### Method
JSON-RPC

### Endpoint
initialize

### Parameters
#### Request Body
- **protocolVersion** (number) - Required - The protocol version to use.
- **clientCapabilities** (object) - Required - Capabilities supported by the client.
  - **fs** (object) - Optional - File system capabilities.
    - **readTextFile** (boolean) - Optional - Whether the client can read text files.
    - **writeTextFile** (boolean) - Optional - Whether the client can write text files.
  - **terminal** (boolean) - Optional - Whether the client supports terminal.
- **clientInfo** (object) - Required - Information about the client.
  - **name** (string) - Required - Client name.
  - **version** (string) - Required - Client version.

### Request Example
{
  "jsonrpc": "2.0",
  "id": 0,
  "method": "initialize",
  "params": {
    "protocolVersion": 1,
    "clientCapabilities": {
      "fs": {
        "readTextFile": true,
        "writeTextFile": true
      },
      "terminal": true
    },
    "clientInfo": {
      "name": "my-editor",
      "version": "1.0.0"
    }
  }
}

### Response
#### Success Response
- **protocolVersion** (number) - The negotiated protocol version.
- **agentCapabilities** (object) - Capabilities supported by the agent.
  - **loadSession** (boolean) - Whether session loading is supported.
  - **promptCapabilities** (object) - Prompt capabilities.
    - **image** (boolean) - Whether image prompts are supported.
- **agentInfo** (object) - Information about the agent.
  - **name** (string) - Agent name.
  - **version** (string) - Agent version.

#### Response Example
{
  "jsonrpc": "2.0",
  "id": 0,
  "result": {
    "protocolVersion": 1,
    "agentCapabilities": {
      "loadSession": true,
      "promptCapabilities": {
        "image": true
      }
    },
    "agentInfo": {
      "name": "kiro-cli",
      "version": "1.5.0"
    }
  }
}
```
Tokens:
Raw