Serena

🚀 如何使用Serena

Serena是一款功能強大的工具，可幫助用戶高效地進行項目管理、文件操作、代碼操作等。本指南將詳細介紹如何安裝、使用和配置Serena。

🚀 快速開始

📦 安裝和初始化

1. 安裝依賴：請按照INSTALL.md文件中的說明完成Python、Node.js和Yarn的安裝。
2. 創建虛擬環境並安裝包：

   python -m venv .venv && source .venv/bin/activate  # 在macOS/Linux下
   pip install -r requirements.txt
   

3. 初始化項目：

   uv init your_project_name
   cd your_project_name
   

⚙️ 啟動語言服務

在項目目錄中運行以下命令啟動Serena的語言服務：

uv run serena

💻 使用示例

項目激活與管理

• 切換項目：

  uv run serena activate <project_name>
  

• 刪除項目：

  uv run serena delete-project <project_name>
  

文件操作

• 創建文件：

  uv run serena create-file <filename>
  

• 讀取文件內容：

  uv run serena read-file <filepath>
  

• 刪除文件：

  uv run serena delete-file <filepath>
  

代碼操作

• 查找符號：

  uv run serena find-symbol <symbol_name>
  

• 插入代碼片段：

  uv run serena insert-code <position> --content <code_content>
  

• 替換代碼段：

  uv run serena replace-lines <start_line>:<end_line> --content <new_content>
  

項目構建與測試

• 運行測試：

  uv run serena run-tests
  

• 構建項目：

  uv run serena build
  

⚙️ 自定義配置

創建新工具

• 創建新的工具類文件，命名為new_tool.py，添加以下內容：

  class NewTool(Tool):
      def apply(self, context: Context) -> Context:
          # 在此處實現工具邏輯
          return context
  

• 註冊新工具：
  • 修改serena/agent/tools/__init__.py文件，添加以下內容：

    from .new_tool import NewTool
    
    __all__ = ['NewTool']
    

🛠️ 故障排除

問題排查步驟

1. 檢查日誌：查看語言服務的輸出日誌以獲取更多信息。
2. 重新啟動服務：

uv run serena restart-language-server

3. 重新初始化項目：

uv init your_project_name

📚 詳細文檔

完整工具列表

以下是Serena的所有工具及其簡要描述（通過運行uv run serena-list-tools獲得）：

• activate_project：激活指定名稱的項目。
• check_onboarding_performed：檢查是否已經完成初始化流程。
• create_text_file：創建/覆蓋項目目錄中的文件。
• delete_lines：刪除文件中指定範圍內的行。
• delete_memory：從Serena的項目特定存儲中刪除記憶。
• execute_shell_command：執行shell命令。
• find_referencing_code_snippets：查找引用給定位置符號的代碼片段。
• find_referencing_symbols：查找引用給定位置符號的其他符號（可選過濾類型）。
• find_symbol：在項目中全局或局部搜索名稱包含指定字符串的符號。
• get_active_project：獲取當前激活項目的名稱（如果有），並列出所有項目。