-
Notifications
You must be signed in to change notification settings - Fork 2.5k
Add troubleshooting with console capture #5865
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
21 commits
Select commit
Hold shift + click to select a range
e9e8cff
Add troubleshooting with console capture
alexkgold 36ad8d2
Update apps/kilocode-docs/pages/getting-started/troubleshooting.md
alexkgold 3d134dc
Update apps/kilocode-docs/pages/getting-started/troubleshooting.md
alexkgold 631be09
Create troubleshooting section
alexkgold 4169383
Merge branch 'docs/troubleshooting' of https://github.com/kilo-org/ki…
alexkgold d3fce69
Update apps/kilocode-docs/pages/troubleshooting/troubleshooting-exten…
alexkgold cbf96af
Update apps/kilocode-docs/pages/troubleshooting/troubleshooting-exten…
alexkgold 27416f0
Update apps/kilocode-docs/pages/troubleshooting/troubleshooting-exten…
alexkgold e59ab2f
Update apps/kilocode-docs/AGENTS.md
alexkgold ec68a59
Apply suggestion from @alexkgold
alexkgold 812a0a2
Apply suggestion from @alexkgold
alexkgold 2178cf0
Update apps/kilocode-docs/pages/troubleshooting/index.md
alexkgold 4dceb22
Move troubleshooting under help nav
alexkgold 6cf499b
Update apps/kilocode-docs/package.json
alexkgold 02c1b1a
Clean up troubleshooting rom top-level nav
alexkgold ba66108
Update apps/kilocode-docs/AGENTS.md
alexkgold ea01e16
Update apps/kilocode-docs/pages/getting-started/troubleshooting/troub…
alexkgold 3aacc6e
Update apps/kilocode-docs/pages/getting-started/troubleshooting/index.md
alexkgold 6c8c117
Merge branch 'main' into docs/troubleshooting
alexkgold 17f2437
Apply suggestion from @alexkgold
alexkgold 8fa46cd
Apply suggestion from @alexkgold
alexkgold File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
12 changes: 12 additions & 0 deletions
12
apps/kilocode-docs/pages/getting-started/troubleshooting/index.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| --- | ||
| title: "Troubleshooting" | ||
| description: "Guides for diagnosing and resolving issues with Kilo Code" | ||
| --- | ||
|
|
||
| # Troubleshooting | ||
|
|
||
| This section contains guides for diagnosing and resolving common issues with Kilo Code. | ||
|
|
||
| ## Guides | ||
|
|
||
| - [**Extension Troubleshooting**](/docs/getting-started/troubleshooting/troubleshooting-extension) - How to capture console logs and report issues with the Kilo Code extension |
57 changes: 57 additions & 0 deletions
57
...ilocode-docs/pages/getting-started/troubleshooting/troubleshooting-extension.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| --- | ||
| title: "Troubleshooting IDE Extensions" | ||
| description: "How to capture console logs and report issues with Kilo Code" | ||
| --- | ||
|
|
||
| # Capturing Console Logs | ||
|
|
||
| Providing console logs helps us pinpoint exactly what's going wrong with your installation, network, or MCP setup. This guide walks you through capturing those logs in your IDE. | ||
|
|
||
| ## Opening Developer Tools | ||
|
|
||
| {% tabs %} | ||
| {% tab label="VS Code" %} | ||
|
|
||
| 1. **Open the Command Palette**: Press `Ctrl+Shift+P` (Windows/Linux) or `Cmd+Shift+P` (Mac) | ||
| 2. **Search for Developer Tools**: Type `Developer: Open Webview Developer Tools` and select it | ||
|
|
||
| {% /tab %} | ||
| {% tab label="JetBrains" %} | ||
|
|
||
| ### Enable JCEF Debugging | ||
|
|
||
| 1. Open your JetBrains IDE and go to **Help → Find Action** (or press `Cmd+Shift+A` / `Ctrl+Shift+A`) | ||
| 2. Type `Registry` and open it | ||
| 3. Search for `jcef` and configure these settings: | ||
| - `ide.browser.jcef.debug.port` → set to `9222` | ||
| - `ide.browser.jcef.contextMenu.devTools.enabled` → check the box | ||
| 4. Restart your IDE after making these changes | ||
|
|
||
| ### Connect Chrome DevTools | ||
|
|
||
| 1. Make sure the **Kilo Code panel is open** in your IDE (the debug target won't appear unless the webview is active) | ||
| 2. Open Chrome (or any Chromium-based browser like Edge or Arc) | ||
| 3. Navigate to `http://localhost:9222/json` to see the list of inspectable targets | ||
| 4. Find the entry with `"title": "Kilo Code"` and open the `devtoolsFrontendUrl` link | ||
| 5. Chrome DevTools will open connected to the Kilo webview—click the **Console** tab | ||
|
|
||
| {% /tab %} | ||
| {% /tabs %} | ||
|
|
||
| ## Capturing the Error | ||
|
|
||
| Once you have the Developer Tools console open: | ||
|
|
||
| 1. **Clear previous logs**: Click the "Clear Console" button (🚫 icon at the top of the Console panel) to remove old messages | ||
| 2. **Reproduce the issue**: Perform the action that was causing problems | ||
| 3. **Check for errors**: Look at the Console tab for error messages (usually shown in red). If you suspect connection issues, also check the **Network** tab | ||
| 4. **Copy the logs**: Right-click in the console and select "Save as..." or copy the relevant error messages | ||
|
|
||
| ## Contact Support | ||
|
|
||
| If you're unable to resolve the issue, please inspect the console logs, remove any secrets, and send the logs to **[hi@kilocode.ai](mailto:hi@kilocode.ai)** along with the following: | ||
|
|
||
| - The error messages from the console | ||
| - Steps to reproduce the issue | ||
|
alexkgold marked this conversation as resolved.
|
||
| - Screenshots or screen recordings of the issue | ||
| - Your IDE and Kilo Code version | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.