Cline に独自の指示を与えよう!「Custom Instructions」機能のご紹介

記事タイトルとURLをコピーする

こんにちは!サーバーワークスで生成AI活用推進を担当している針生と申します。

Cline の使い方ブログ第3弾です。

これまでのブログは以下をご覧ください。

  1. AWS Bedrockを利用したClineの始め方 - サーバーワークスエンジニアブログ

  2. Cline をもっと便利に!Auto-approve (自動承認)機能のご紹介 - サーバーワークスエンジニアブログ

今回は、Cline の Custom Instructions 機能についてご紹介します。

Custom Instructions とは?

Custom Instructions(カスタム指示)とは、Cline の基本的な動作を定義するための指示を設定する機能となります。

Custom Instructions でできること

では、具体的にどのようなことが可能になるのでしょうか?

  • コーディングスタイルの統一
    • 「インデントはスペース4つにしてください。」「変数名や関数名はスネークケース (snake_case) にしてください。」「クラス名はキャメルケース (CamelCase) にしてください。」といった、PEP 8 などの Python コーディング規約を Cline に遵守させることができます。
  • エラーハンドリング
    • 「I/O を行うコードを生成するときは、try/except で囲み、例外は logging.error() で記録してください。」といったエラーハンドリングの指示を設定できます。
  • ドキュメント自動生成
    • 「docstring を Google スタイルで記述してください。」といった指示により、コードのドキュメントを自動生成できます。

簡単な利用方法

  1. Cline 拡張機能を開きます
  2. 右上の歯車アイコン (⚙️) を選択
  3. 「Custom Instructions」 フィールドを探す
  4. 以下のような Markdown 文を貼り付ける
# コーディングスタイル

- インデントはスペース4つにしてください。
- 変数名や関数名はスネークケース (`snake_case`) にしてください。
- クラス名はキャメルケース (`CamelCase`) にしてください。

# エラーハンドリング

- I/O を行うコードを生成するときは、try/except で囲み、例外は logging.error() で記録してください。

# ドキュメント自動生成

- docstring を Google スタイルで記述してください。

保存すると即座に反映されます。

⚠️ 注意 ⚠️

設定を変更すると Cline の内部キャッシュがリセットされ、一時的に応答コストが上がります。タスク開始時などタイミングを見計らって更新しましょう。

プロジェクトで利用するには?

プロジェクトで開発する場合には、.clinerules ファイルをプロジェクトのルートディレクトリに作成することで、プロジェクト内での開発スタイルを管理することも可能です。

.clinerules ファイルを GitHub などで管理することで、プロジェクト内での開発スタイルを共有することが可能となります。

複数のファイルに分けて管理したい場合

.clinerules ファイルに全てのルールを記載していくと、ファイルが肥大化して管理が難しくなりがちになります。

そのような場合には、.clinerules ディレクトリを作成し、その中に各ファイルを作成することで、管理が容易になります。

your-project/
├── .clinerules/
│   ├── 01-coding.md
│   ├── 02-documentation.md
│   └── current-sprint.md
├── src/
└── ...

Cline はディレクトリ内のすべての Markdown ファイルを読み込み、統一されたルールセットにまとめます。

まとめ

Custom Instructions は、Cline を自分の開発スタイルやプロジェクトの開発要件に合わせて最適化するために有効な機能です。最初は簡単なルールから試してみて、徐々に開発スタイルに合わせた指示文を作り上げていきましょう!

では、Custom Instructions 機能を活用して、快適なバイブコーディングライフを!