Skip to content

Commit 233c286

Browse files
authored
Add kiro setup docs (#498)
1 parent 87bb95c commit 233c286

1 file changed

Lines changed: 41 additions & 11 deletions

File tree

INSTALLATION.md

Lines changed: 41 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -36,16 +36,6 @@ unzip cfn-lsp.zip -d /path/to/install-location
3636

3737
## Server Configuration
3838

39-
### Running the Server
40-
41-
```bash
42-
node /path/to/install-location/cfn-lsp-server-standalone.js --stdio
43-
```
44-
45-
Communication options:
46-
- `--stdio` - Use stdin/stdout (recommended)
47-
- `--node-ipc` - Use Node IPC
48-
4939
### Initialization Options
5040

5141
The language server accepts initialization options via the LSP `initialize` request:
@@ -131,7 +121,7 @@ See [Telemetry](src/telemetry/README.md) for details on collected metrics.
131121

132122
---
133123

134-
## Editor Setup
124+
## Client Setup
135125

136126
### Neovim
137127

@@ -165,6 +155,46 @@ lspconfig.cfn_lsp.setup({})
165155

166156
Verify: Open a YAML/JSON file and run `:LspInfo`
167157

158+
### Kiro CLI
159+
160+
[Kiro CLI](https://kiro.dev/docs/cli/) supports [custom language servers](https://kiro.dev/docs/cli/code-intelligence/#custom-language-servers) via its LSP integration. To configure the CloudFormation Language Server:
161+
162+
1. Run `/code init` in your project root (if not already initialized)
163+
164+
2. Edit the generated `lsp.json` (located at `.kiro/settings/lsp.json`) and add the `cloudformation` entry:
165+
166+
```json
167+
{
168+
"languages": {
169+
"cloudformation": {
170+
"name": "cloudformation-languageserver",
171+
"command": "node",
172+
"args": ["/path/to/install-location/cfn-lsp-server-standalone.js", "--stdio"],
173+
"file_extensions": ["json", "yaml", "yml", "cfn", "template"],
174+
"project_patterns": [],
175+
"exclude_patterns": [],
176+
"multi_workspace": false,
177+
"initialization_options": {
178+
"aws": {
179+
"clientInfo": {
180+
"extension": {
181+
"name": "kiro-cli",
182+
"version": "1.0.0"
183+
}
184+
},
185+
"telemetryEnabled": true
186+
}
187+
},
188+
"request_timeout_secs": 60
189+
}
190+
}
191+
}
192+
```
193+
194+
3. Restart Kiro CLI to load the new configuration, or run `/code init -f` to force re-initialization
195+
196+
Verify: Run `/code status` to confirm the `cloudformation` server is initialized.
197+
168198
### Sublime Text (LSP package)
169199

170200
Add to LSP settings:

0 commit comments

Comments
 (0)