1- # whether to use the project's gitignore file to ignore files
2- # Added on 2025-04-07
1+
2+ # whether to use project's .gitignore files to ignore files
33ignore_all_files_in_gitignore : true
4- # list of additional paths to ignore
5- # same syntax as gitignore, so you can use * and **
6- # Was previously called `ignored_dirs`, please update your config if you are using that .
7- # Added (renamed) on 2025-04-07
4+
5+ # list of additional paths to ignore in this project.
6+ # Same syntax as gitignore, so you can use * and ** .
7+ # Note: global ignored_paths from serena_config.yml are also applied additively.
88ignored_paths : []
99
1010# whether the project is in read-only mode
1111# If set to true, all editing tools will be disabled and attempts to use them will result in an error
1212# Added on 2025-04-18
1313read_only : false
1414
15-
16- # list of tool names to exclude. We recommend not excluding any tools, see the readme for more details.
17- # Below is the complete list of tools for convenience.
18- # To make sure you have the latest list of tools, and to view their descriptions,
19- # execute `uv run scripts/print_tool_overview.py`.
20- #
21- # * `activate_project`: Activates a project by name.
22- # * `check_onboarding_performed`: Checks whether project onboarding was already performed.
23- # * `create_text_file`: Creates/overwrites a file in the project directory.
24- # * `delete_lines`: Deletes a range of lines within a file.
25- # * `delete_memory`: Deletes a memory from Serena's project-specific memory store.
26- # * `execute_shell_command`: Executes a shell command.
27- # * `find_referencing_code_snippets`: Finds code snippets in which the symbol at the given location is referenced.
28- # * `find_referencing_symbols`: Finds symbols that reference the symbol at the given location (optionally filtered by type).
29- # * `find_symbol`: Performs a global (or local) search for symbols with/containing a given name/substring (optionally filtered by type).
30- # * `get_current_config`: Prints the current configuration of the agent, including the active and available projects, tools, contexts, and modes.
31- # * `get_symbols_overview`: Gets an overview of the top-level symbols defined in a given file.
32- # * `initial_instructions`: Gets the initial instructions for the current project.
33- # Should only be used in settings where the system prompt cannot be set,
34- # e.g. in clients you have no control over, like Claude Desktop.
35- # * `insert_after_symbol`: Inserts content after the end of the definition of a given symbol.
36- # * `insert_at_line`: Inserts content at a given line in a file.
37- # * `insert_before_symbol`: Inserts content before the beginning of the definition of a given symbol.
38- # * `list_dir`: Lists files and directories in the given directory (optionally with recursion).
39- # * `list_memories`: Lists memories in Serena's project-specific memory store.
40- # * `onboarding`: Performs onboarding (identifying the project structure and essential tasks, e.g. for testing or building).
41- # * `prepare_for_new_conversation`: Provides instructions for preparing for a new conversation (in order to continue with the necessary context).
42- # * `read_file`: Reads a file within the project directory.
43- # * `read_memory`: Reads the memory with the given name from Serena's project-specific memory store.
44- # * `remove_project`: Removes a project from the Serena configuration.
45- # * `replace_lines`: Replaces a range of lines within a file with new content.
46- # * `replace_symbol_body`: Replaces the full definition of a symbol.
47- # * `restart_language_server`: Restarts the language server, may be necessary when edits not through Serena happen.
48- # * `search_for_pattern`: Performs a search for a pattern in the project.
49- # * `summarize_changes`: Provides instructions for summarizing the changes made to the codebase.
50- # * `switch_modes`: Activates modes by providing a list of their names
51- # * `think_about_collected_information`: Thinking tool for pondering the completeness of collected information.
52- # * `think_about_task_adherence`: Thinking tool for determining whether the agent is still on track with the current task.
53- # * `think_about_whether_you_are_done`: Thinking tool for determining whether the task is truly completed.
54- # * `write_memory`: Writes a named memory (for future reference) to Serena's project-specific memory store.
15+ # list of tool names to exclude.
16+ # This extends the existing exclusions (e.g. from the global configuration)
17+ # Find the list of tools here: https://oraios.github.io/serena/01-about/035_tools.html
5518excluded_tools : []
5619
5720# initial prompt for the project. It will always be given to the LLM upon activating the project
@@ -68,18 +31,24 @@ project_name: "llm-ts-example"
6831# Set this to a list of mode names to always include the respective modes for this project.
6932base_modes :
7033
71- # list of mode names that are to be activated by default.
72- # The full set of modes to be activated is base_modes + default_modes.
73- # If the setting is undefined, the default_modes from the global configuration (serena_config.yml) apply.
34+ # list of mode names that are to be activated by default, overriding the setting in the global configuration .
35+ # The full set of modes to be activated is base_modes (from global config) + default_modes + added_modes .
36+ # If the setting is undefined/empty , the default_modes from the global configuration (serena_config.yml) apply.
7437# Otherwise, this overrides the setting from the global configuration (serena_config.yml).
38+ # Therefore, you can set this to [] if you do not want the default modes defined in the global config to apply
39+ # for this project.
7540# This setting can, in turn, be overridden by CLI parameters (--mode).
41+ # See https://oraios.github.io/serena/02-usage/050_configuration.html#modes
7642default_modes :
7743
78- # list of tools to include that would otherwise be disabled (particularly optional tools that are disabled by default)
44+ # list of tools to include that would otherwise be disabled (particularly optional tools that are disabled by default).
45+ # This extends the existing inclusions (e.g. from the global configuration).
46+ # Find the list of tools here: https://oraios.github.io/serena/01-about/035_tools.html
7947included_optional_tools : []
8048
8149# fixed set of tools to use as the base tool set (if non-empty), replacing Serena's default set of tools.
8250# This cannot be combined with non-empty excluded_tools or included_optional_tools.
51+ # Find the list of tools here: https://oraios.github.io/serena/01-about/035_tools.html
8352fixed_tools : []
8453
8554# the encoding used by text files in the project
@@ -88,15 +57,18 @@ encoding: utf-8
8857
8958
9059# list of languages for which language servers are started; choose from:
91- # al bash clojure cpp csharp
92- # csharp_omnisharp dart elixir elm erlang
93- # fortran fsharp go groovy haskell
94- # java julia kotlin lua markdown
95- # matlab nix pascal perl php
96- # powershell python python_jedi r rego
97- # ruby ruby_solargraph rust scala swift
98- # terraform toml typescript typescript_vts vue
99- # yaml zig
60+ # al ansible bash clojure cpp
61+ # cpp_ccls crystal csharp csharp_omnisharp dart
62+ # elixir elm erlang fortran fsharp
63+ # go groovy haskell haxe hlsl
64+ # java json julia kotlin lean4
65+ # lua luau markdown matlab msl
66+ # nix ocaml pascal perl php
67+ # php_phpactor powershell python python_jedi python_ty
68+ # r rego ruby ruby_solargraph rust
69+ # scala solidity swift systemverilog terraform
70+ # toml typescript typescript_vts vue yaml
71+ # zig
10072# (This list may be outdated. For the current list, see values of Language enum here:
10173# https://github.com/oraios/serena/blob/main/src/solidlsp/ls_config.py
10274# For some languages, there are alternative language servers, e.g. csharp_omnisharp, ruby_solargraph.)
@@ -148,3 +120,8 @@ ignored_memory_patterns: []
148120# Have a look at the docstring of the constructors of the LS implementations within solidlsp (e.g., for C# or PHP) to see which options are available.
149121# No documentation on options means no options are available.
150122ls_specific_settings : {}
123+
124+ # list of mode names to be activated additionally for this project, e.g. ["query-projects"]
125+ # The full set of modes to be activated is base_modes (from global config) + default_modes + added_modes.
126+ # See https://oraios.github.io/serena/02-usage/050_configuration.html#modes
127+ added_modes :
0 commit comments