[codex] Add Kiro setup recipe (#4535)
* Add Kiro setup recipe * docs: register integrations/kiro in docs.json navigation The docsync guard (TestEveryDocsPageIsPublished) requires every docs/ page in the Mintlify nav; it landed after this PR was written. Agent-Signature: claude-fable-5-high on behalf of maphew Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01P3JtQ3ukoVmfg6LCKcKBBh --------- Co-authored-by: matt wilkie <maphew@gmail.com> Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
parent
88454d54a8
commit
59cfc4a000
8 changed files with 64 additions and 3 deletions
|
|
@ -33,11 +33,12 @@ var setupCmd = &cobra.Command{
|
|||
Long: `Setup integration files for AI editors and coding assistants.
|
||||
|
||||
Recipes define where beads workflow instructions are written. Built-in recipes
|
||||
include cursor, claude, copilot, gemini, aider, factory, codex, mux, opencode, junie, windsurf, cody, and kilocode.
|
||||
include cursor, claude, copilot, gemini, aider, factory, codex, mux, opencode, junie, kiro, windsurf, cody, and kilocode.
|
||||
|
||||
Examples:
|
||||
bd setup cursor # Install Cursor IDE integration (rules + agent hooks)
|
||||
bd setup cursor --global # Install global Cursor hooks (~/.cursor/hooks.json)
|
||||
bd setup kiro # Install Kiro steering guidance
|
||||
bd setup codex # Install Codex skill + AGENTS.md guidance + native hooks
|
||||
bd setup codex --global # Install global Codex skill + guidance + native hooks
|
||||
bd setup copilot # Install Copilot CLI plugin + repository instructions
|
||||
|
|
|
|||
|
|
@ -189,6 +189,35 @@ func TestRunRecipe_BuiltinFileRecipeWorksWithoutWorkspace(t *testing.T) {
|
|||
}
|
||||
}
|
||||
|
||||
func TestRunRecipe_KiroWorksWithoutWorkspace(t *testing.T) {
|
||||
tmpDir := t.TempDir()
|
||||
t.Chdir(tmpDir)
|
||||
t.Setenv("BEADS_DIR", "")
|
||||
resetSetupResolutionCaches(t)
|
||||
resetSetupGlobals(t)
|
||||
|
||||
out := captureStdout(t, func() error {
|
||||
runRecipe("kiro")
|
||||
return nil
|
||||
})
|
||||
|
||||
if !strings.Contains(out, "Installing Kiro CLI integration") {
|
||||
t.Fatalf("expected install output, got:\n%s", out)
|
||||
}
|
||||
|
||||
installedPath := filepath.Join(tmpDir, ".kiro", "steering", "beads.md")
|
||||
data, err := os.ReadFile(installedPath)
|
||||
if err != nil {
|
||||
t.Fatalf("ReadFile(%q): %v", installedPath, err)
|
||||
}
|
||||
if string(data) != recipes.Template {
|
||||
t.Fatalf("installed Kiro recipe contents did not match template")
|
||||
}
|
||||
if _, err := os.Stat(filepath.Join(tmpDir, ".beads")); !os.IsNotExist(err) {
|
||||
t.Fatalf("expected no local .beads directory to be created, got err=%v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestRunRecipe_CopilotWorksWithoutWorkspace(t *testing.T) {
|
||||
tmpDir := t.TempDir()
|
||||
|
||||
|
|
|
|||
|
|
@ -302,6 +302,7 @@
|
|||
"integrations/gemini",
|
||||
"integrations/junie",
|
||||
"integrations/kilocode",
|
||||
"integrations/kiro",
|
||||
"integrations/mux",
|
||||
"integrations/opencode",
|
||||
"integrations/windsurf",
|
||||
|
|
|
|||
|
|
@ -35,6 +35,7 @@ bd setup claude --remove # Uninstall
|
|||
| `windsurf` | `.windsurf/rules/beads.md` | [Windsurf](/integrations/windsurf) |
|
||||
| `cody` | `.cody/rules/beads.md` | [Cody](/integrations/cody) |
|
||||
| `kilocode` | `.kilocode/rules/beads.md` | [Kilo Code](/integrations/kilocode) |
|
||||
| `kiro` | `.kiro/steering/beads.md` | [Kiro CLI](/integrations/kiro) |
|
||||
|
||||
`bd prime` is the single source of truth for operational workflow commands. Each integration's instruction file either points to `bd prime` (hook-enabled agents) or carries the full command reference (AGENTS-first agents).
|
||||
|
||||
|
|
@ -348,7 +349,7 @@ bd setup --print
|
|||
|
||||
| Type | Description | Used by |
|
||||
|------|-------------|---------|
|
||||
| `file` | Write the template to a single file | windsurf, cody, kilocode |
|
||||
| `file` | Write the template to a single file | windsurf, cody, kilocode, kiro |
|
||||
| `hooks` | Modify JSON settings to add hooks | claude, gemini |
|
||||
| `section` | Inject a marked section into an existing file | factory, codex, mux, opencode |
|
||||
| `multifile` | Write multiple files | aider, copilot, junie |
|
||||
|
|
|
|||
|
|
@ -27,6 +27,7 @@ bd setup --list
|
|||
| `gemini` | [Gemini CLI](/integrations/gemini) | Gemini hooks and `GEMINI.md` |
|
||||
| `junie` | [Junie](/integrations/junie) | `.junie/guidelines.md` and MCP config |
|
||||
| `kilocode` | [Kilo Code](/integrations/kilocode) | `.kilocode/rules/beads.md` |
|
||||
| `kiro` | [Kiro CLI](/integrations/kiro) | `.kiro/steering/beads.md` |
|
||||
| `mux` | [Mux](/integrations/mux) | `AGENTS.md`, optional `.mux/AGENTS.md`, and Mux hooks |
|
||||
| `opencode` | [OpenCode](/integrations/opencode) | `AGENTS.md` |
|
||||
| `windsurf` | [Windsurf](/integrations/windsurf) | `.windsurf/rules/beads.md` |
|
||||
|
|
|
|||
22
docs/integrations/kiro.md
Normal file
22
docs/integrations/kiro.md
Normal file
|
|
@ -0,0 +1,22 @@
|
|||
---
|
||||
id: kiro
|
||||
title: Kiro CLI
|
||||
---
|
||||
|
||||
# Kiro CLI Integration
|
||||
|
||||
Use Beads with Kiro CLI through workspace steering guidance.
|
||||
|
||||
```bash
|
||||
bd setup kiro
|
||||
bd setup kiro --check
|
||||
```
|
||||
|
||||
The setup command writes Beads workflow guidance to `.kiro/steering/beads.md`.
|
||||
Kiro reads workspace steering files when it starts a session.
|
||||
|
||||
## Remove
|
||||
|
||||
```bash
|
||||
bd setup kiro --remove
|
||||
```
|
||||
|
|
@ -67,6 +67,12 @@ var BuiltinRecipes = map[string]Recipe{
|
|||
Type: TypeFile,
|
||||
Description: "Kilo Code rules file",
|
||||
},
|
||||
"kiro": {
|
||||
Name: "Kiro CLI",
|
||||
Path: ".kiro/steering/beads.md",
|
||||
Type: TypeFile,
|
||||
Description: "Kiro steering file",
|
||||
},
|
||||
"claude": {
|
||||
Name: "Claude Code",
|
||||
Type: TypeHooks,
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ import (
|
|||
|
||||
func TestBuiltinRecipes(t *testing.T) {
|
||||
// Ensure all expected built-in recipes exist
|
||||
expected := []string{"cursor", "windsurf", "cody", "kilocode", "claude", "copilot", "gemini", "factory", "codex", "mux", "aider", "junie"}
|
||||
expected := []string{"cursor", "windsurf", "cody", "kilocode", "kiro", "claude", "copilot", "gemini", "factory", "codex", "mux", "aider", "junie"}
|
||||
|
||||
for _, name := range expected {
|
||||
recipe, ok := BuiltinRecipes[name]
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue