mirror of
https://github.com/tiennm99/serena.git
synced 2026-10-13 18:16:10 +00:00
docs: correct configuration key names and typos
This commit is contained in:
1 parent
941f4ded18
commit
4b726894d0
4 files changed
+9
-7
No files matched your search
@@ -42,7 +42,7 @@ Some languages require additional installations or setup steps, as noted.
|
||||
subsumes `typescript` and `html` for `.ts`/`.html` files, so do not also list those)
|
||||
* **Ansible**
|
||||
(experimental; requires Node.js and npm; automatically installs `@ansible/ansible-language-server`;
|
||||
must be explicitly specified in the `languages` entry in the `project.yml`; requires `ansible` in PATH for full functionality)
|
||||
must be explicitly specified in the `language_servers` entry in the `project.yml`; requires `ansible` in PATH for full functionality;
|
||||
the upstream `@ansible/ansible-language-server@1.2.3` supports hover, completion, definition,
|
||||
semantic tokens, and validation; document symbols, workspace symbols, references, and rename
|
||||
are not supported by this version)
|
||||
@@ -51,7 +51,7 @@ Some languages require additional installations or setup steps, as noted.
|
||||
(requires Java 21+ on PATH; uses [bsl-language-server](https://github.com/1c-syntax/bsl-language-server) by 1c-syntax; the JAR is auto-downloaded and SHA-256-verified for the bundled default version; supports `.bsl` and `.os` files; configure optional `ls_path` or `bsl_ls_version` under `ls_specific_settings.bsl`)
|
||||
* **C#**
|
||||
(by default, uses the Roslyn language server (language `csharp`), requiring [.NET v10+](https://dotnet.microsoft.com/en-us/download/dotnet) and, on Windows, `pwsh` ([PowerShell 7+](https://learn.microsoft.com/en-us/powershell/scripting/install/install-powershell-on-windows?view=powershell-7.5));
|
||||
set language to `csharp_omnisharp` to use OmiSharp instead)
|
||||
set language to `csharp_omnisharp` to use OmniSharp instead)
|
||||
* **C/C++**
|
||||
(by default, uses the clangd language server (language `cpp`) but we also support ccls (language `cpp_ccls`);
|
||||
for best results, provide a `compile_commands.json` at the repository root;
|
||||
|
||||
@@ -124,8 +124,8 @@ When using Serena, we highly recommend that you start CC as
|
||||
claude --system-prompt="$(serena prompts print-cc-system-prompt-override)"
|
||||
```
|
||||
|
||||
You can also consider adding the content of `serena cc-system-prompt-override` to your `CLAUDE.md` files,
|
||||
but the effect be insufficient for counteracting Claude Code's bias towards internal tools.
|
||||
You can also consider adding the content of `serena prompts print-cc-system-prompt-override` to your `CLAUDE.md` files,
|
||||
but the effect may be insufficient for counteracting Claude Code's bias towards internal tools.
|
||||
:::
|
||||
|
||||
**Global Configuration**. To add the Serena MCP server for all your projects, use the user-level configuration of claude code and the `--project-from-cwd` flag:
|
||||
|
||||
@@ -269,7 +269,7 @@ This ensures backward compatibility: existing projects that already have a `.ser
|
||||
Most users will not need to adjust these settings.
|
||||
:::
|
||||
|
||||
Under the key `ls_specific_settings` in `serena_config.yml`, you can you pass global per-language,
|
||||
Under the key `ls_specific_settings` in `serena_config.yml`, you can pass global per-language,
|
||||
language server-specific configuration.
|
||||
|
||||
You can use the same key in the project configuration files (`project.yml`
|
||||
|
||||
@@ -40,8 +40,10 @@ You can customize this location via project settings:
|
||||
```yaml
|
||||
# .serena/project.yml
|
||||
language_servers:
|
||||
- cpp
|
||||
ls_specific_settings:
|
||||
cpp:
|
||||
compile_commands_dir: custom/rel/path (defaults to .serena)
|
||||
compile_commands_dir: custom/rel/path # defaults to .serena
|
||||
```
|
||||
|
||||
### With ccls
|
||||
@@ -76,7 +78,7 @@ choco install ccls
|
||||
#### Configuration
|
||||
|
||||
After installing ccls, configure Serena to use it via project settings (in `.serena/project.yml`)
|
||||
by adding `cpp_ccls` to the `languages` list. Replace `cpp` with `cpp_ccls` if you already have the `cpp` entry.
|
||||
by adding `cpp_ccls` to the `language_servers` list. Replace `cpp` with `cpp_ccls` if you already have the `cpp` entry.
|
||||
|
||||
ccls can handle relative paths in `compile_commands.json`, so no transformation is necessary
|
||||
and no transformed `compile_commands.json` file will be created.
|
||||
|
||||
Reference in new issue
Block a user