|
| 1 | +# language of the project (csharp, python, rust, java, typescript, go, cpp, or ruby) |
| 2 | +# * For C, use cpp |
| 3 | +# * For JavaScript, use typescript |
| 4 | +# Special requirements: |
| 5 | +# * csharp: Requires the presence of a .sln file in the project folder. |
| 6 | +language: python |
| 7 | + |
| 8 | +# whether to use the project's gitignore file to ignore files |
| 9 | +# Added on 2025-04-07 |
| 10 | +ignore_all_files_in_gitignore: true |
| 11 | +# list of additional paths to ignore |
| 12 | +# same syntax as gitignore, so you can use * and ** |
| 13 | +# Was previously called `ignored_dirs`, please update your config if you are using that. |
| 14 | +# Added (renamed)on 2025-04-07 |
| 15 | +ignored_paths: [] |
| 16 | + |
| 17 | +# whether the project is in read-only mode |
| 18 | +# If set to true, all editing tools will be disabled and attempts to use them will result in an error |
| 19 | +# Added on 2025-04-18 |
| 20 | +read_only: false |
| 21 | + |
| 22 | + |
| 23 | +# list of tool names to exclude. We recommend not excluding any tools, see the readme for more details. |
| 24 | +# Below is the complete list of tools for convenience. |
| 25 | +# To make sure you have the latest list of tools, and to view their descriptions, |
| 26 | +# execute `uv run scripts/print_tool_overview.py`. |
| 27 | +# |
| 28 | +# * `activate_project`: Activates a project by name. |
| 29 | +# * `check_onboarding_performed`: Checks whether project onboarding was already performed. |
| 30 | +# * `create_text_file`: Creates/overwrites a file in the project directory. |
| 31 | +# * `delete_lines`: Deletes a range of lines within a file. |
| 32 | +# * `delete_memory`: Deletes a memory from Serena's project-specific memory store. |
| 33 | +# * `execute_shell_command`: Executes a shell command. |
| 34 | +# * `find_referencing_code_snippets`: Finds code snippets in which the symbol at the given location is referenced. |
| 35 | +# * `find_referencing_symbols`: Finds symbols that reference the symbol at the given location (optionally filtered by type). |
| 36 | +# * `find_symbol`: Performs a global (or local) search for symbols with/containing a given name/substring (optionally filtered by type). |
| 37 | +# * `get_current_config`: Prints the current configuration of the agent, including the active and available projects, tools, contexts, and modes. |
| 38 | +# * `get_symbols_overview`: Gets an overview of the top-level symbols defined in a given file or directory. |
| 39 | +# * `initial_instructions`: Gets the initial instructions for the current project. |
| 40 | +# Should only be used in settings where the system prompt cannot be set, |
| 41 | +# e.g. in clients you have no control over, like Claude Desktop. |
| 42 | +# * `insert_after_symbol`: Inserts content after the end of the definition of a given symbol. |
| 43 | +# * `insert_at_line`: Inserts content at a given line in a file. |
| 44 | +# * `insert_before_symbol`: Inserts content before the beginning of the definition of a given symbol. |
| 45 | +# * `list_dir`: Lists files and directories in the given directory (optionally with recursion). |
| 46 | +# * `list_memories`: Lists memories in Serena's project-specific memory store. |
| 47 | +# * `onboarding`: Performs onboarding (identifying the project structure and essential tasks, e.g. for testing or building). |
| 48 | +# * `prepare_for_new_conversation`: Provides instructions for preparing for a new conversation (in order to continue with the necessary context). |
| 49 | +# * `read_file`: Reads a file within the project directory. |
| 50 | +# * `read_memory`: Reads the memory with the given name from Serena's project-specific memory store. |
| 51 | +# * `remove_project`: Removes a project from the Serena configuration. |
| 52 | +# * `replace_lines`: Replaces a range of lines within a file with new content. |
| 53 | +# * `replace_symbol_body`: Replaces the full definition of a symbol. |
| 54 | +# * `restart_language_server`: Restarts the language server, may be necessary when edits not through Serena happen. |
| 55 | +# * `search_for_pattern`: Performs a search for a pattern in the project. |
| 56 | +# * `summarize_changes`: Provides instructions for summarizing the changes made to the codebase. |
| 57 | +# * `switch_modes`: Activates modes by providing a list of their names |
| 58 | +# * `think_about_collected_information`: Thinking tool for pondering the completeness of collected information. |
| 59 | +# * `think_about_task_adherence`: Thinking tool for determining whether the agent is still on track with the current task. |
| 60 | +# * `think_about_whether_you_are_done`: Thinking tool for determining whether the task is truly completed. |
| 61 | +# * `write_memory`: Writes a named memory (for future reference) to Serena's project-specific memory store. |
| 62 | +excluded_tools: [] |
| 63 | + |
| 64 | +# initial prompt for the project. It will always be given to the LLM upon activating the project |
| 65 | +# (contrary to the memories, which are loaded on demand). |
| 66 | +initial_prompt: "" |
| 67 | + |
| 68 | +project_name: "setuptools_scm" |
0 commit comments