@neocode-ai/web 1.1.1

package/src/content/docs/themes.mdx

@@ -0,0 +1,369 @@
+---
+title: Themes
+description: Select a built-in theme or define your own.
+---
+
+With NeoCode you can select from one of several built-in themes, use a theme that adapts to your terminal theme, or define your own custom theme.
+
+By default, NeoCode uses our own `neocode` theme.
+
+---
+
+## Terminal requirements
+
+For themes to display correctly with their full color palette, your terminal must support **truecolor** (24-bit color). Most modern terminals support this by default, but you may need to enable it:
+
+- **Check support**: Run `echo $COLORTERM` - it should output `truecolor` or `24bit`
+- **Enable truecolor**: Set the environment variable `COLORTERM=truecolor` in your shell profile
+- **Terminal compatibility**: Ensure your terminal emulator supports 24-bit color (most modern terminals like iTerm2, Alacritty, Kitty, Windows Terminal, and recent versions of GNOME Terminal do)
+
+Without truecolor support, themes may appear with reduced color accuracy or fall back to the nearest 256-color approximation.
+
+---
+
+## Built-in themes
+
+NeoCode comes with several built-in themes.
+
+| Name                   | Description                                                                  |
+| ---------------------- | ---------------------------------------------------------------------------- |
+| `system`               | Adapts to your terminal’s background color                                   |
+| `tokyonight`           | Based on the [Tokyonight](https://github.com/folke/tokyonight.nvim) theme    |
+| `everforest`           | Based on the [Everforest](https://github.com/sainnhe/everforest) theme       |
+| `ayu`                  | Based on the [Ayu](https://github.com/ayu-theme) dark theme                  |
+| `catppuccin`           | Based on the [Catppuccin](https://github.com/catppuccin) theme               |
+| `catppuccin-macchiato` | Based on the [Catppuccin](https://github.com/catppuccin) theme               |
+| `gruvbox`              | Based on the [Gruvbox](https://github.com/morhetz/gruvbox) theme             |
+| `kanagawa`             | Based on the [Kanagawa](https://github.com/rebelot/kanagawa.nvim) theme      |
+| `nord`                 | Based on the [Nord](https://github.com/nordtheme/nord) theme                 |
+| `matrix`               | Hacker-style green on black theme                                            |
+| `one-dark`             | Based on the [Atom One](https://github.com/Th3Whit3Wolf/one-nvim) Dark theme |
+
+And more, we are constantly adding new themes.
+
+---
+
+## System theme
+
+The `system` theme is designed to automatically adapt to your terminal's color scheme. Unlike traditional themes that use fixed colors, the _system_ theme:
+
+- **Generates gray scale**: Creates a custom gray scale based on your terminal's background color, ensuring optimal contrast.
+- **Uses ANSI colors**: Leverages standard ANSI colors (0-15) for syntax highlighting and UI elements, which respect your terminal's color palette.
+- **Preserves terminal defaults**: Uses `none` for text and background colors to maintain your terminal's native appearance.
+
+The system theme is for users who:
+
+- Want NeoCode to match their terminal's appearance
+- Use custom terminal color schemes
+- Prefer a consistent look across all terminal applications
+
+---
+
+## Using a theme
+
+You can select a theme by bringing up the theme select with the `/theme` command. Or you can specify it in your [config](/docs/config).
+
+```json title="neocode.json" {3}
+{
+  "$schema": "https://neo.khulnasoft.com/config.json",
+  "theme": "tokyonight"
+}
+```
+
+---
+
+## Custom themes
+
+NeoCode supports a flexible JSON-based theme system that allows users to create and customize themes easily.
+
+---
+
+### Hierarchy
+
+Themes are loaded from multiple directories in the following order where later directories override earlier ones:
+
+1. **Built-in themes** - These are embedded in the binary
+2. **User config directory** - Defined in `~/.config/neocode/themes/*.json` or `$XDG_CONFIG_HOME/neocode/themes/*.json`
+3. **Project root directory** - Defined in the `<project-root>/.neocode/themes/*.json`
+4. **Current working directory** - Defined in `./.neocode/themes/*.json`
+
+If multiple directories contain a theme with the same name, the theme from the directory with higher priority will be used.
+
+---
+
+### Creating a theme
+
+To create a custom theme, create a JSON file in one of the theme directories.
+
+For user-wide themes:
+
+```bash no-frame
+mkdir -p ~/.config/neocode/themes
+vim ~/.config/neocode/themes/my-theme.json
+```
+
+And for project-specific themes.
+
+```bash no-frame
+mkdir -p .neocode/themes
+vim .neocode/themes/my-theme.json
+```
+
+---
+
+### JSON format
+
+Themes use a flexible JSON format with support for:
+
+- **Hex colors**: `"#ffffff"`
+- **ANSI colors**: `3` (0-255)
+- **Color references**: `"primary"` or custom definitions
+- **Dark/light variants**: `{"dark": "#000", "light": "#fff"}`
+- **No color**: `"none"` - Uses the terminal's default color or transparent
+
+---
+
+### Color definitions
+
+The `defs` section is optional and it allows you to define reusable colors that can be referenced in the theme.
+
+---
+
+### Terminal defaults
+
+The special value `"none"` can be used for any color to inherit the terminal's default color. This is particularly useful for creating themes that blend seamlessly with your terminal's color scheme:
+
+- `"text": "none"` - Uses terminal's default foreground color
+- `"background": "none"` - Uses terminal's default background color
+
+---
+
+### Example
+
+Here's an example of a custom theme:
+
+```json title="my-theme.json"
+{
+  "$schema": "https://neo.khulnasoft.com/theme.json",
+  "defs": {
+    "nord0": "#2E3440",
+    "nord1": "#3B4252",
+    "nord2": "#434C5E",
+    "nord3": "#4C566A",
+    "nord4": "#D8DEE9",
+    "nord5": "#E5E9F0",
+    "nord6": "#ECEFF4",
+    "nord7": "#8FBCBB",
+    "nord8": "#88C0D0",
+    "nord9": "#81A1C1",
+    "nord10": "#5E81AC",
+    "nord11": "#BF616A",
+    "nord12": "#D08770",
+    "nord13": "#EBCB8B",
+    "nord14": "#A3BE8C",
+    "nord15": "#B48EAD"
+  },
+  "theme": {
+    "primary": {
+      "dark": "nord8",
+      "light": "nord10"
+    },
+    "secondary": {
+      "dark": "nord9",
+      "light": "nord9"
+    },
+    "accent": {
+      "dark": "nord7",
+      "light": "nord7"
+    },
+    "error": {
+      "dark": "nord11",
+      "light": "nord11"
+    },
+    "warning": {
+      "dark": "nord12",
+      "light": "nord12"
+    },
+    "success": {
+      "dark": "nord14",
+      "light": "nord14"
+    },
+    "info": {
+      "dark": "nord8",
+      "light": "nord10"
+    },
+    "text": {
+      "dark": "nord4",
+      "light": "nord0"
+    },
+    "textMuted": {
+      "dark": "nord3",
+      "light": "nord1"
+    },
+    "background": {
+      "dark": "nord0",
+      "light": "nord6"
+    },
+    "backgroundPanel": {
+      "dark": "nord1",
+      "light": "nord5"
+    },
+    "backgroundElement": {
+      "dark": "nord1",
+      "light": "nord4"
+    },
+    "border": {
+      "dark": "nord2",
+      "light": "nord3"
+    },
+    "borderActive": {
+      "dark": "nord3",
+      "light": "nord2"
+    },
+    "borderSubtle": {
+      "dark": "nord2",
+      "light": "nord3"
+    },
+    "diffAdded": {
+      "dark": "nord14",
+      "light": "nord14"
+    },
+    "diffRemoved": {
+      "dark": "nord11",
+      "light": "nord11"
+    },
+    "diffContext": {
+      "dark": "nord3",
+      "light": "nord3"
+    },
+    "diffHunkHeader": {
+      "dark": "nord3",
+      "light": "nord3"
+    },
+    "diffHighlightAdded": {
+      "dark": "nord14",
+      "light": "nord14"
+    },
+    "diffHighlightRemoved": {
+      "dark": "nord11",
+      "light": "nord11"
+    },
+    "diffAddedBg": {
+      "dark": "#3B4252",
+      "light": "#E5E9F0"
+    },
+    "diffRemovedBg": {
+      "dark": "#3B4252",
+      "light": "#E5E9F0"
+    },
+    "diffContextBg": {
+      "dark": "nord1",
+      "light": "nord5"
+    },
+    "diffLineNumber": {
+      "dark": "nord2",
+      "light": "nord4"
+    },
+    "diffAddedLineNumberBg": {
+      "dark": "#3B4252",
+      "light": "#E5E9F0"
+    },
+    "diffRemovedLineNumberBg": {
+      "dark": "#3B4252",
+      "light": "#E5E9F0"
+    },
+    "markdownText": {
+      "dark": "nord4",
+      "light": "nord0"
+    },
+    "markdownHeading": {
+      "dark": "nord8",
+      "light": "nord10"
+    },
+    "markdownLink": {
+      "dark": "nord9",
+      "light": "nord9"
+    },
+    "markdownLinkText": {
+      "dark": "nord7",
+      "light": "nord7"
+    },
+    "markdownCode": {
+      "dark": "nord14",
+      "light": "nord14"
+    },
+    "markdownBlockQuote": {
+      "dark": "nord3",
+      "light": "nord3"
+    },
+    "markdownEmph": {
+      "dark": "nord12",
+      "light": "nord12"
+    },
+    "markdownStrong": {
+      "dark": "nord13",
+      "light": "nord13"
+    },
+    "markdownHorizontalRule": {
+      "dark": "nord3",
+      "light": "nord3"
+    },
+    "markdownListItem": {
+      "dark": "nord8",
+      "light": "nord10"
+    },
+    "markdownListEnumeration": {
+      "dark": "nord7",
+      "light": "nord7"
+    },
+    "markdownImage": {
+      "dark": "nord9",
+      "light": "nord9"
+    },
+    "markdownImageText": {
+      "dark": "nord7",
+      "light": "nord7"
+    },
+    "markdownCodeBlock": {
+      "dark": "nord4",
+      "light": "nord0"
+    },
+    "syntaxComment": {
+      "dark": "nord3",
+      "light": "nord3"
+    },
+    "syntaxKeyword": {
+      "dark": "nord9",
+      "light": "nord9"
+    },
+    "syntaxFunction": {
+      "dark": "nord8",
+      "light": "nord8"
+    },
+    "syntaxVariable": {
+      "dark": "nord7",
+      "light": "nord7"
+    },
+    "syntaxString": {
+      "dark": "nord14",
+      "light": "nord14"
+    },
+    "syntaxNumber": {
+      "dark": "nord15",
+      "light": "nord15"
+    },
+    "syntaxType": {
+      "dark": "nord7",
+      "light": "nord7"
+    },
+    "syntaxOperator": {
+      "dark": "nord9",
+      "light": "nord9"
+    },
+    "syntaxPunctuation": {
+      "dark": "nord4",
+      "light": "nord0"
+    }
+  }
+}
+```

package/src/content/docs/tools.mdx

@@ -0,0 +1,345 @@
+---
+title: Tools
+description: Manage the tools an LLM can use.
+---
+
+Tools allow the LLM to perform actions in your codebase. NeoCode comes with a set of built-in tools, but you can extend it with [custom tools](/docs/custom-tools) or [MCP servers](/docs/mcp-servers).
+
+By default, all tools are **enabled** and don't need permission to run. You can control tool behavior through [permissions](/docs/permissions).
+
+---
+
+## Configure
+
+Use the `permission` field to control tool behavior. You can allow, deny, or require approval for each tool.
+
+```json title="neocode.json"
+{
+  "$schema": "https://neo.khulnasoft.com/config.json",
+  "permission": {
+    "edit": "deny",
+    "bash": "ask",
+    "webfetch": "allow"
+  }
+}
+```
+
+You can also use wildcards to control multiple tools at once. For example, to require approval for all tools from an MCP server:
+
+```json title="neocode.json"
+{
+  "$schema": "https://neo.khulnasoft.com/config.json",
+  "permission": {
+    "mymcp_*": "ask"
+  }
+}
+```
+
+[Learn more](/docs/permissions) about configuring permissions.
+
+---
+
+## Built-in
+
+Here are all the built-in tools available in NeoCode.
+
+---
+
+### bash
+
+Execute shell commands in your project environment.
+
+```json title="neocode.json" {4}
+{
+  "$schema": "https://neo.khulnasoft.com/config.json",
+  "permission": {
+    "bash": "allow"
+  }
+}
+```
+
+This tool allows the LLM to run terminal commands like `npm install`, `git status`, or any other shell command.
+
+---
+
+### edit
+
+Modify existing files using exact string replacements.
+
+```json title="neocode.json" {4}
+{
+  "$schema": "https://neo.khulnasoft.com/config.json",
+  "permission": {
+    "edit": "allow"
+  }
+}
+```
+
+This tool performs precise edits to files by replacing exact text matches. It's the primary way the LLM modifies code.
+
+---
+
+### write
+
+Create new files or overwrite existing ones.
+
+```json title="neocode.json" {4}
+{
+  "$schema": "https://neo.khulnasoft.com/config.json",
+  "permission": {
+    "edit": "allow"
+  }
+}
+```
+
+Use this to allow the LLM to create new files. It will overwrite existing files if they already exist.
+
+:::note
+The `write` tool is controlled by the `edit` permission, which covers all file modifications (`edit`, `write`, `patch`, `multiedit`).
+:::
+
+---
+
+### read
+
+Read file contents from your codebase.
+
+```json title="neocode.json" {4}
+{
+  "$schema": "https://neo.khulnasoft.com/config.json",
+  "permission": {
+    "read": "allow"
+  }
+}
+```
+
+This tool reads files and returns their contents. It supports reading specific line ranges for large files.
+
+---
+
+### grep
+
+Search file contents using regular expressions.
+
+```json title="neocode.json" {4}
+{
+  "$schema": "https://neo.khulnasoft.com/config.json",
+  "permission": {
+    "grep": "allow"
+  }
+}
+```
+
+Fast content search across your codebase. Supports full regex syntax and file pattern filtering.
+
+---
+
+### glob
+
+Find files by pattern matching.
+
+```json title="neocode.json" {4}
+{
+  "$schema": "https://neo.khulnasoft.com/config.json",
+  "permission": {
+    "glob": "allow"
+  }
+}
+```
+
+Search for files using glob patterns like `**/*.js` or `src/**/*.ts`. Returns matching file paths sorted by modification time.
+
+---
+
+### list
+
+List files and directories in a given path.
+
+```json title="neocode.json" {4}
+{
+  "$schema": "https://neo.khulnasoft.com/config.json",
+  "permission": {
+    "list": "allow"
+  }
+}
+```
+
+This tool lists directory contents. It accepts glob patterns to filter results.
+
+---
+
+### lsp (experimental)
+
+Interact with your configured LSP servers to get code intelligence features like definitions, references, hover info, and call hierarchy.
+
+:::note
+This tool is only available when `NEOCODE_EXPERIMENTAL_LSP_TOOL=true` (or `NEOCODE_EXPERIMENTAL=true`).
+:::
+
+```json title="neocode.json" {4}
+{
+  "$schema": "https://neo.khulnasoft.com/config.json",
+  "permission": {
+    "lsp": "allow"
+  }
+}
+```
+
+Supported operations include `goToDefinition`, `findReferences`, `hover`, `documentSymbol`, `workspaceSymbol`, `goToImplementation`, `prepareCallHierarchy`, `incomingCalls`, and `outgoingCalls`.
+
+To configure which LSP servers are available for your project, see [LSP Servers](/docs/lsp).
+
+---
+
+### patch
+
+Apply patches to files.
+
+```json title="neocode.json" {4}
+{
+  "$schema": "https://neo.khulnasoft.com/config.json",
+  "permission": {
+    "edit": "allow"
+  }
+}
+```
+
+This tool applies patch files to your codebase. Useful for applying diffs and patches from various sources.
+
+:::note
+The `patch` tool is controlled by the `edit` permission, which covers all file modifications (`edit`, `write`, `patch`, `multiedit`).
+:::
+
+---
+
+### skill
+
+Load a [skill](/docs/skills) (a `SKILL.md` file) and return its content in the conversation.
+
+```json title="neocode.json" {4}
+{
+  "$schema": "https://neo.khulnasoft.com/config.json",
+  "permission": {
+    "skill": "allow"
+  }
+}
+```
+
+---
+
+### todowrite
+
+Manage todo lists during coding sessions.
+
+```json title="neocode.json" {4}
+{
+  "$schema": "https://neo.khulnasoft.com/config.json",
+  "permission": {
+    "todowrite": "allow"
+  }
+}
+```
+
+Creates and updates task lists to track progress during complex operations. The LLM uses this to organize multi-step tasks.
+
+:::note
+This tool is disabled for subagents by default, but you can enable it manually. [Learn more](/docs/agents/#permissions)
+:::
+
+---
+
+### todoread
+
+Read existing todo lists.
+
+```json title="neocode.json" {4}
+{
+  "$schema": "https://neo.khulnasoft.com/config.json",
+  "permission": {
+    "todoread": "allow"
+  }
+}
+```
+
+Reads the current todo list state. Used by the LLM to track what tasks are pending or completed.
+
+:::note
+This tool is disabled for subagents by default, but you can enable it manually. [Learn more](/docs/agents/#permissions)
+:::
+
+---
+
+### webfetch
+
+Fetch web content.
+
+```json title="neocode.json" {4}
+{
+  "$schema": "https://neo.khulnasoft.com/config.json",
+  "permission": {
+    "webfetch": "allow"
+  }
+}
+```
+
+Allows the LLM to fetch and read web pages. Useful for looking up documentation or researching online resources.
+
+---
+
+### question
+
+Ask the user questions during execution.
+
+```json title="neocode.json" {4}
+{
+  "$schema": "https://neo.khulnasoft.com/config.json",
+  "permission": {
+    "question": "allow"
+  }
+}
+```
+
+This tool allows the LLM to ask the user questions during a task. It's useful for:
+
+- Gathering user preferences or requirements
+- Clarifying ambiguous instructions
+- Getting decisions on implementation choices
+- Offering choices about what direction to take
+
+Each question includes a header, the question text, and a list of options. Users can select from the provided options or type a custom answer. When there are multiple questions, users can navigate between them before submitting all answers.
+
+---
+
+## Custom tools
+
+Custom tools let you define your own functions that the LLM can call. These are defined in your config file and can execute arbitrary code.
+
+[Learn more](/docs/custom-tools) about creating custom tools.
+
+---
+
+## MCP servers
+
+MCP (Model Context Protocol) servers allow you to integrate external tools and services. This includes database access, API integrations, and third-party services.
+
+[Learn more](/docs/mcp-servers) about configuring MCP servers.
+
+---
+
+## Internals
+
+Internally, tools like `grep`, `glob`, and `list` use [ripgrep](https://github.com/BurntSushi/ripgrep) under the hood. By default, ripgrep respects `.gitignore` patterns, which means files and directories listed in your `.gitignore` will be excluded from searches and listings.
+
+---
+
+### Ignore patterns
+
+To include files that would normally be ignored, create a `.ignore` file in your project root. This file can explicitly allow certain paths.
+
+```text title=".ignore"
+!node_modules/
+!dist/
+!build/
+```
+
+For example, this `.ignore` file allows ripgrep to search within `node_modules/`, `dist/`, and `build/` directories even if they're listed in `.gitignore`.