kiro-kit 0.2.1 → 0.2.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.js +30 -12
- package/dist/index.js.map +1 -1
- package/dist/presets/backend/manifest.json +25 -35
- package/dist/presets/backend/skills/kiro/references/autonomy-modes.md +26 -0
- package/dist/presets/backend/skills/kiro/references/best-practices.md +48 -0
- package/dist/presets/backend/skills/kiro/references/commands.md +61 -0
- package/dist/presets/backend/skills/kiro/references/configuration.md +41 -0
- package/dist/presets/backend/skills/kiro/references/getting-started.md +45 -0
- package/dist/presets/backend/skills/kiro/references/hooks.md +99 -0
- package/dist/presets/backend/skills/kiro/references/mcp-integration.md +53 -0
- package/dist/presets/backend/skills/kiro/references/skills.md +55 -0
- package/dist/presets/backend/skills/kiro/references/specs-workflow.md +62 -0
- package/dist/presets/backend/skills/kiro/references/steering-files.md +84 -0
- package/dist/presets/backend/skills/kiro/references/troubleshooting.md +42 -0
- package/dist/presets/backend/skills/kiro/skill.md +194 -0
- package/dist/presets/data-ai/manifest.json +25 -35
- package/dist/presets/data-ai/skills/kiro/references/autonomy-modes.md +26 -0
- package/dist/presets/data-ai/skills/kiro/references/best-practices.md +48 -0
- package/dist/presets/data-ai/skills/kiro/references/commands.md +61 -0
- package/dist/presets/data-ai/skills/kiro/references/configuration.md +41 -0
- package/dist/presets/data-ai/skills/kiro/references/getting-started.md +45 -0
- package/dist/presets/data-ai/skills/kiro/references/hooks.md +99 -0
- package/dist/presets/data-ai/skills/kiro/references/mcp-integration.md +53 -0
- package/dist/presets/data-ai/skills/kiro/references/skills.md +55 -0
- package/dist/presets/data-ai/skills/kiro/references/specs-workflow.md +62 -0
- package/dist/presets/data-ai/skills/kiro/references/steering-files.md +84 -0
- package/dist/presets/data-ai/skills/kiro/references/troubleshooting.md +42 -0
- package/dist/presets/data-ai/skills/kiro/skill.md +194 -0
- package/dist/presets/devops/manifest.json +25 -35
- package/dist/presets/devops/skills/kiro/references/autonomy-modes.md +26 -0
- package/dist/presets/devops/skills/kiro/references/best-practices.md +48 -0
- package/dist/presets/devops/skills/kiro/references/commands.md +61 -0
- package/dist/presets/devops/skills/kiro/references/configuration.md +41 -0
- package/dist/presets/devops/skills/kiro/references/getting-started.md +45 -0
- package/dist/presets/devops/skills/kiro/references/hooks.md +99 -0
- package/dist/presets/devops/skills/kiro/references/mcp-integration.md +53 -0
- package/dist/presets/devops/skills/kiro/references/skills.md +55 -0
- package/dist/presets/devops/skills/kiro/references/specs-workflow.md +62 -0
- package/dist/presets/devops/skills/kiro/references/steering-files.md +84 -0
- package/dist/presets/devops/skills/kiro/references/troubleshooting.md +42 -0
- package/dist/presets/devops/skills/kiro/skill.md +194 -0
- package/dist/presets/frontend/commands/test.md +1 -1
- package/dist/presets/frontend/manifest.json +25 -35
- package/dist/presets/frontend/skills/kiro/references/autonomy-modes.md +26 -0
- package/dist/presets/frontend/skills/kiro/references/best-practices.md +48 -0
- package/dist/presets/frontend/skills/kiro/references/commands.md +61 -0
- package/dist/presets/frontend/skills/kiro/references/configuration.md +41 -0
- package/dist/presets/frontend/skills/kiro/references/getting-started.md +45 -0
- package/dist/presets/frontend/skills/kiro/references/hooks.md +99 -0
- package/dist/presets/frontend/skills/kiro/references/mcp-integration.md +53 -0
- package/dist/presets/frontend/skills/kiro/references/skills.md +55 -0
- package/dist/presets/frontend/skills/kiro/references/specs-workflow.md +62 -0
- package/dist/presets/frontend/skills/kiro/references/steering-files.md +84 -0
- package/dist/presets/frontend/skills/kiro/references/troubleshooting.md +42 -0
- package/dist/presets/frontend/skills/kiro/skill.md +194 -0
- package/dist/presets/fullstack/manifest.json +25 -35
- package/dist/presets/fullstack/skills/kiro/references/autonomy-modes.md +26 -0
- package/dist/presets/fullstack/skills/kiro/references/best-practices.md +48 -0
- package/dist/presets/fullstack/skills/kiro/references/commands.md +61 -0
- package/dist/presets/fullstack/skills/kiro/references/configuration.md +41 -0
- package/dist/presets/fullstack/skills/kiro/references/getting-started.md +45 -0
- package/dist/presets/fullstack/skills/kiro/references/hooks.md +99 -0
- package/dist/presets/fullstack/skills/kiro/references/mcp-integration.md +53 -0
- package/dist/presets/fullstack/skills/kiro/references/skills.md +55 -0
- package/dist/presets/fullstack/skills/kiro/references/specs-workflow.md +62 -0
- package/dist/presets/fullstack/skills/kiro/references/steering-files.md +84 -0
- package/dist/presets/fullstack/skills/kiro/references/troubleshooting.md +42 -0
- package/dist/presets/fullstack/skills/kiro/skill.md +194 -0
- package/dist/presets/mobile/manifest.json +25 -35
- package/dist/presets/mobile/skills/kiro/references/autonomy-modes.md +26 -0
- package/dist/presets/mobile/skills/kiro/references/best-practices.md +48 -0
- package/dist/presets/mobile/skills/kiro/references/commands.md +61 -0
- package/dist/presets/mobile/skills/kiro/references/configuration.md +41 -0
- package/dist/presets/mobile/skills/kiro/references/getting-started.md +45 -0
- package/dist/presets/mobile/skills/kiro/references/hooks.md +99 -0
- package/dist/presets/mobile/skills/kiro/references/mcp-integration.md +53 -0
- package/dist/presets/mobile/skills/kiro/references/skills.md +55 -0
- package/dist/presets/mobile/skills/kiro/references/specs-workflow.md +62 -0
- package/dist/presets/mobile/skills/kiro/references/steering-files.md +84 -0
- package/dist/presets/mobile/skills/kiro/references/troubleshooting.md +42 -0
- package/dist/presets/mobile/skills/kiro/skill.md +194 -0
- package/package.json +1 -1
- package/dist/presets/backend/skills/claude-code/references/advanced-features.md +0 -399
- package/dist/presets/backend/skills/claude-code/references/agent-skills.md +0 -399
- package/dist/presets/backend/skills/claude-code/references/api-reference.md +0 -498
- package/dist/presets/backend/skills/claude-code/references/best-practices.md +0 -447
- package/dist/presets/backend/skills/claude-code/references/cicd-integration.md +0 -428
- package/dist/presets/backend/skills/claude-code/references/configuration.md +0 -480
- package/dist/presets/backend/skills/claude-code/references/enterprise-features.md +0 -472
- package/dist/presets/backend/skills/claude-code/references/getting-started.md +0 -252
- package/dist/presets/backend/skills/claude-code/references/hooks-and-plugins.md +0 -441
- package/dist/presets/backend/skills/claude-code/references/ide-integration.md +0 -316
- package/dist/presets/backend/skills/claude-code/references/mcp-integration.md +0 -386
- package/dist/presets/backend/skills/claude-code/references/slash-commands.md +0 -489
- package/dist/presets/backend/skills/claude-code/references/troubleshooting.md +0 -456
- package/dist/presets/backend/skills/claude-code/skill.md +0 -194
- package/dist/presets/data-ai/skills/claude-code/references/advanced-features.md +0 -399
- package/dist/presets/data-ai/skills/claude-code/references/agent-skills.md +0 -399
- package/dist/presets/data-ai/skills/claude-code/references/api-reference.md +0 -498
- package/dist/presets/data-ai/skills/claude-code/references/best-practices.md +0 -447
- package/dist/presets/data-ai/skills/claude-code/references/cicd-integration.md +0 -428
- package/dist/presets/data-ai/skills/claude-code/references/configuration.md +0 -480
- package/dist/presets/data-ai/skills/claude-code/references/enterprise-features.md +0 -472
- package/dist/presets/data-ai/skills/claude-code/references/getting-started.md +0 -252
- package/dist/presets/data-ai/skills/claude-code/references/hooks-and-plugins.md +0 -441
- package/dist/presets/data-ai/skills/claude-code/references/ide-integration.md +0 -316
- package/dist/presets/data-ai/skills/claude-code/references/mcp-integration.md +0 -386
- package/dist/presets/data-ai/skills/claude-code/references/slash-commands.md +0 -489
- package/dist/presets/data-ai/skills/claude-code/references/troubleshooting.md +0 -456
- package/dist/presets/data-ai/skills/claude-code/skill.md +0 -194
- package/dist/presets/devops/skills/claude-code/references/advanced-features.md +0 -399
- package/dist/presets/devops/skills/claude-code/references/agent-skills.md +0 -399
- package/dist/presets/devops/skills/claude-code/references/api-reference.md +0 -498
- package/dist/presets/devops/skills/claude-code/references/best-practices.md +0 -447
- package/dist/presets/devops/skills/claude-code/references/cicd-integration.md +0 -428
- package/dist/presets/devops/skills/claude-code/references/configuration.md +0 -480
- package/dist/presets/devops/skills/claude-code/references/enterprise-features.md +0 -472
- package/dist/presets/devops/skills/claude-code/references/getting-started.md +0 -252
- package/dist/presets/devops/skills/claude-code/references/hooks-and-plugins.md +0 -441
- package/dist/presets/devops/skills/claude-code/references/ide-integration.md +0 -316
- package/dist/presets/devops/skills/claude-code/references/mcp-integration.md +0 -386
- package/dist/presets/devops/skills/claude-code/references/slash-commands.md +0 -489
- package/dist/presets/devops/skills/claude-code/references/troubleshooting.md +0 -456
- package/dist/presets/devops/skills/claude-code/skill.md +0 -194
- package/dist/presets/frontend/skills/claude-code/references/advanced-features.md +0 -399
- package/dist/presets/frontend/skills/claude-code/references/agent-skills.md +0 -399
- package/dist/presets/frontend/skills/claude-code/references/api-reference.md +0 -498
- package/dist/presets/frontend/skills/claude-code/references/best-practices.md +0 -447
- package/dist/presets/frontend/skills/claude-code/references/cicd-integration.md +0 -428
- package/dist/presets/frontend/skills/claude-code/references/configuration.md +0 -480
- package/dist/presets/frontend/skills/claude-code/references/enterprise-features.md +0 -472
- package/dist/presets/frontend/skills/claude-code/references/getting-started.md +0 -252
- package/dist/presets/frontend/skills/claude-code/references/hooks-and-plugins.md +0 -441
- package/dist/presets/frontend/skills/claude-code/references/ide-integration.md +0 -316
- package/dist/presets/frontend/skills/claude-code/references/mcp-integration.md +0 -386
- package/dist/presets/frontend/skills/claude-code/references/slash-commands.md +0 -489
- package/dist/presets/frontend/skills/claude-code/references/troubleshooting.md +0 -456
- package/dist/presets/frontend/skills/claude-code/skill.md +0 -194
- package/dist/presets/fullstack/skills/claude-code/references/advanced-features.md +0 -399
- package/dist/presets/fullstack/skills/claude-code/references/agent-skills.md +0 -399
- package/dist/presets/fullstack/skills/claude-code/references/api-reference.md +0 -498
- package/dist/presets/fullstack/skills/claude-code/references/best-practices.md +0 -447
- package/dist/presets/fullstack/skills/claude-code/references/cicd-integration.md +0 -428
- package/dist/presets/fullstack/skills/claude-code/references/configuration.md +0 -480
- package/dist/presets/fullstack/skills/claude-code/references/enterprise-features.md +0 -472
- package/dist/presets/fullstack/skills/claude-code/references/getting-started.md +0 -252
- package/dist/presets/fullstack/skills/claude-code/references/hooks-and-plugins.md +0 -441
- package/dist/presets/fullstack/skills/claude-code/references/ide-integration.md +0 -316
- package/dist/presets/fullstack/skills/claude-code/references/mcp-integration.md +0 -386
- package/dist/presets/fullstack/skills/claude-code/references/slash-commands.md +0 -489
- package/dist/presets/fullstack/skills/claude-code/references/troubleshooting.md +0 -456
- package/dist/presets/fullstack/skills/claude-code/skill.md +0 -194
- package/dist/presets/mobile/skills/claude-code/references/advanced-features.md +0 -399
- package/dist/presets/mobile/skills/claude-code/references/agent-skills.md +0 -399
- package/dist/presets/mobile/skills/claude-code/references/api-reference.md +0 -498
- package/dist/presets/mobile/skills/claude-code/references/best-practices.md +0 -447
- package/dist/presets/mobile/skills/claude-code/references/cicd-integration.md +0 -428
- package/dist/presets/mobile/skills/claude-code/references/configuration.md +0 -480
- package/dist/presets/mobile/skills/claude-code/references/enterprise-features.md +0 -472
- package/dist/presets/mobile/skills/claude-code/references/getting-started.md +0 -252
- package/dist/presets/mobile/skills/claude-code/references/hooks-and-plugins.md +0 -441
- package/dist/presets/mobile/skills/claude-code/references/ide-integration.md +0 -316
- package/dist/presets/mobile/skills/claude-code/references/mcp-integration.md +0 -386
- package/dist/presets/mobile/skills/claude-code/references/slash-commands.md +0 -489
- package/dist/presets/mobile/skills/claude-code/references/troubleshooting.md +0 -456
- package/dist/presets/mobile/skills/claude-code/skill.md +0 -194
|
@@ -839,73 +839,63 @@
|
|
|
839
839
|
"type": "other"
|
|
840
840
|
},
|
|
841
841
|
{
|
|
842
|
-
"source": "skills/
|
|
843
|
-
"target": ".kiro/skills/
|
|
844
|
-
"type": "
|
|
845
|
-
},
|
|
846
|
-
{
|
|
847
|
-
"source": "skills/claude-code/references/agent-skills.md",
|
|
848
|
-
"target": ".kiro/skills/claude-code/references/agent-skills.md",
|
|
849
|
-
"type": "doc"
|
|
850
|
-
},
|
|
851
|
-
{
|
|
852
|
-
"source": "skills/claude-code/references/api-reference.md",
|
|
853
|
-
"target": ".kiro/skills/claude-code/references/api-reference.md",
|
|
854
|
-
"type": "doc"
|
|
842
|
+
"source": "skills/kiro/skill.md",
|
|
843
|
+
"target": ".kiro/skills/kiro/skill.md",
|
|
844
|
+
"type": "skill"
|
|
855
845
|
},
|
|
856
846
|
{
|
|
857
|
-
"source": "skills/
|
|
858
|
-
"target": ".kiro/skills/
|
|
847
|
+
"source": "skills/kiro/references/autonomy-modes.md",
|
|
848
|
+
"target": ".kiro/skills/kiro/references/autonomy-modes.md",
|
|
859
849
|
"type": "doc"
|
|
860
850
|
},
|
|
861
851
|
{
|
|
862
|
-
"source": "skills/
|
|
863
|
-
"target": ".kiro/skills/
|
|
852
|
+
"source": "skills/kiro/references/best-practices.md",
|
|
853
|
+
"target": ".kiro/skills/kiro/references/best-practices.md",
|
|
864
854
|
"type": "doc"
|
|
865
855
|
},
|
|
866
856
|
{
|
|
867
|
-
"source": "skills/
|
|
868
|
-
"target": ".kiro/skills/
|
|
857
|
+
"source": "skills/kiro/references/commands.md",
|
|
858
|
+
"target": ".kiro/skills/kiro/references/commands.md",
|
|
869
859
|
"type": "doc"
|
|
870
860
|
},
|
|
871
861
|
{
|
|
872
|
-
"source": "skills/
|
|
873
|
-
"target": ".kiro/skills/
|
|
862
|
+
"source": "skills/kiro/references/configuration.md",
|
|
863
|
+
"target": ".kiro/skills/kiro/references/configuration.md",
|
|
874
864
|
"type": "doc"
|
|
875
865
|
},
|
|
876
866
|
{
|
|
877
|
-
"source": "skills/
|
|
878
|
-
"target": ".kiro/skills/
|
|
867
|
+
"source": "skills/kiro/references/getting-started.md",
|
|
868
|
+
"target": ".kiro/skills/kiro/references/getting-started.md",
|
|
879
869
|
"type": "doc"
|
|
880
870
|
},
|
|
881
871
|
{
|
|
882
|
-
"source": "skills/
|
|
883
|
-
"target": ".kiro/skills/
|
|
872
|
+
"source": "skills/kiro/references/hooks.md",
|
|
873
|
+
"target": ".kiro/skills/kiro/references/hooks.md",
|
|
884
874
|
"type": "doc"
|
|
885
875
|
},
|
|
886
876
|
{
|
|
887
|
-
"source": "skills/
|
|
888
|
-
"target": ".kiro/skills/
|
|
877
|
+
"source": "skills/kiro/references/mcp-integration.md",
|
|
878
|
+
"target": ".kiro/skills/kiro/references/mcp-integration.md",
|
|
889
879
|
"type": "doc"
|
|
890
880
|
},
|
|
891
881
|
{
|
|
892
|
-
"source": "skills/
|
|
893
|
-
"target": ".kiro/skills/
|
|
882
|
+
"source": "skills/kiro/references/skills.md",
|
|
883
|
+
"target": ".kiro/skills/kiro/references/skills.md",
|
|
894
884
|
"type": "doc"
|
|
895
885
|
},
|
|
896
886
|
{
|
|
897
|
-
"source": "skills/
|
|
898
|
-
"target": ".kiro/skills/
|
|
887
|
+
"source": "skills/kiro/references/specs-workflow.md",
|
|
888
|
+
"target": ".kiro/skills/kiro/references/specs-workflow.md",
|
|
899
889
|
"type": "doc"
|
|
900
890
|
},
|
|
901
891
|
{
|
|
902
|
-
"source": "skills/
|
|
903
|
-
"target": ".kiro/skills/
|
|
892
|
+
"source": "skills/kiro/references/steering-files.md",
|
|
893
|
+
"target": ".kiro/skills/kiro/references/steering-files.md",
|
|
904
894
|
"type": "doc"
|
|
905
895
|
},
|
|
906
896
|
{
|
|
907
|
-
"source": "skills/
|
|
908
|
-
"target": ".kiro/skills/
|
|
897
|
+
"source": "skills/kiro/references/troubleshooting.md",
|
|
898
|
+
"target": ".kiro/skills/kiro/references/troubleshooting.md",
|
|
909
899
|
"type": "doc"
|
|
910
900
|
},
|
|
911
901
|
{
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Autonomy Modes
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
|
|
5
|
+
Kiro offers two modes for how the AI agent interacts with your workspace.
|
|
6
|
+
|
|
7
|
+
## Autopilot Mode
|
|
8
|
+
|
|
9
|
+
- Agent modifies files autonomously within the workspace
|
|
10
|
+
- Best for: routine tasks, well-defined changes, trusted workflows
|
|
11
|
+
- Changes are applied immediately
|
|
12
|
+
- Use when you trust the agent's judgment for the task
|
|
13
|
+
|
|
14
|
+
## Supervised Mode
|
|
15
|
+
|
|
16
|
+
- User has opportunity to review and revert changes after application
|
|
17
|
+
- Best for: complex refactors, unfamiliar codebases, learning
|
|
18
|
+
- Changes can be inspected before accepting
|
|
19
|
+
- Use when you want more control over modifications
|
|
20
|
+
|
|
21
|
+
## Choosing a Mode
|
|
22
|
+
|
|
23
|
+
- Start with Supervised for new projects or unfamiliar tasks
|
|
24
|
+
- Switch to Autopilot for repetitive, well-understood operations
|
|
25
|
+
- Use Supervised for security-sensitive changes
|
|
26
|
+
- Autopilot works well for spec task execution
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
# Best Practices
|
|
2
|
+
|
|
3
|
+
## Project Organization
|
|
4
|
+
|
|
5
|
+
- Keep `.kiro/` directory in version control
|
|
6
|
+
- Use consistent naming (kebab-case for directories)
|
|
7
|
+
- Document custom skills and commands in project README
|
|
8
|
+
- Share steering files across team via git
|
|
9
|
+
|
|
10
|
+
## Steering Conventions
|
|
11
|
+
|
|
12
|
+
- One topic per steering file
|
|
13
|
+
- Use "always" only for critical, universal rules
|
|
14
|
+
- Use "fileMatch" for language/framework-specific guidance
|
|
15
|
+
- Keep files concise (under 100 lines ideally)
|
|
16
|
+
- Include examples in steering content
|
|
17
|
+
|
|
18
|
+
## Skill Design
|
|
19
|
+
|
|
20
|
+
- Focus each skill on one domain
|
|
21
|
+
- Write clear activation descriptions
|
|
22
|
+
- Use references for detailed content
|
|
23
|
+
- Keep main skill.md as an overview/router
|
|
24
|
+
- Test activation with various phrasings
|
|
25
|
+
|
|
26
|
+
## Hook Patterns
|
|
27
|
+
|
|
28
|
+
- Use file hooks for linting and formatting
|
|
29
|
+
- Use postTaskExecution for test validation
|
|
30
|
+
- Use preToolUse for access control
|
|
31
|
+
- Keep hook commands fast (under 30 seconds)
|
|
32
|
+
- Log hook failures for debugging
|
|
33
|
+
|
|
34
|
+
## Team Workflows
|
|
35
|
+
|
|
36
|
+
- Standardize steering files across projects
|
|
37
|
+
- Share skills via presets or git submodules
|
|
38
|
+
- Document MCP server requirements in README
|
|
39
|
+
- Use specs for all non-trivial features
|
|
40
|
+
- Review spec documents before task execution
|
|
41
|
+
|
|
42
|
+
## Cost Management
|
|
43
|
+
|
|
44
|
+
- Use steering to keep responses focused
|
|
45
|
+
- Avoid overly broad "always" steering
|
|
46
|
+
- Disable unused MCP servers
|
|
47
|
+
- Use Supervised mode for exploratory work
|
|
48
|
+
- Keep skill references concise
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
# Commands
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
|
|
5
|
+
Commands are user-defined operations in `.kiro/commands/` that expand to prompts. They provide shortcuts for common workflows.
|
|
6
|
+
|
|
7
|
+
## File Format
|
|
8
|
+
|
|
9
|
+
```markdown
|
|
10
|
+
---
|
|
11
|
+
description: Brief description of what this command does
|
|
12
|
+
inclusion: manual
|
|
13
|
+
argument-hint: "[pattern]"
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
## Arguments
|
|
17
|
+
PATTERN: $1 (default: all)
|
|
18
|
+
|
|
19
|
+
## Workflow
|
|
20
|
+
1. Step one
|
|
21
|
+
2. Step two
|
|
22
|
+
3. Step three
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## Front-Matter
|
|
26
|
+
|
|
27
|
+
Required fields:
|
|
28
|
+
- `description`: What the command does
|
|
29
|
+
|
|
30
|
+
Optional fields:
|
|
31
|
+
- `inclusion`: "manual" (default)
|
|
32
|
+
- `argument-hint`: Hint for arguments shown to user
|
|
33
|
+
|
|
34
|
+
## Arguments
|
|
35
|
+
|
|
36
|
+
Use `$1`, `$2`, etc. for positional arguments passed by the user.
|
|
37
|
+
|
|
38
|
+
## Nested Commands
|
|
39
|
+
|
|
40
|
+
Commands can be organized in subdirectories:
|
|
41
|
+
```
|
|
42
|
+
.kiro/commands/
|
|
43
|
+
test.md
|
|
44
|
+
fix/
|
|
45
|
+
types.md
|
|
46
|
+
test.md
|
|
47
|
+
fast.md
|
|
48
|
+
git/
|
|
49
|
+
cm.md
|
|
50
|
+
cp.md
|
|
51
|
+
pr.md
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
Access nested commands with colon notation: `/fix:types`, `/git:cm`
|
|
55
|
+
|
|
56
|
+
## Best Practices
|
|
57
|
+
|
|
58
|
+
- Keep commands focused on one workflow
|
|
59
|
+
- Include clear step-by-step instructions
|
|
60
|
+
- Use argument hints to guide users
|
|
61
|
+
- Document default behavior when no arguments provided
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# Configuration
|
|
2
|
+
|
|
3
|
+
## Settings Hierarchy
|
|
4
|
+
|
|
5
|
+
Settings are merged with precedence:
|
|
6
|
+
1. User-level: `~/.kiro/settings/mcp.json` (global)
|
|
7
|
+
2. Workspace-level: `.kiro/settings/mcp.json` (per project)
|
|
8
|
+
|
|
9
|
+
Workspace settings override user settings.
|
|
10
|
+
|
|
11
|
+
## MCP Configuration
|
|
12
|
+
|
|
13
|
+
File: `.kiro/settings/mcp.json`
|
|
14
|
+
|
|
15
|
+
```json
|
|
16
|
+
{
|
|
17
|
+
"mcpServers": {
|
|
18
|
+
"server-name": {
|
|
19
|
+
"command": "uvx",
|
|
20
|
+
"args": ["package-name@latest"],
|
|
21
|
+
"env": {
|
|
22
|
+
"API_KEY": "your-key"
|
|
23
|
+
},
|
|
24
|
+
"disabled": false,
|
|
25
|
+
"autoApprove": ["tool-name"]
|
|
26
|
+
}
|
|
27
|
+
}
|
|
28
|
+
}
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
## Key Settings
|
|
32
|
+
|
|
33
|
+
- `command`: Executable to run the MCP server
|
|
34
|
+
- `args`: Command-line arguments
|
|
35
|
+
- `env`: Environment variables passed to the server
|
|
36
|
+
- `disabled`: Enable/disable without removing config
|
|
37
|
+
- `autoApprove`: Tools that don't require user confirmation
|
|
38
|
+
|
|
39
|
+
## Multi-Root Workspaces
|
|
40
|
+
|
|
41
|
+
Each workspace folder can have its own `.kiro/settings/mcp.json`. Configs merge with later folders taking precedence.
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# Getting Started with Kiro
|
|
2
|
+
|
|
3
|
+
## Prerequisites
|
|
4
|
+
|
|
5
|
+
- Supported OS: Windows, macOS, Linux
|
|
6
|
+
- Internet connection for AI features
|
|
7
|
+
|
|
8
|
+
## Installation
|
|
9
|
+
|
|
10
|
+
Download Kiro from https://kiro.dev and install for your platform.
|
|
11
|
+
|
|
12
|
+
## First Run
|
|
13
|
+
|
|
14
|
+
1. Open Kiro
|
|
15
|
+
2. Open or create a workspace folder
|
|
16
|
+
3. Start chatting with the AI agent in the chat panel
|
|
17
|
+
|
|
18
|
+
## Workspace Setup
|
|
19
|
+
|
|
20
|
+
Kiro stores configuration in `.kiro/` at the workspace root:
|
|
21
|
+
|
|
22
|
+
```
|
|
23
|
+
.kiro/
|
|
24
|
+
settings/
|
|
25
|
+
mcp.json # MCP server configuration
|
|
26
|
+
steering/ # Steering files (conventions, rules)
|
|
27
|
+
skills/ # Custom skills
|
|
28
|
+
commands/ # Custom commands
|
|
29
|
+
hooks/ # Agent hooks
|
|
30
|
+
specs/ # Feature specs
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## Authentication
|
|
34
|
+
|
|
35
|
+
- Sign in with your AWS account or supported identity provider
|
|
36
|
+
- API keys are managed automatically by the IDE
|
|
37
|
+
|
|
38
|
+
## Key Concepts
|
|
39
|
+
|
|
40
|
+
- **Chat**: Interact with the AI agent directly
|
|
41
|
+
- **Specs**: Structured feature development (requirements -> design -> tasks)
|
|
42
|
+
- **Steering**: Project-level instructions that guide the AI
|
|
43
|
+
- **Skills**: Modular capabilities activated by context
|
|
44
|
+
- **Hooks**: Automated actions on IDE events
|
|
45
|
+
- **MCP**: External tool integrations
|
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
# Hooks
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
|
|
5
|
+
Hooks automate agent actions based on IDE events. When an event occurs, the specified action runs automatically.
|
|
6
|
+
|
|
7
|
+
## Event Types
|
|
8
|
+
|
|
9
|
+
- `fileEdited`: When a user saves a code file
|
|
10
|
+
- `fileCreated`: When a user creates a new file
|
|
11
|
+
- `fileDeleted`: When the user deletes a file
|
|
12
|
+
- `userTriggered`: Manual trigger by user
|
|
13
|
+
- `promptSubmit`: When a message is sent to the agent
|
|
14
|
+
- `agentStop`: When an agent execution completes
|
|
15
|
+
- `preToolUse`: Before a tool is executed
|
|
16
|
+
- `postToolUse`: After a tool is executed
|
|
17
|
+
- `preTaskExecution`: Before a spec task starts
|
|
18
|
+
- `postTaskExecution`: After a spec task completes
|
|
19
|
+
|
|
20
|
+
## Actions
|
|
21
|
+
|
|
22
|
+
- `askAgent`: Send a prompt to the agent
|
|
23
|
+
- `runCommand`: Execute a shell command
|
|
24
|
+
|
|
25
|
+
## Hook Schema
|
|
26
|
+
|
|
27
|
+
```json
|
|
28
|
+
{
|
|
29
|
+
"name": "Hook Name",
|
|
30
|
+
"version": "1.0.0",
|
|
31
|
+
"description": "Optional description",
|
|
32
|
+
"when": {
|
|
33
|
+
"type": "fileEdited",
|
|
34
|
+
"patterns": ["*.ts", "*.tsx"]
|
|
35
|
+
},
|
|
36
|
+
"then": {
|
|
37
|
+
"type": "runCommand",
|
|
38
|
+
"command": "npm run lint"
|
|
39
|
+
}
|
|
40
|
+
}
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
## File Events
|
|
44
|
+
|
|
45
|
+
Require `patterns` array with glob patterns:
|
|
46
|
+
```json
|
|
47
|
+
{
|
|
48
|
+
"when": {
|
|
49
|
+
"type": "fileEdited",
|
|
50
|
+
"patterns": ["*.ts", "*.tsx"]
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
## Tool Events
|
|
56
|
+
|
|
57
|
+
Require `toolTypes` array with categories or regex:
|
|
58
|
+
```json
|
|
59
|
+
{
|
|
60
|
+
"when": {
|
|
61
|
+
"type": "preToolUse",
|
|
62
|
+
"toolTypes": ["write"]
|
|
63
|
+
}
|
|
64
|
+
}
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
Valid categories: `read`, `write`, `shell`, `web`, `spec`, `*`
|
|
68
|
+
|
|
69
|
+
## Examples
|
|
70
|
+
|
|
71
|
+
### Lint on Save
|
|
72
|
+
```json
|
|
73
|
+
{
|
|
74
|
+
"name": "Lint on Save",
|
|
75
|
+
"version": "1.0.0",
|
|
76
|
+
"when": { "type": "fileEdited", "patterns": ["*.ts"] },
|
|
77
|
+
"then": { "type": "runCommand", "command": "npm run lint" }
|
|
78
|
+
}
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
### Run Tests After Task
|
|
82
|
+
```json
|
|
83
|
+
{
|
|
84
|
+
"name": "Test After Task",
|
|
85
|
+
"version": "1.0.0",
|
|
86
|
+
"when": { "type": "postTaskExecution" },
|
|
87
|
+
"then": { "type": "runCommand", "command": "npm test" }
|
|
88
|
+
}
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
### Review Writes
|
|
92
|
+
```json
|
|
93
|
+
{
|
|
94
|
+
"name": "Review Writes",
|
|
95
|
+
"version": "1.0.0",
|
|
96
|
+
"when": { "type": "preToolUse", "toolTypes": ["write"] },
|
|
97
|
+
"then": { "type": "askAgent", "prompt": "Verify this follows coding standards" }
|
|
98
|
+
}
|
|
99
|
+
```
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
# MCP Integration
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
|
|
5
|
+
Model Context Protocol (MCP) connects external tools and services to Kiro. Servers provide tools that the AI agent can invoke.
|
|
6
|
+
|
|
7
|
+
## Configuration
|
|
8
|
+
|
|
9
|
+
File: `.kiro/settings/mcp.json`
|
|
10
|
+
|
|
11
|
+
```json
|
|
12
|
+
{
|
|
13
|
+
"mcpServers": {
|
|
14
|
+
"server-name": {
|
|
15
|
+
"command": "uvx",
|
|
16
|
+
"args": ["package@latest"],
|
|
17
|
+
"env": {},
|
|
18
|
+
"disabled": false,
|
|
19
|
+
"autoApprove": []
|
|
20
|
+
}
|
|
21
|
+
}
|
|
22
|
+
}
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## Common Servers
|
|
26
|
+
|
|
27
|
+
- `awslabs.aws-documentation-mcp-server` - AWS documentation
|
|
28
|
+
- `@anthropic/mcp-server-filesystem` - File system access
|
|
29
|
+
- `@anthropic/mcp-server-github` - GitHub integration
|
|
30
|
+
|
|
31
|
+
## Installation
|
|
32
|
+
|
|
33
|
+
Most MCP servers use `uvx` (from the `uv` Python package manager):
|
|
34
|
+
1. Install `uv`: https://docs.astral.sh/uv/getting-started/installation/
|
|
35
|
+
2. Add server config to mcp.json
|
|
36
|
+
3. Server auto-starts on config change
|
|
37
|
+
|
|
38
|
+
## Auto-Approve
|
|
39
|
+
|
|
40
|
+
List tool names in `autoApprove` to skip confirmation prompts:
|
|
41
|
+
```json
|
|
42
|
+
{
|
|
43
|
+
"autoApprove": ["read_file", "search_files"]
|
|
44
|
+
}
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
## Troubleshooting
|
|
48
|
+
|
|
49
|
+
- Check server logs in Kiro's MCP Server view
|
|
50
|
+
- Verify `uvx` is installed and accessible
|
|
51
|
+
- Ensure environment variables are set correctly
|
|
52
|
+
- Use command palette: "MCP" to find relevant commands
|
|
53
|
+
- Servers reconnect automatically on config changes
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
# Skills
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
|
|
5
|
+
Skills are modular capabilities that Kiro activates automatically based on context. They provide specialized knowledge and workflows.
|
|
6
|
+
|
|
7
|
+
## Structure
|
|
8
|
+
|
|
9
|
+
```
|
|
10
|
+
.kiro/skills/{skill-name}/
|
|
11
|
+
skill.md # Main skill file (required)
|
|
12
|
+
references/ # Supporting documents (optional)
|
|
13
|
+
guide.md
|
|
14
|
+
examples.md
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## skill.md Format
|
|
18
|
+
|
|
19
|
+
```markdown
|
|
20
|
+
---
|
|
21
|
+
name: my-skill
|
|
22
|
+
description: >-
|
|
23
|
+
When to activate this skill. Include trigger phrases
|
|
24
|
+
and use cases.
|
|
25
|
+
---
|
|
26
|
+
|
|
27
|
+
# Skill Title
|
|
28
|
+
|
|
29
|
+
Content, instructions, and guidance...
|
|
30
|
+
|
|
31
|
+
## References
|
|
32
|
+
|
|
33
|
+
- `references/guide.md` - Detailed guide
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
## Front-Matter
|
|
37
|
+
|
|
38
|
+
Required fields:
|
|
39
|
+
- `name`: Skill identifier (kebab-case)
|
|
40
|
+
- `description`: Activation description (when should Kiro use this skill)
|
|
41
|
+
|
|
42
|
+
## Activation
|
|
43
|
+
|
|
44
|
+
Skills activate automatically when:
|
|
45
|
+
- User's message matches the description keywords
|
|
46
|
+
- Context suggests the skill is relevant
|
|
47
|
+
- User explicitly references the skill
|
|
48
|
+
|
|
49
|
+
## Best Practices
|
|
50
|
+
|
|
51
|
+
- Keep descriptions specific about when to activate
|
|
52
|
+
- Use references for detailed content (keeps main file focused)
|
|
53
|
+
- One skill per domain/topic
|
|
54
|
+
- Include examples in the skill content
|
|
55
|
+
- Reference external docs when available
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
# Specs Workflow
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
|
|
5
|
+
Specs are a structured way of building and documenting features. A spec formalizes the design and implementation process through requirements, design, and implementation tasks.
|
|
6
|
+
|
|
7
|
+
## Spec Types
|
|
8
|
+
|
|
9
|
+
### Feature Spec
|
|
10
|
+
- Requirements -> Design -> Tasks (requirements-first)
|
|
11
|
+
- Design -> Requirements -> Tasks (design-first)
|
|
12
|
+
|
|
13
|
+
### Bugfix Spec
|
|
14
|
+
- Bug condition methodology
|
|
15
|
+
- Exploration tests to confirm bug exists
|
|
16
|
+
- Fix implementation with property-based testing
|
|
17
|
+
|
|
18
|
+
## File Structure
|
|
19
|
+
|
|
20
|
+
```
|
|
21
|
+
.kiro/specs/{feature-name}/
|
|
22
|
+
requirements.md # User stories and acceptance criteria
|
|
23
|
+
design.md # Technical design document
|
|
24
|
+
tasks.md # Implementation task list
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## Workflow
|
|
28
|
+
|
|
29
|
+
1. **Start a spec**: Tell Kiro you want to build a feature
|
|
30
|
+
2. **Choose approach**: Requirements-first or Design-first
|
|
31
|
+
3. **Iterate on documents**: Review and refine with Kiro
|
|
32
|
+
4. **Execute tasks**: Kiro implements tasks sequentially
|
|
33
|
+
5. **Validate**: Tests verify correctness
|
|
34
|
+
|
|
35
|
+
## Requirements Document
|
|
36
|
+
|
|
37
|
+
Contains:
|
|
38
|
+
- User stories with acceptance criteria
|
|
39
|
+
- Correctness properties (formal specifications)
|
|
40
|
+
- Constraints and assumptions
|
|
41
|
+
|
|
42
|
+
## Design Document
|
|
43
|
+
|
|
44
|
+
Contains:
|
|
45
|
+
- High-level architecture
|
|
46
|
+
- Data models and schemas
|
|
47
|
+
- API contracts
|
|
48
|
+
- Component interactions
|
|
49
|
+
|
|
50
|
+
## Tasks Document
|
|
51
|
+
|
|
52
|
+
Contains:
|
|
53
|
+
- Ordered implementation tasks
|
|
54
|
+
- Sub-tasks with checkboxes
|
|
55
|
+
- Dependencies between tasks
|
|
56
|
+
|
|
57
|
+
## Property-Based Testing
|
|
58
|
+
|
|
59
|
+
Specs encourage formal correctness properties:
|
|
60
|
+
- Define what "correct" means for your feature
|
|
61
|
+
- Encode properties as executable tests
|
|
62
|
+
- Use property-based testing frameworks (fast-check, hypothesis)
|
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
# Steering Files
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
|
|
5
|
+
Steering files provide additional context and instructions to the AI agent. They live in `.kiro/steering/` and influence all interactions.
|
|
6
|
+
|
|
7
|
+
## Inclusion Modes
|
|
8
|
+
|
|
9
|
+
### Always Included (default)
|
|
10
|
+
```markdown
|
|
11
|
+
---
|
|
12
|
+
inclusion: always
|
|
13
|
+
description: Project coding standards
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
Your instructions here...
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
### Conditional (fileMatch)
|
|
20
|
+
Only included when matching files are read into context:
|
|
21
|
+
```markdown
|
|
22
|
+
---
|
|
23
|
+
inclusion: fileMatch
|
|
24
|
+
fileMatchPattern: "*.test.ts"
|
|
25
|
+
description: Testing conventions
|
|
26
|
+
---
|
|
27
|
+
|
|
28
|
+
Your testing instructions here...
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
### Manual
|
|
32
|
+
Only included when user explicitly references via `#` in chat:
|
|
33
|
+
```markdown
|
|
34
|
+
---
|
|
35
|
+
inclusion: manual
|
|
36
|
+
description: Database migration guide
|
|
37
|
+
---
|
|
38
|
+
|
|
39
|
+
Your migration guide here...
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
## Front-Matter Schema
|
|
43
|
+
|
|
44
|
+
Required fields:
|
|
45
|
+
- `inclusion`: "always" | "fileMatch" | "manual"
|
|
46
|
+
- `description`: Brief description of the steering file
|
|
47
|
+
|
|
48
|
+
Optional fields:
|
|
49
|
+
- `fileMatchPattern`: Glob pattern (required for fileMatch inclusion)
|
|
50
|
+
|
|
51
|
+
## Best Practices
|
|
52
|
+
|
|
53
|
+
- Keep steering files focused on one topic
|
|
54
|
+
- Use "always" sparingly to avoid context bloat
|
|
55
|
+
- Use "fileMatch" for language/framework-specific conventions
|
|
56
|
+
- Use "manual" for reference material not needed every time
|
|
57
|
+
- Include file references with `#[[file:relative/path]]` syntax
|
|
58
|
+
|
|
59
|
+
## Examples
|
|
60
|
+
|
|
61
|
+
### Code Standards
|
|
62
|
+
```markdown
|
|
63
|
+
---
|
|
64
|
+
inclusion: always
|
|
65
|
+
description: TypeScript coding standards
|
|
66
|
+
---
|
|
67
|
+
|
|
68
|
+
- Use strict mode, no `any` types
|
|
69
|
+
- Prefer interfaces for props, types for unions
|
|
70
|
+
- Use Zod for runtime validation
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
### API Conventions (conditional)
|
|
74
|
+
```markdown
|
|
75
|
+
---
|
|
76
|
+
inclusion: fileMatch
|
|
77
|
+
fileMatchPattern: "**/api/**/*.ts"
|
|
78
|
+
description: API route conventions
|
|
79
|
+
---
|
|
80
|
+
|
|
81
|
+
- Use parameterized queries
|
|
82
|
+
- Validate input with Zod
|
|
83
|
+
- Return consistent error format
|
|
84
|
+
```
|