project.yml 7.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124
  1. # whether to use the project's gitignore file to ignore files
  2. # Added on 2025-04-07
  3. ignore_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
  8. ignored_paths: []
  9. # whether the project is in read-only mode
  10. # If set to true, all editing tools will be disabled and attempts to use them will result in an error
  11. # Added on 2025-04-18
  12. read_only: false
  13. # list of tool names to exclude. We recommend not excluding any tools, see the readme for more details.
  14. # Below is the complete list of tools for convenience.
  15. # To make sure you have the latest list of tools, and to view their descriptions,
  16. # execute `uv run scripts/print_tool_overview.py`.
  17. #
  18. # * `activate_project`: Activates a project by name.
  19. # * `check_onboarding_performed`: Checks whether project onboarding was already performed.
  20. # * `create_text_file`: Creates/overwrites a file in the project directory.
  21. # * `delete_lines`: Deletes a range of lines within a file.
  22. # * `delete_memory`: Deletes a memory from Serena's project-specific memory store.
  23. # * `execute_shell_command`: Executes a shell command.
  24. # * `find_referencing_code_snippets`: Finds code snippets in which the symbol at the given location is referenced.
  25. # * `find_referencing_symbols`: Finds symbols that reference the symbol at the given location (optionally filtered by type).
  26. # * `find_symbol`: Performs a global (or local) search for symbols with/containing a given name/substring (optionally filtered by type).
  27. # * `get_current_config`: Prints the current configuration of the agent, including the active and available projects, tools, contexts, and modes.
  28. # * `get_symbols_overview`: Gets an overview of the top-level symbols defined in a given file.
  29. # * `initial_instructions`: Gets the initial instructions for the current project.
  30. # Should only be used in settings where the system prompt cannot be set,
  31. # e.g. in clients you have no control over, like Claude Desktop.
  32. # * `insert_after_symbol`: Inserts content after the end of the definition of a given symbol.
  33. # * `insert_at_line`: Inserts content at a given line in a file.
  34. # * `insert_before_symbol`: Inserts content before the beginning of the definition of a given symbol.
  35. # * `list_dir`: Lists files and directories in the given directory (optionally with recursion).
  36. # * `list_memories`: Lists memories in Serena's project-specific memory store.
  37. # * `onboarding`: Performs onboarding (identifying the project structure and essential tasks, e.g. for testing or building).
  38. # * `prepare_for_new_conversation`: Provides instructions for preparing for a new conversation (in order to continue with the necessary context).
  39. # * `read_file`: Reads a file within the project directory.
  40. # * `read_memory`: Reads the memory with the given name from Serena's project-specific memory store.
  41. # * `remove_project`: Removes a project from the Serena configuration.
  42. # * `replace_lines`: Replaces a range of lines within a file with new content.
  43. # * `replace_symbol_body`: Replaces the full definition of a symbol.
  44. # * `restart_language_server`: Restarts the language server, may be necessary when edits not through Serena happen.
  45. # * `search_for_pattern`: Performs a search for a pattern in the project.
  46. # * `summarize_changes`: Provides instructions for summarizing the changes made to the codebase.
  47. # * `switch_modes`: Activates modes by providing a list of their names
  48. # * `think_about_collected_information`: Thinking tool for pondering the completeness of collected information.
  49. # * `think_about_task_adherence`: Thinking tool for determining whether the agent is still on track with the current task.
  50. # * `think_about_whether_you_are_done`: Thinking tool for determining whether the task is truly completed.
  51. # * `write_memory`: Writes a named memory (for future reference) to Serena's project-specific memory store.
  52. excluded_tools:
  53. - "check_onboarding_performed"
  54. - "execute_shell_command"
  55. - "initial_instructions"
  56. - "onboarding"
  57. - "prepare_for_new_conversation"
  58. - "read_memory"
  59. - "write_memory"
  60. - "list_memories"
  61. - "delete_memory"
  62. # initial prompt for the project. It will always be given to the LLM upon activating the project
  63. # (contrary to the memories, which are loaded on demand).
  64. initial_prompt: ""
  65. # the name by which the project can be referenced within Serena
  66. project_name: "growi"
  67. # list of mode names to that are always to be included in the set of active modes
  68. # The full set of modes to be activated is base_modes + default_modes.
  69. # If the setting is undefined, the base_modes from the global configuration (serena_config.yml) apply.
  70. # Otherwise, this setting overrides the global configuration.
  71. # Set this to [] to disable base modes for this project.
  72. # Set this to a list of mode names to always include the respective modes for this project.
  73. base_modes:
  74. # list of mode names that are to be activated by default.
  75. # The full set of modes to be activated is base_modes + default_modes.
  76. # If the setting is undefined, the default_modes from the global configuration (serena_config.yml) apply.
  77. # Otherwise, this overrides the setting from the global configuration (serena_config.yml).
  78. # This setting can, in turn, be overridden by CLI parameters (--mode).
  79. default_modes:
  80. # list of tools to include that would otherwise be disabled (particularly optional tools that are disabled by default)
  81. included_optional_tools: []
  82. # fixed set of tools to use as the base tool set (if non-empty), replacing Serena's default set of tools.
  83. # This cannot be combined with non-empty excluded_tools or included_optional_tools.
  84. fixed_tools: []
  85. # the encoding used by text files in the project
  86. # For a list of possible encodings, see https://docs.python.org/3.11/library/codecs.html#standard-encodings
  87. encoding: utf-8
  88. # list of languages for which language servers are started; choose from:
  89. # al bash clojure cpp csharp
  90. # csharp_omnisharp dart elixir elm erlang
  91. # fortran fsharp go groovy haskell
  92. # java julia kotlin lua markdown
  93. # matlab nix pascal perl php
  94. # powershell python python_jedi r rego
  95. # ruby ruby_solargraph rust scala swift
  96. # terraform toml typescript typescript_vts vue
  97. # yaml zig
  98. # (This list may be outdated. For the current list, see values of Language enum here:
  99. # https://github.com/oraios/serena/blob/main/src/solidlsp/ls_config.py
  100. # For some languages, there are alternative language servers, e.g. csharp_omnisharp, ruby_solargraph.)
  101. # Note:
  102. # - For C, use cpp
  103. # - For JavaScript, use typescript
  104. # - For Free Pascal/Lazarus, use pascal
  105. # Special requirements:
  106. # Some languages require additional setup/installations.
  107. # See here for details: https://oraios.github.io/serena/01-about/020_programming-languages.html#language-servers
  108. # When using multiple languages, the first language server that supports a given file will be used for that file.
  109. # The first language is the default language and the respective language server will be used as a fallback.
  110. # Note that when using the JetBrains backend, language servers are not used and this list is correspondingly ignored.
  111. languages:
  112. - typescript