Skip to content

Commit bde42ae

Browse files
abhishekanneabhishekanne
committed
Kiro-cli docs added missing settings docs
1 parent 878698f commit bde42ae

File tree

6 files changed

+688
-0
lines changed

6 files changed

+688
-0
lines changed

‎docs/kiro-cli-docs/autodocs/docs/settings/api-service-settings.md‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
doc_meta:
3+
validated: 2025-12-19
4+
commit: 57090ffe
5+
status: validated
6+
testable_headless: true
7+
category: settings-group
8+
title: API and Service Settings
9+
description: Settings for API timeouts and service configurations
10+
keywords: [settings, api, timeout, service, network]
11+
---
12+
13+
# API and Service Settings
14+
15+
Configure API timeouts and service-related settings for Kiro CLI.
16+
17+
## api.timeout
18+
19+
API request timeout in seconds.
20+
21+
### Overview
22+
23+
Sets the timeout duration for API requests made by Kiro CLI. Affects requests to AI models, external services, and other network operations.
24+
25+
### Usage
26+
27+
```bash
28+
kiro-cli settings api.timeout 30
29+
```
30+
31+
**Type**: Number
32+
**Default**: `30`
33+
**Unit**: Seconds
34+
35+
### Examples
36+
37+
```bash
38+
# Increase for slow connections
39+
kiro-cli settings api.timeout 60
40+
41+
# Decrease for fast networks
42+
kiro-cli settings api.timeout 15
43+
44+
# Check current timeout
45+
kiro-cli settings api.timeout
46+
```
47+
48+
### Timeout Guidelines
49+
50+
- **15s**: Fast networks, quick failure detection
51+
- **30s**: Balanced (default)
52+
- **60s**: Slow networks, complex requests
53+
- **120s**: Very slow networks or large requests
54+
55+
### Use Cases
56+
57+
**Increase timeout for**:
58+
- Slow internet connections
59+
- Complex AI model requests
60+
- Large file operations
61+
- Unstable networks
62+
63+
**Decrease timeout for**:
64+
- Fast, reliable connections
65+
- Quick failure detection
66+
- Interactive responsiveness

‎docs/kiro-cli-docs/autodocs/docs/settings/chat-interface-settings.md‎

Lines changed: 137 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,137 @@
1+
---
2+
doc_meta:
3+
validated: 2025-12-19
4+
commit: 57090ffe
5+
status: validated
6+
testable_headless: true
7+
category: settings-group
8+
title: Chat Interface Settings
9+
description: Settings for chat interface behavior and appearance
10+
keywords: [settings, chat, interface, ui, notifications]
11+
---
12+
13+
# Chat Interface Settings
14+
15+
Configure chat interface behavior, appearance, and user experience.
16+
17+
## chat.editMode
18+
19+
Enable edit mode for chat interface.
20+
21+
### Overview
22+
23+
Controls whether edit mode is enabled in the chat interface, allowing users to modify their input before sending messages.
24+
25+
### Usage
26+
27+
```bash
28+
kiro-cli settings chat.editMode true
29+
```
30+
31+
**Type**: Boolean
32+
**Default**: `false`
33+
34+
---
35+
36+
## chat.enableNotifications
37+
38+
Enable desktop notifications for chat events.
39+
40+
### Overview
41+
42+
Controls whether Kiro CLI shows desktop notifications for important chat events like completion of long-running tasks or errors.
43+
44+
### Usage
45+
46+
```bash
47+
kiro-cli settings chat.enableNotifications true
48+
```
49+
50+
**Type**: Boolean
51+
**Default**: `false`
52+
53+
### Use Cases
54+
55+
- Long-running operations completion
56+
- Error alerts
57+
- Background task updates
58+
59+
---
60+
61+
## chat.disableAutoCompaction
62+
63+
Disable automatic conversation summarization.
64+
65+
### Overview
66+
67+
Controls whether Kiro CLI automatically compacts long conversations by summarizing older messages to save context window space. When disabled, conversations may hit context limits faster but preserve full detail.
68+
69+
### Usage
70+
71+
```bash
72+
kiro-cli settings chat.disableAutoCompaction true
73+
```
74+
75+
**Type**: Boolean
76+
**Default**: `false`
77+
78+
### Trade-offs
79+
80+
**Disabled (true)**:
81+
- Full conversation detail preserved
82+
- May hit context limits faster
83+
- Better for debugging/review
84+
85+
**Enabled (false)**:
86+
- Longer conversations possible
87+
- Older messages summarized
88+
- More efficient context usage
89+
90+
---
91+
92+
## chat.enableHistoryHints
93+
94+
Show conversation history hints.
95+
96+
### Overview
97+
98+
Controls whether to display hints about conversation history, such as when messages have been compacted or when approaching context limits.
99+
100+
### Usage
101+
102+
```bash
103+
kiro-cli settings chat.enableHistoryHints true
104+
```
105+
106+
**Type**: Boolean
107+
**Default**: `false`
108+
109+
### Examples
110+
111+
Shows hints like "Previous messages summarized" or "Context 80% full".
112+
113+
---
114+
115+
## chat.uiMode
116+
117+
Set UI variant for chat interface.
118+
119+
### Overview
120+
121+
Controls which UI variant to use for the chat interface. Different modes provide different layouts and interaction patterns.
122+
123+
### Usage
124+
125+
```bash
126+
kiro-cli settings chat.uiMode "compact"
127+
```
128+
129+
**Type**: String
130+
**Default**: `"default"`
131+
**Values**: `"default"`, `"compact"`, `"minimal"`
132+
133+
### UI Modes
134+
135+
- **default**: Standard interface with full features
136+
- **compact**: Reduced spacing and smaller elements
137+
- **minimal**: Minimal interface for focused work

