Skip to content

Commit c7cee1d

Browse files
author
Nitish [C] Dhok
committed
kiro-cli-docs :- updated kiro-cli docs and added missing commands.
1 parent 68b4bd7 commit c7cee1d

File tree

12 files changed

+658
-26
lines changed

12 files changed

+658
-26
lines changed
Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
---
2+
doc_meta:
3+
validated: 2025-12-19
4+
commit: 57090ffe
5+
status: validated
6+
testable_headless: false
7+
category: slash_command
8+
title: /agent create
9+
description: Create a new agent with the specified name
10+
keywords: [agent, create, new, configuration]
11+
related: [agent-switch, agent-list, agent-generate, cmd-agent, agent-config]
12+
---
13+
14+
# /agent create
15+
16+
Create a new agent with the specified name.
17+
18+
## Overview
19+
20+
The `/agent create` command creates a new agent configuration with the specified name, optionally using an existing agent as a template.
21+
22+
## Usage
23+
24+
```
25+
/agent create --name <NAME> [OPTIONS]
26+
```
27+
28+
## Options
29+
30+
- `-n, --name <NAME>` - Name of the agent to be created (required)
31+
- `-d, --directory <DIRECTORY>` - Directory where the agent will be saved (optional)
32+
- `-f, --from <FROM>` - Name of existing agent to use as template (optional)
33+
- `-h, --help` - Print help
34+
35+
## Examples
36+
37+
### Example 1: Basic Agent Creation
38+
39+
```
40+
/agent create --name my-agent
41+
```
42+
43+
Creates a new agent in the global agent directory.
44+
45+
### Example 2: Create in Specific Directory
46+
47+
```
48+
/agent create --name my-agent --directory ./custom-agents
49+
```
50+
51+
Creates agent in specified directory.
52+
53+
### Example 3: Create from Template
54+
55+
```
56+
/agent create --name my-agent --from python-dev
57+
```
58+
59+
Creates new agent using `python-dev` as template.
60+
61+
### Example 4: Full Options
62+
63+
```
64+
/agent create --name my-agent --directory ./.kiro/agents --from rust-expert
65+
```
66+
67+
Creates agent in local directory using template.
68+
69+
## Default Behavior
70+
71+
- **Directory**: If not specified, saves to global agent directory (`~/.kiro/agents/`)
72+
- **Template**: If not specified, creates basic agent configuration
73+
74+
## Related Commands
75+
76+
- [/agent list](agent-list.md) - List available agents
77+
- [/agent](agent-switch.md) - Switch to different agent
78+
- [/agent generate](agent-generate.md) - Generate agent with AI
79+
- [kiro-cli agent](../commands/agent.md) - CLI agent management
80+
81+
## Technical Details
82+
83+
**Storage**: Creates agent configuration file in specified or default directory.
84+
85+
**Template**: When using `--from`, copies configuration from existing agent as starting point.
Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
---
2+
doc_meta:
3+
validated: 2025-12-19
4+
commit: 57090ffe
5+
status: validated
6+
testable_headless: false
7+
category: slash_command
8+
title: /agent edit
9+
description: Edit an existing agent configuration
10+
keywords: [agent, edit, modify, configuration]
11+
related: [agent-switch, agent-list, agent-create, cmd-agent, agent-config]
12+
---
13+
14+
# /agent edit
15+
16+
Edit an existing agent configuration.
17+
18+
## Overview
19+
20+
The `/agent edit` command opens an existing agent configuration for editing, either by agent name or direct file path.
21+
22+
## Usage
23+
24+
```
25+
/agent edit [OPTIONS]
26+
```
27+
28+
## Options
29+
30+
- `-n, --name <NAME>` - Name of the agent to edit
31+
- `--path <PATH>` - Path to the agent config file to edit
32+
- `-h, --help` - Print help
33+
34+
## Examples
35+
36+
### Example 1: Edit by Name
37+
38+
```
39+
/agent edit --name python-dev
40+
```
41+
42+
Opens the `python-dev` agent configuration for editing.
43+
44+
### Example 2: Edit by Path
45+
46+
```
47+
/agent edit --path ~/.kiro/agents/my-agent.toml
48+
```
49+
50+
Opens the agent configuration file at the specified path.
51+
52+
### Example 3: Interactive Selection
53+
54+
```
55+
/agent edit
56+
```
57+
58+
Shows picker to select agent to edit (if no options provided).
59+
60+
## Agent Resolution
61+
62+
When using `--name`:
63+
1. **Local**: `.kiro/agents/` in current directory
64+
2. **Global**: `~/.kiro/agents/` in home directory
65+
3. **Built-in**: Default agents (read-only)
66+
67+
## Editor Behavior
68+
69+
- Opens configuration file in default system editor
70+
- Changes are saved automatically when editor closes
71+
- Built-in agents cannot be modified
72+
73+
## Related Commands
74+
75+
- [/agent list](agent-list.md) - List available agents
76+
- [/agent create](agent-create.md) - Create new agent
77+
- [/agent](agent-switch.md) - Switch to different agent
78+
- [kiro-cli agent](../commands/agent.md) - CLI agent management
79+
80+
## Technical Details
81+
82+
**File Format**: Agent configurations are typically TOML files.
83+
84+
**Editor**: Uses system default editor or `$EDITOR` environment variable.
Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
---
2+
doc_meta:
3+
validated: 2025-12-19
4+
commit: 57090ffe
5+
status: validated
6+
testable_headless: false
7+
category: slash_command
8+
title: /agent list
9+
description: List all available agents
10+
keywords: [agent, list, available, show]
11+
related: [agent-switch, agent-generate, cmd-agent, agent-config]
12+
---
13+
14+
# /agent list
15+
16+
List all available agents.
17+
18+
## Overview
19+
20+
The `/agent list` command displays all available agent configurations with their paths and marks the currently active agent.
21+
22+
## Usage
23+
24+
```
25+
/agent list
26+
```
27+
28+
## Options
29+
30+
- `-h, --help` - Print help
31+
32+
## Examples
33+
34+
### Example 1: Basic List
35+
36+
```
37+
/agent list
38+
```
39+
40+
**Output**:
41+
```
42+
* rust-expert ~/.kiro/agents
43+
python-dev ~/.kiro/agents
44+
default (Built-in)
45+
```
46+
47+
The `*` indicates the currently active agent.
48+
49+
## Output Format
50+
51+
- **Active Agent**: Marked with `*` prefix
52+
- **Agent Name**: Configuration name
53+
- **Path**: Location of agent configuration
54+
- `~/.kiro/agents/` - Global agents
55+
- `.kiro/agents/` - Local agents
56+
- `(Built-in)` - Default system agents
57+
58+
## Agent Resolution Order
59+
60+
Agents are discovered from:
61+
1. **Local**: `.kiro/agents/` in current directory
62+
2. **Global**: `~/.kiro/agents/` in home directory
63+
3. **Built-in**: Default system agents
64+
65+
## Related Commands
66+
67+
- [/agent](agent-switch.md) - Switch to different agent
68+
- [/agent generate](agent-generate.md) - Generate new agent
69+
- [kiro-cli agent](../commands/agent.md) - CLI agent management
70+
71+
## Technical Details
72+
73+
**Discovery**: Scans agent directories in resolution order and includes built-in agents.
74+
75+
**Active Detection**: Compares current session agent with discovered agents to mark active status.
Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
---
2+
doc_meta:
3+
validated: 2025-12-19
4+
commit: 57090ffe
5+
status: validated
6+
testable_headless: false
7+
category: slash_command
8+
title: /agent schema
9+
description: Show agent config schema
10+
keywords: [agent, schema, configuration, format]
11+
related: [agent-switch, agent-list, agent-create, agent-edit, agent-config]
12+
---
13+
14+
# /agent schema
15+
16+
Show agent config schema.
17+
18+
## Overview
19+
20+
The `/agent schema` command displays the configuration schema for agent files, showing the structure and available fields.
21+
22+
## Usage
23+
24+
```
25+
/agent schema
26+
```
27+
28+
## Options
29+
30+
- `-h, --help` - Print help
31+
32+
## Examples
33+
34+
### Example 1: Display Schema
35+
36+
```
37+
/agent schema
38+
```
39+
40+
**Output**:
41+
```toml
42+
[agent]
43+
name = "string"
44+
description = "string"
45+
version = "string"
46+
47+
[agent.system]
48+
prompt = "string"
49+
temperature = 0.7
50+
max_tokens = 4096
51+
52+
[agent.tools]
53+
enabled = ["tool1", "tool2"]
54+
disabled = ["tool3"]
55+
56+
[agent.mcp]
57+
servers = ["server1", "server2"]
58+
```
59+
60+
## Schema Sections
61+
62+
- **agent** - Basic agent metadata
63+
- **agent.system** - System prompt and model parameters
64+
- **agent.tools** - Tool configuration and permissions
65+
- **agent.mcp** - MCP server configuration
66+
67+
## Use Cases
68+
69+
- Reference when creating new agents
70+
- Validate existing agent configurations
71+
- Understand available configuration options
72+
- Template for manual agent creation
73+
74+
## Related Commands
75+
76+
- [/agent create](agent-create.md) - Create new agent
77+
- [/agent edit](agent-edit.md) - Edit existing agent
78+
- [/agent list](agent-list.md) - List available agents
79+
- [kiro-cli agent](../commands/agent.md) - CLI agent management
80+
81+
## Technical Details
82+
83+
**Format**: Displays TOML schema with field types and example values.
84+
85+
**Validation**: Use schema to ensure agent configurations are properly formatted.

0 commit comments

Comments
 (0)