project.yml 8.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160
  1. # the name by which the project can be referenced within Serena/when chatting with the LLM.
  2. project_name: "01_langchain"
  3. # list of languages for which language servers are started (LSP backend only); choose from:
  4. # ada al angular ansible bash
  5. # bsl clojure cpp cpp_ccls crystal
  6. # csharp csharp_omnisharp cue dart elixir
  7. # elm erlang fortran fsharp gdscript
  8. # go groovy haskell haxe hlsl
  9. # html java json julia kotlin
  10. # latex lean4 lua luau markdown
  11. # matlab msl nix ocaml pascal
  12. # perl php php_phpactor php_phpantom powershell
  13. # python python_jedi python_pyrefly python_ty r
  14. # rego ruby ruby_solargraph rust scala
  15. # scss solidity svelte swift systemverilog
  16. # terraform toml typescript typescript_vts vue
  17. # yaml zig
  18. # (This list may be outdated; generated with scripts/print_language_list.py;
  19. # For the current list, see values of Language enum here:
  20. # https://github.com/oraios/serena/blob/main/src/solidlsp/ls_config.py)
  21. # For some languages, there are alternative language servers, e.g. csharp_omnisharp, ruby_solargraph.)
  22. # Note:
  23. # - For C, use cpp
  24. # - For JavaScript, use typescript
  25. # - For Angular projects, use angular (subsumes typescript+html; requires `npm install` in the project root)
  26. # - For Svelte projects, use svelte (subsumes typescript/javascript for .svelte projects; requires npm)
  27. # - For SCSS / Sass / plain CSS, use scss (some-sass-language-server handles all three)
  28. # - For Free Pascal/Lazarus, use pascal
  29. # Special requirements:
  30. # Some languages require additional setup/installations.
  31. # See here for details: https://oraios.github.io/serena/01-about/020_programming-languages.html#language-servers
  32. # When using multiple languages, the first language server that supports a given file will be used for that file.
  33. # The first language is the default language and the respective language server will be used as a fallback.
  34. # Note that when using the JetBrains backend, language servers are not used and this list is correspondingly ignored.
  35. languages:
  36. - python
  37. # the encoding used by text files in the project
  38. # For a list of possible encodings, see https://docs.python.org/3.11/library/codecs.html#standard-encodings
  39. encoding: "utf-8"
  40. # line ending convention to use when writing source files.
  41. # Possible values: unset (use global setting), "lf", "crlf", or "native" (platform default)
  42. # This does not affect Serena's own files (e.g. memories and configuration files), which always use native line endings.
  43. line_ending:
  44. # The language backend to use for this project.
  45. # If not set, the global setting from serena_config.yml is used.
  46. # Valid values: LSP, JetBrains
  47. # Note: the backend is fixed at startup. If a project with a different backend
  48. # is activated post-init, an error will be returned.
  49. language_backend:
  50. # whether to use project's .gitignore files to ignore files
  51. ignore_all_files_in_gitignore: true
  52. # advanced configuration option allowing to configure language server-specific options.
  53. # Maps the language key to the options.
  54. # The settings are considered only if the project is trusted (see global configuration to define trusted projects).
  55. # See https://oraios.github.io/serena/02-usage/050_configuration.html#language-server-specific-settings
  56. ls_specific_settings: {}
  57. # list of additional paths to ignore in this project.
  58. # Same syntax as gitignore, so you can use * and **.
  59. # Note: global ignored_paths from serena_config.yml are also applied additively.
  60. ignored_paths: []
  61. # whether the project is in read-only mode
  62. # If set to true, all editing tools will be disabled and attempts to use them will result in an error
  63. # Added on 2025-04-18
  64. read_only: false
  65. # list of tool names to exclude.
  66. # This extends the existing exclusions (e.g. from the global configuration)
  67. # Find the list of tools here: https://oraios.github.io/serena/01-about/035_tools.html
  68. excluded_tools: []
  69. # list of tools to include that would otherwise be disabled (particularly optional tools that are disabled by default).
  70. # This extends the existing inclusions (e.g. from the global configuration).
  71. # Find the list of tools here: https://oraios.github.io/serena/01-about/035_tools.html
  72. included_optional_tools: []
  73. # fixed set of tools to use as the base tool set (if non-empty), replacing Serena's default set of tools.
  74. # This cannot be combined with non-empty excluded_tools or included_optional_tools.
  75. # Find the list of tools here: https://oraios.github.io/serena/01-about/035_tools.html
  76. fixed_tools: []
  77. # list of mode names that are to be activated by default, overriding the setting in the global configuration.
  78. # The full set of modes to be activated is base_modes (from global config) + default_modes + added_modes.
  79. # If the setting is undefined/empty, the default_modes from the global configuration (serena_config.yml) apply.
  80. # Otherwise, this overrides the setting from the global configuration (serena_config.yml).
  81. # Therefore, you can set this to [] if you do not want the default modes defined in the global config to apply
  82. # for this project.
  83. # This setting can, in turn, be overridden by CLI parameters (--mode).
  84. # See https://oraios.github.io/serena/02-usage/050_configuration.html#modes
  85. default_modes:
  86. # list of mode names to be activated additionally for this project, e.g. ["query-projects"]
  87. # The full set of modes to be activated is base_modes (from global config) + default_modes + added_modes.
  88. # See https://oraios.github.io/serena/02-usage/050_configuration.html#modes
  89. added_modes:
  90. # initial prompt for the project. It will always be given to the LLM upon activating the project
  91. # (contrary to the memories, which are loaded on demand).
  92. initial_prompt: ""
  93. # time budget (seconds) per tool call for the retrieval of additional symbol information
  94. # such as docstrings or parameter information.
  95. # This overrides the corresponding setting in the global configuration; see the documentation there.
  96. # If null or missing, use the setting from the global configuration.
  97. symbol_info_budget:
  98. # list of regex patterns which, when matched, mark a memory entry as read‑only.
  99. # Extends the list from the global configuration, merging the two lists.
  100. read_only_memory_patterns: []
  101. # list of regex patterns for memories to completely ignore.
  102. # Matching memories will not appear in list_memories or activate_project output
  103. # and cannot be accessed via read_memory or write_memory.
  104. # To access ignored memory files, use the read_file tool on the raw file path.
  105. # Extends the list from the global configuration, merging the two lists.
  106. # Example: ["_archive/.*", "_episodes/.*"]
  107. ignored_memory_patterns: []
  108. # list of additional workspace folder paths for cross-package reference support.
  109. # Paths can be absolute or relative to the project root.
  110. # Each folder is registered as an LSP workspace folder, enabling language servers to discover
  111. # symbols and references across package boundaries, but these folders are not indexed by Serena,
  112. # i.e. the respective symbols will not be found using Serena's symbol search tools.
  113. # Example:
  114. # additional_workspace_folders:
  115. # - ../sibling-package
  116. # - ../shared-lib
  117. ls_additional_workspace_folders: []
  118. # list of workspace folder paths (LSP backend only).
  119. # These folders will be used to build up Serena's symbol index.
  120. # Paths must be within the project root and should thus be relative to the project root.
  121. # Furthermore, the paths should not be filtered by ignore settings.
  122. # Default setting: The entire project root folder (".") is considered.
  123. # In (large) monorepos, this can be used to index only subfolders of the project root, e.g.
  124. # ls_workspace_folders:
  125. # - "./subproject1"
  126. # - "./subproject2"
  127. ls_workspace_folders:
  128. - .
  129. # optional shell command to run before the language backend (LSP or JetBrains) is initialised.
  130. # the command runs in the project root directory and is only executed if the project is trusted
  131. # (see trusted_project_path_patterns in the global configuration).
  132. # serena waits for the command to exit: a non-zero exit code is logged as an error but does not
  133. # abort activation. a per-project timeout (activation_command_timeout, default 180s) is the safety
  134. # backstop for non-terminating commands; on expiry the process is killed and activation continues.
  135. # example: activation_command: "npx nx run-many -t build"
  136. activation_command:
  137. # maximum time in seconds to wait for activation_command to complete before killing it (default 180s).
  138. # must be a positive number.
  139. activation_command_timeout: 180.0