‎docs/kiro-cli-docs/autodocs/docs/settings/key-bindings-settings.md‎

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
---
2+
doc_meta:
3+
validated: 2025-12-19
4+
commit: 57090ffe
5+
status: validated
6+
testable_headless: true
7+
category: settings-group
8+
title: Key Bindings Settings
9+
description: Settings for keyboard shortcuts and key bindings
10+
keywords: [settings, key, bindings, shortcuts, keyboard]
11+
---
12+
13+
# Key Bindings Settings
14+
15+
Configure keyboard shortcuts and key bindings for various Kiro CLI features.
16+
17+
## chat.skimCommandKey
18+
19+
Key for fuzzy search command.
20+
21+
### Overview
22+
23+
Sets the keyboard shortcut key for triggering fuzzy search functionality. Used with Ctrl (Ctrl+key) to quickly search through files, commands, or history.
24+
25+
### Usage
26+
27+
```bash
28+
kiro-cli settings chat.skimCommandKey "f"
29+
```
30+
31+
**Type**: String (single character)
32+
**Default**: `"f"` (Ctrl+F)
33+
34+
---
35+
36+
## chat.autocompletionKey
37+
38+
Key for autocompletion hint acceptance.
39+
40+
### Overview
41+
42+
Sets the key used to accept autocompletion hints in the chat interface. When autocompletion suggestions appear, this key accepts the suggestion.
43+
44+
### Usage
45+
46+
```bash
47+
kiro-cli settings chat.autocompletionKey "Tab"
48+
```
49+
50+
**Type**: String
51+
**Default**: `"Tab"`
52+
53+
### Valid Keys
54+
55+
- `"Tab"` (default)
56+
- `"Enter"`
57+
- `"Space"`
58+
- Single characters: `"a"`, `"b"`, etc.
59+
60+
---
61+
62+
## chat.delegateModeKey
63+
64+
Key for delegate command.
65+
66+
### Overview
67+
68+
Sets the keyboard shortcut key for triggering delegate mode. Used with Ctrl (Ctrl+key) to delegate tasks to specialized agents or tools.
69+
70+
### Usage
71+
72+
```bash
73+
kiro-cli settings chat.delegateModeKey "d"
74+
```
75+
76+
**Type**: String (single character)
77+
**Default**: `"d"` (Ctrl+D)
78+
79+
---
80+
81+
## chat.enableDelegate
82+
83+
Enable delegate tool for task delegation.
84+
85+
### Overview
86+
87+
Controls whether to enable the delegate tool for delegating tasks to specialized agents or external systems. When enabled, allows breaking down complex tasks and routing them to appropriate handlers.
88+
89+
### Usage
90+
91+
```bash
92+
kiro-cli settings chat.enableDelegate true
93+
```
94+
95+
**Type**: Boolean
96+
**Default**: `false`
97+
98+
### Examples
99+
100+
```bash
101+
# Enable delegate tool
102+
kiro-cli settings chat.enableDelegate true
103+
104+
# Check status
105+
kiro-cli settings chat.enableDelegate
106+
107+
# Disable
108+
kiro-cli settings chat.enableDelegate false
109+
```

0 commit comments

Comments
 (0)