updated the instorspect docs to refer to kiro CLI.

abhraina-aws · abhraina-aws · commit 90d66ece6b39 · 2025-11-06T12:56:25.000-08:00
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,6 +1,6 @@
 # Contributing Guidelines
 
-Thank you for your interest in contributing to Amazon Q. Whether it's a bug report, new feature, correction, or additional
+Thank you for your interest in contributing to KIRO CLI. Whether it's a bug report, new feature, correction, or additional
 documentation, we greatly value feedback and contributions from our community.
 
 Please read through this document before submitting any issues or pull requests to ensure we have all the necessary
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# Amazon Q CLI
+# KIRO CLI
 
 ## Installation
 
@@ -12,7 +12,7 @@
 
 ## Contributing
 
-Thank you so much for considering to contribute to Amazon Q.
+Thank you so much for considering to contribute to KIRO CLI.
 
 Before getting started, see our [contributing docs](CONTRIBUTING.md#security-issue-notifications).
 
@@ -48,7 +48,7 @@ cargo install typos-cli
 
 ## Project Layout
 
-- [`chat_cli`](crates/chat-cli/) - the `q` CLI, allows users to interface with Amazon Q Developer from
+- [`chat_cli`](crates/chat-cli/) - the `kiro` CLI, allows users to interface with KIRO Developer from
   the command line
 - [`scripts/`](scripts/) - Contains ops and build related scripts
 - [`crates/`](crates/) - Contains all rust crates
diff --git a/book.toml b/book.toml
@@ -1,3 +1,3 @@
 [book]
-title = "Amazon Q CLI Technical Documentation"
+title = "KIRO CLI Technical Documentation"
 src = "docs"
diff --git a/crates/chat-cli/src/cli/chat/tools/introspect.rs b/crates/chat-cli/src/cli/chat/tools/introspect.rs
@@ -95,7 +95,7 @@ impl Introspect {
         // Add settings information dynamically
         documentation.push_str("\n\n--- Available Settings ---\n");
         documentation.push_str(
-            "Q CLI supports these configuration settings (use `kiro-cli settings` command from terminal, NOT /settings):\n\n",
+            "KIRO CLI supports these configuration settings (use `kiro-cli settings` command from terminal, NOT /settings):\n\n",
         );
 
         // Automatically iterate over all settings with descriptions
@@ -111,25 +111,10 @@ impl Introspect {
         documentation.push_str("\n\n--- CRITICAL INSTRUCTION ---\n");
         documentation.push_str("YOU MUST ONLY provide information that is explicitly documented in the sections above. If specific details about any tool, feature, or command are not documented, you MUST clearly state that the information is not available in the documentation. DO NOT generate plausible-sounding information or make assumptions about undocumented features.\n\n");
 
-        documentation.push_str("--- GitHub References ---\n");
-        documentation.push_str("INSTRUCTION: When your response uses information from any of these documentation files, include the relevant GitHub link(s) at the end:\n");
-        documentation.push_str("• README.md: https://github.com/aws/amazon-q-developer-cli/blob/main/README.md\n");
-        documentation.push_str(
-            "• Built-in Tools: https://github.com/aws/amazon-q-developer-cli/blob/main/docs/built-in-tools.md\n",
-        );
-        documentation
-            .push_str("• Experiments: https://github.com/aws/amazon-q-developer-cli/blob/main/docs/experiments.md\n");
-        documentation.push_str("• Agent File Locations: https://github.com/aws/amazon-q-developer-cli/blob/main/docs/agent-file-locations.md\n");
-        documentation
-            .push_str("• Tangent Mode: https://github.com/aws/amazon-q-developer-cli/blob/main/docs/tangent-mode.md\n");
-        documentation.push_str(
-            "• Introspect Tool: https://github.com/aws/amazon-q-developer-cli/blob/main/docs/introspect-tool.md\n",
-        );
-        documentation
-            .push_str("• Todo Lists: https://github.com/aws/amazon-q-developer-cli/blob/main/docs/todo-lists.md\n");
-        documentation.push_str("• Hooks: https://github.com/aws/amazon-q-developer-cli/blob/main/docs/hooks.md\n");
-        documentation
-            .push_str("• Contributing: https://github.com/aws/amazon-q-developer-cli/blob/main/CONTRIBUTING.md\n");
+        // TODO: Add KIRO CLI documentation links when available
+        // documentation.push_str("--- GitHub References ---\n");
+        // documentation.push_str("INSTRUCTION: When your response uses information from any of these documentation files, include the relevant GitHub link(s) at the end:\n");
+        // documentation.push_str("• README.md: https://github.com/kiro-cli/kiro-cli/blob/main/README.md\n");
 
         let response = IntrospectResponse {
             built_in_help: Some(help_content),
diff --git a/docs/agent-file-locations.md b/docs/agent-file-locations.md
@@ -10,7 +10,7 @@ Local agents are stored in the current working directory under:
 .amazonq/cli-agents/
 ```
 
-These agents are specific to the current workspace or project and are only available when running Q CLI from that directory or its subdirectories.
+These agents are specific to the current workspace or project and are only available when running KIRO CLI from that directory or its subdirectories.
 
 **Example structure:**
 ```
@@ -33,7 +33,7 @@ Global agents are stored in your home directory under:
 
 Note: For globally available agents, the `amazonq` directory is in the `.aws` folder. 
 
-These agents are available from any directory when using Q CLI.
+These agents are available from any directory when using KIRO CLI.
 
 **Example structure:**
 ```
@@ -45,14 +45,14 @@ These agents are available from any directory when using Q CLI.
 
 ## Agent Precedence
 
-When Q CLI looks for an agent, it follows this precedence order:
+When KIRO CLI looks for an agent, it follows this precedence order:
 
 1. **Local first**: Checks `.amazonq/cli-agents/` in the current working directory
 2. **Global fallback**: If not found locally, checks `~/.aws/amazonq/cli-agents/` in the home directory
 
 ## Naming Conflicts
 
-If both local and global directories contain agents with the same name, the **local agent takes precedence**. When this happens, Q CLI will display a warning message:
+If both local and global directories contain agents with the same name, the **local agent takes precedence**. When this happens, KIRO CLI will display a warning message:
 
 ```
 WARNING: Agent conflict for my-agent. Using workspace version.
@@ -107,4 +107,4 @@ EOF
 
 ## Directory Creation
 
-Q CLI will automatically create the global agents directory (`~/.aws/amazonq/cli-agents/`) if it doesn't exist. However, you need to manually create the local agents directory (`.amazonq/cli-agents/`) in your workspace if you want to use local agents.
+KIRO CLI will automatically create the global agents directory (`~/.aws/amazonq/cli-agents/`) if it doesn't exist. However, you need to manually create the local agents directory (`.amazonq/cli-agents/`) in your workspace if you want to use local agents.
diff --git a/docs/agent-format.md b/docs/agent-format.md
@@ -363,7 +363,7 @@ The `model` field specifies the model ID to use for this agent. If not specified
 }
 ```
 
-The model ID must match one of the available models returned by the Q CLI's model service. You can see available models by using the `/model` command in an active chat session.
+The model ID must match one of the available models returned by the KIRO CLI's model service. You can see available models by using the `/model` command in an active chat session.
 
 If the specified model is not available, the agent will fall back to the default model and display a warning.
 
diff --git a/docs/built-in-tools.md b/docs/built-in-tools.md
@@ -1,11 +1,11 @@
 # Built-in Tools
 
-Amazon Q CLI includes several built-in tools that agents can use. This document describes each tool and its configuration options.
+KIRO CLI includes several built-in tools that agents can use. This document describes each tool and its configuration options.
 
 - [`execute_bash`](#execute_bash-tool) — Execute a shell command.
 - [`fs_read`](#fs_read-tool) — Read files, directories, and images.
 - [`fs_write`](#fs_write-tool) — Create and edit files.
-- [`introspect`](#introspect-tool) — Provide information about Q CLI capabilities and documentation.
+- [`introspect`](#introspect-tool) — Provide information about KIRO CLI capabilities and documentation.
 - [`report_issue`](#report_issue-tool) — Open a GitHub issue template.
 - [`knowledge`](#knowledge-tool) — Store and retrieve information in a knowledge base.
 - [`thinking`](#thinking-tool) — Internal reasoning mechanism.
@@ -91,11 +91,11 @@ Tool for creating and editing files.
 
 ## Introspect Tool
 
-Provide information about Q CLI capabilities, features, commands, and documentation. This tool accesses Q CLI's built-in documentation and help content to answer questions about the CLI's functionality.
+Provide information about KIRO CLI capabilities, features, commands, and documentation. This tool accesses KIRO CLI's built-in documentation and help content to answer questions about the CLI's functionality.
 
 ### Usage
 
-The introspect tool is automatically used when you ask questions about Q CLI itself, such as:
+The introspect tool is automatically used when you ask questions about KIRO CLI itself, such as:
 - "What can you do?"
 - "How do I save conversations?"
 - "What commands are available?"
diff --git a/docs/default-agent-behavior.md b/docs/default-agent-behavior.md
@@ -1,19 +1,19 @@
 # Default Agent Behavior
 
-When no specific agent is configured or when the specified agent cannot be found, Q CLI follows a fallback hierarchy to determine which agent to use.
+When no specific agent is configured or when the specified agent cannot be found, KIRO CLI follows a fallback hierarchy to determine which agent to use.
 
 ## Agent Selection Priority
 
-Q CLI selects an agent in the following order of priority:
+KIRO CLI selects an agent in the following order of priority:
 
 ### 1. Command-Line Specified Agent
-The agent specified via the `--agent` flag when starting Q CLI:
+The agent specified via the `--agent` flag when starting KIRO CLI:
 
 ```bash
 q chat --agent my-custom-agent
 ```
 
-If this agent exists, it will be used. If not, Q CLI will display an error and fall back to the next option.
+If this agent exists, it will be used. If not, KIRO CLI will display an error and fall back to the next option.
 
 ### 2. User-Defined Default Agent
 The default agent configured via the settings system:
@@ -22,12 +22,12 @@ The default agent configured via the settings system:
 q settings chat.defaultAgent my-preferred-agent
 ```
 
-This setting is stored in your Q CLI configuration and will be used across all sessions unless overridden by the `--agent` flag.
+This setting is stored in your KIRO CLI configuration and will be used across all sessions unless overridden by the `--agent` flag.
 
-If the configured default agent cannot be found, Q CLI will display an error and fall back to the built-in default.
+If the configured default agent cannot be found, KIRO CLI will display an error and fall back to the built-in default.
 
 ### 3. Built-in Default Agent
-If no agent is specified or found, Q CLI uses a built-in default agent with the following configuration:
+If no agent is specified or found, KIRO CLI uses a built-in default agent with the following configuration:
 
 ```json
 {
diff --git a/docs/experiments.md b/docs/experiments.md
@@ -1,6 +1,6 @@
 # Experimental Features
 
-Amazon Q CLI includes experimental features that can be toggled on/off using the `/experiment` command. These features are in active development and may change or be removed at any time.
+KIRO CLI includes experimental features that can be toggled on/off using the `/experiment` command. These features are in active development and may change or be removed at any time.
 
 ## Available Experiments
 
diff --git a/docs/introduction.md b/docs/introduction.md
@@ -1,6 +1,6 @@
-# Amazon Q CLI
+# KIRO CLI
 
-Welcome to the supplementary Amazon Q CLI Developer documentation.
-This documentation supplements [the primary Amazon Q CLI documentation](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/command-line.html).
+Welcome to the supplementary KIRO CLI Developer documentation.
+This documentation supplements the primary KIRO CLI documentation.
 
 These docs are experimental, work in progress, and subject to change. As of now, they do not represent latest stable builds, instead documenting the functionality of development builds.
diff --git a/docs/introspect-tool.md b/docs/introspect-tool.md
@@ -1,13 +1,13 @@
 # Introspect Tool
 
-The introspect tool provides Q CLI with self-awareness, automatically answering questions about Q CLI's features, commands, and functionality using official documentation.
+The introspect tool provides KIRO CLI with self-awareness, automatically answering questions about KIRO CLI's features, commands, and functionality using official documentation.
 
 ## How It Works
 
-The introspect tool activates automatically when you ask Q CLI questions like:
-- "How do I save conversations with Q CLI?"
-- "What experimental features does Q CLI have?"
-- "Can Q CLI read files?"
+The introspect tool activates automatically when you ask KIRO CLI questions like:
+- "How do I save conversations with KIRO CLI?"
+- "What experimental features does KIRO CLI have?"
+- "Can KIRO CLI read files?"
 
 ## What It Provides
 
@@ -23,22 +23,22 @@ The introspect tool activates automatically when you ask Q CLI questions like:
 ## Usage Examples
 
 ```
-> How do I save conversations with Q CLI?
+> How do I save conversations with KIRO CLI?
 You can save conversations using `/save` or `/save name`.
 Load them later with `/load`.
 
-> What experimental features does Q CLI have?
-Q CLI offers Tangent Mode and Thinking Mode. 
+> What experimental features does KIRO CLI have?
+KIRO CLI offers Tangent Mode and Thinking Mode. 
 Use `/experiment` to enable them.
 
-> Can Q CLI read and write files?
-Yes, Q CLI has fs_read, fs_write, and execute_bash tools
+> Can KIRO CLI read and write files?
+Yes, KIRO CLI has fs_read, fs_write, and execute_bash tools
 for file operations.
 ```
 
 ## Auto-Tangent Mode
 
-Enable automatic tangent mode for Q CLI help questions:
+Enable automatic tangent mode for KIRO CLI help questions:
 
 ```bash
 q settings introspect.tangentMode true
@@ -48,7 +48,7 @@ This keeps help separate from your main conversation.
 
 ## Best Practices
 
-1. **Be explicit**: Ask "How does Q CLI handle files?" not "How do you handle files?"
+1. **Be explicit**: Ask "How does KIRO CLI handle files?" not "How do you handle files?"
 2. **Verify information**: Check the GitHub links provided in responses
 3. **Use proper syntax**: Reference commands with `/` (e.g., `/save`)
 4. **Enable auto-tangent**: Keep help isolated from main conversations
diff --git a/docs/knowledge-management.md b/docs/knowledge-management.md
@@ -1,6 +1,6 @@
 # Knowledge Management
 
-The /knowledge command provides persistent knowledge base functionality for Amazon Q CLI, allowing you to store, search, and manage contextual information that persists across chat sessions.
+The /knowledge command provides persistent knowledge base functionality for KIRO CLI, allowing you to store, search, and manage contextual information that persists across chat sessions.
 
 > [!NOTE]
 > This is a beta feature that must be enabled before use.
diff --git a/docs/tangent-mode.md b/docs/tangent-mode.md
@@ -8,7 +8,7 @@ Tangent mode is experimental and must be enabled:
 
 **Via Experiment Command**: Run `/experiment` and select tangent mode from the list.
 
-**Via Settings**: `q settings chat.enableTangentMode true`
+**Via Settings**: `kiro-cli settings chat.enableTangentMode true`
 
 ## Basic Usage
 
@@ -60,7 +60,7 @@ Restored conversation from checkpoint (↯).
 > Thanks! I'll go with pandas. Can you show me error handling?
 ```
 
-### Example 2: Getting Q CLI Help
+### Example 2: Getting KIRO CLI Help
 ```
 > Help me write a deployment script
 
@@ -69,9 +69,9 @@ I can help you create a deployment script...
 > /tangent
 Created a conversation checkpoint (↯).
 
-↯ > What Q CLI commands are available for file operations?
+↯ > What KIRO CLI commands are available for file operations?
 
-Q CLI provides fs_read, fs_write, execute_bash...
+KIRO CLI provides fs_read, fs_write, execute_bash...
 
 ↯ > /tangent
 Restored conversation from checkpoint (↯).
@@ -128,13 +128,13 @@ Restored conversation from checkpoint (↯) with last conversation entry preserv
 ### Keyboard Shortcut
 ```bash
 # Change shortcut key (default: t)
-q settings chat.tangentModeKey y
+kiro-cli settings chat.tangentModeKey y
 ```
 
 ### Auto-Tangent for Introspect
 ```bash
-# Auto-enter tangent mode for Q CLI help questions
-q settings introspect.tangentMode true
+# Auto-enter tangent mode for KIRO CLI help questions
+kiro-cli settings introspect.tangentMode true
 ```
 
 ## Visual Indicators
@@ -148,7 +148,7 @@ q settings introspect.tangentMode true
 ### When to Use Tangent Mode
 - Asking clarifying questions about the current topic
 - Exploring alternative approaches before deciding
-- Getting help with Q CLI commands or features
+- Getting help with KIRO CLI commands or features
 - Testing understanding of concepts
 
 ### When NOT to Use
@@ -178,19 +178,19 @@ q settings introspect.tangentMode true
 /experiment
 
 # Or enable via settings
-q settings chat.enableTangentMode true
+kiro-cli settings chat.enableTangentMode true
 ```
 
 ### Keyboard Shortcut Not Working
 ```bash
 # Check/reset shortcut key
-q settings chat.tangentModeKey t
+kiro-cli settings chat.tangentModeKey t
 ```
 
 ### Lost in Tangent Mode
 Look for the `↯` symbol in your prompt. Use `/tangent` to exit and return to main conversation.
 
 ## Related Features
 
-- **Introspect**: Q CLI help (auto-enters tangent if configured)
+- **Introspect**: KIRO CLI help (auto-enters tangent if configured)
 - **Experiments**: Manage experimental features with `/experiment`
diff --git a/docs/todo-lists.md b/docs/todo-lists.md
@@ -1,6 +1,6 @@
 # TODO Management
 
-The `/todos` command provides persistent TODO list management for Amazon Q CLI, allowing you to view, resume, and manage TODO lists created during chat sessions.
+The `/todos` command provides persistent TODO list management for KIRO CLI, allowing you to view, resume, and manage TODO lists created during chat sessions.
 
 ## Getting Started
 

Original file line number	Diff line number	Diff line change
@@ -363,7 +363,7 @@ The `model` field specifies the model ID to use for this agent. If not specified
`363`	`363`	`}`
`364`	`364`	```
`365`	`365`
`366`		-The model ID must match one of the available models returned by the Q CLI's model service. You can see available models by using the `/model` command in an active chat session.
	`366`	+The model ID must match one of the available models returned by the KIRO CLI's model service. You can see available models by using the `/model` command in an active chat session.
`367`	`367`
`368`	`368`	`If the specified model is not available, the agent will fall back to the default model and display a warning.`
`369`	`369`