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

✨ 主な機能

プロジェクトのアクティブ化と管理

1. プロジェクトの切り替え：

   uv run serena activate <project_name>
   

2. プロジェクトの削除：

   uv run serena delete-project <project_name>
   

ファイル操作

1. ファイルの作成：

   uv run serena create-file <filename>
   

2. ファイル内容の読み取り：

   uv run serena read-file <filepath>
   

3. ファイルの削除：

   uv run serena delete-file <filepath>
   

コード操作

1. シンボルの検索：

   uv run serena find-symbol <symbol_name>
   

2. コードスニペットの挿入：

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

3. コードセグメントの置換：

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

プロジェクトのビルドとテスト

1. テストの実行：

   uv run serena run-tests
   

2. プロジェクトのビルド：

   uv run serena build
   

🔧 カスタム設定

新しいツールの作成

1. 新しいツールクラスファイルの作成：new_tool.pyという名前のファイルを作成し、以下の内容を追加します。

   class NewTool(Tool):
       def apply(self, context: Context) -> Context:
           # ここにツールのロジックを実装します
           return context
   

2. 新しいツールの登録：
   • 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: 現在アクティブなプロジェクトの名前を取得し（存在する場合）、すべてのプロジェクトをリストします。