feat(installer): add Kiro CLI/IDE target (#385) (#473)

`codegraph install` now detects and configures Kiro alongside the
existing seven agents. Writes `mcpServers.codegraph` to
`~/.kiro/settings/mcp.json` (global) or `./.kiro/settings/mcp.json`
(local), plus a dedicated `~/.kiro/steering/codegraph.md` /
`./.kiro/steering/codegraph.md` instruction file — Kiro's steering
system loads every `*.md` file in `steering/` as agent context, so a
dedicated file is the natural surface (no marker-based merging needed).

Sibling MCP servers in `mcp.json` and unrelated steering files
(`product.md`, `tech.md`, etc.) are preserved across install and
uninstall. Validated end-to-end on macOS, Linux (Docker node:22-bookworm
arm64), and Windows 11 (Parallels VM, Node 24): full installer-targets
suite passes (132 tests) on all three platforms, and live install /
idempotent re-run / uninstall round-trip works as expected.

Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
Colby Mchenry
2026-05-26 18:09:51 -05:00
committed by GitHub
co-authored by Claude Opus 4.7
parent 8c69001289
commit 6558b585ed
6 changed files with 262 additions and 3 deletions
+2 -2
View File
@@ -317,8 +317,8 @@ export async function runUninstaller(opts: RunUninstallerOptions): Promise<void>
const sel = await clack.select({
message: 'Remove CodeGraph from all your projects, or just this one?',
options: [
{ value: 'global' as const, label: 'All projects (global)', hint: '~/.claude, ~/.cursor, ~/.codex, ~/.config/opencode, ~/.hermes, ~/.gemini' },
{ value: 'local' as const, label: 'Just this project (local)', hint: './.claude, ./.cursor, ./opencode.jsonc, ./.gemini' },
{ value: 'global' as const, label: 'All projects (global)', hint: '~/.claude, ~/.cursor, ~/.codex, ~/.config/opencode, ~/.hermes, ~/.gemini, ~/.kiro' },
{ value: 'local' as const, label: 'Just this project (local)', hint: './.claude, ./.cursor, ./opencode.jsonc, ./.gemini, ./.kiro' },
],
initialValue: 'global' as const,
});
+177
View File
@@ -0,0 +1,177 @@
/**
* Kiro CLI / IDE target. Writes:
*
* - MCP server entry to `~/.kiro/settings/mcp.json` (global) or
* `./.kiro/settings/mcp.json` (local). Standard `mcpServers.codegraph`
* shape, same as Claude / Cursor / Gemini.
* - Instructions to `~/.kiro/steering/codegraph.md` (global) or
* `./.kiro/steering/codegraph.md` (local). Kiro's "steering" system
* loads every `*.md` file in the steering dir as agent context, so
* a dedicated `codegraph.md` is the natural surface — we own the
* whole file outright (no marker-based merging needed) and delete
* it on uninstall.
*
* No permissions concept — Kiro gates tool invocations through its own
* UI prompts rather than an external allowlist. `autoAllow` is silently
* ignored.
*
* Paths are identical on macOS / Linux / Windows because Kiro resolves
* its config root from `os.homedir()` on all three (Windows `~` →
* `%USERPROFILE%\.kiro`).
*
* Docs: https://kiro.dev/docs/cli/mcp/
* https://kiro.dev/docs/cli/steering/
*/
import * as fs from 'fs';
import * as path from 'path';
import * as os from 'os';
import {
AgentTarget,
DetectionResult,
InstallOptions,
Location,
WriteResult,
} from './types';
import {
atomicWriteFileSync,
getMcpServerConfig,
jsonDeepEqual,
readJsonFile,
writeJsonFile,
} from './shared';
import { INSTRUCTIONS_TEMPLATE } from '../instructions-template';
function configDir(loc: Location): string {
return loc === 'global'
? path.join(os.homedir(), '.kiro')
: path.join(process.cwd(), '.kiro');
}
function mcpJsonPath(loc: Location): string {
return path.join(configDir(loc), 'settings', 'mcp.json');
}
function steeringPath(loc: Location): string {
return path.join(configDir(loc), 'steering', 'codegraph.md');
}
class KiroTarget implements AgentTarget {
readonly id = 'kiro' as const;
readonly displayName = 'Kiro';
readonly docsUrl = 'https://kiro.dev/docs/cli/mcp/';
supportsLocation(_loc: Location): boolean {
return true;
}
detect(loc: Location): DetectionResult {
const file = mcpJsonPath(loc);
const config = readJsonFile(file);
const alreadyConfigured = !!config.mcpServers?.codegraph;
const installed = loc === 'global'
? fs.existsSync(configDir('global')) || fs.existsSync(file)
: fs.existsSync(file) || fs.existsSync(configDir('local'));
return { installed, alreadyConfigured, configPath: file };
}
install(loc: Location, _opts: InstallOptions): WriteResult {
const files: WriteResult['files'] = [];
files.push(writeMcpEntry(loc));
files.push(writeSteeringEntry(loc));
return {
files,
notes: ['Restart Kiro for MCP changes to take effect.'],
};
}
uninstall(loc: Location): WriteResult {
const files: WriteResult['files'] = [];
const file = mcpJsonPath(loc);
const config = readJsonFile(file);
if (config.mcpServers?.codegraph) {
delete config.mcpServers.codegraph;
if (Object.keys(config.mcpServers).length === 0) {
delete config.mcpServers;
}
writeJsonFile(file, config);
files.push({ path: file, action: 'removed' });
} else {
files.push({ path: file, action: 'not-found' });
}
files.push(removeSteeringEntry(loc));
return { files };
}
printConfig(loc: Location): string {
const target = mcpJsonPath(loc);
const snippet = JSON.stringify({ mcpServers: { codegraph: getMcpServerConfig() } }, null, 2);
return `# Add to ${target}\n\n${snippet}\n`;
}
describePaths(loc: Location): string[] {
return [mcpJsonPath(loc), steeringPath(loc)];
}
}
function writeMcpEntry(loc: Location): WriteResult['files'][number] {
const file = mcpJsonPath(loc);
const dir = path.dirname(file);
if (!fs.existsSync(dir)) fs.mkdirSync(dir, { recursive: true });
const existing = readJsonFile(file);
const before = existing.mcpServers?.codegraph;
const after = getMcpServerConfig();
if (jsonDeepEqual(before, after)) {
return { path: file, action: 'unchanged' };
}
const action: 'created' | 'updated' =
before ? 'updated' : (fs.existsSync(file) ? 'updated' : 'created');
if (!existing.mcpServers) existing.mcpServers = {};
existing.mcpServers.codegraph = after;
writeJsonFile(file, existing);
return { path: file, action };
}
/**
* Write the dedicated steering file. Unlike CLAUDE.md / GEMINI.md
* (shared files where codegraph owns a marker-delimited section),
* Kiro's steering dir loads every `*.md` as a discrete document — so
* `codegraph.md` is ours outright. Byte-equality short-circuits
* idempotent re-runs; mismatched content gets a clean rewrite.
*/
function writeSteeringEntry(loc: Location): WriteResult['files'][number] {
const file = steeringPath(loc);
const dir = path.dirname(file);
if (!fs.existsSync(dir)) fs.mkdirSync(dir, { recursive: true });
const body = INSTRUCTIONS_TEMPLATE + '\n';
if (!fs.existsSync(file)) {
atomicWriteFileSync(file, body);
return { path: file, action: 'created' };
}
const existing = fs.readFileSync(file, 'utf-8');
if (existing === body) {
return { path: file, action: 'unchanged' };
}
atomicWriteFileSync(file, body);
return { path: file, action: 'updated' };
}
/**
* Delete the steering file we own. If a user has hand-edited the file
* out of recognition we still remove it — codegraph.md is a name we
* claim, and a partial install leaving the file behind is worse than
* a clean delete.
*/
function removeSteeringEntry(loc: Location): WriteResult['files'][number] {
const file = steeringPath(loc);
if (!fs.existsSync(file)) return { path: file, action: 'not-found' };
try { fs.unlinkSync(file); } catch { /* ignore */ }
return { path: file, action: 'removed' };
}
export const kiroTarget: AgentTarget = new KiroTarget();
+2
View File
@@ -15,6 +15,7 @@ import { opencodeTarget } from './opencode';
import { hermesTarget } from './hermes';
import { geminiTarget } from './gemini';
import { antigravityTarget } from './antigravity';
import { kiroTarget } from './kiro';
export const ALL_TARGETS: readonly AgentTarget[] = Object.freeze([
claudeTarget,
@@ -24,6 +25,7 @@ export const ALL_TARGETS: readonly AgentTarget[] = Object.freeze([
hermesTarget,
geminiTarget,
antigravityTarget,
kiroTarget,
]);
export function getTarget(id: string): AgentTarget | undefined {
+1 -1
View File
@@ -19,7 +19,7 @@ export type Location = 'global' | 'local';
* lookup. New targets add a value here when they're added to the
* registry. Keep these short and lowercase.
*/
export type TargetId = 'claude' | 'cursor' | 'codex' | 'opencode' | 'hermes' | 'gemini' | 'antigravity';
export type TargetId = 'claude' | 'cursor' | 'codex' | 'opencode' | 'hermes' | 'gemini' | 'antigravity' | 'kiro';
/**
* Result of `target.detect(location)`.