Skip to content

STXImamura/how_to_use_codewhisker

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 

Repository files navigation

はじめに

CodeWhiskerとは何か?

プログラマーの日々の作業をサポートするために開発されたVSCode拡張機能です。
AIの力を借りて、コードの品質向上を目指し、より効率的な開発を可能にします。

特徴

  • AIチャットサポート: サイドバーからAIとコーディングに関する話題でチャットができます。
  • AIによる評価機能: 右クリックメニューより、品質向上に役立つ様々な機能を提供します。
    • レビュー: コードのレビューをAIに依頼できます。
    • バグ探索: 潜在的なバグをAIが探し出します。
    • 説明: コードの動作についての説明を受けられます。
    • 最適化: コードの最適化提案を受けられます。
    • 議論: コードについてAIと議論できます。
    • テストコード生成: テストコードの作成をAIに依頼できます。
    • 関数コメント生成: 選択したテキスト範囲に対する関数コメントをAIが考えます。
    • 翻訳: 選択したテキストをAIに翻訳してもらえます。
  • 対応API: 以下のAPIが利用可能です。
    • OpenAI
    • Claude
    • Gemini
    • Ollama (ローカルで起動できる言語モデル(LLM)サーバー)

AIの利用には利用料金がかかります

OpenAI/Claude3/GeminiのAPIは利用料金がかかります。
Geminiはプランにより制限の多い無料プラン、制限が緩和された有料プランがあります。 Ollamaはローカルに大規模言語モデルのサーバーを立てるため無料で利用できますが、他の2つと比べると精度が著しく低く、 本格的に利用するには、他のAIを利用するのがよいでしょう。
Geminiの無料プランでもgemini-1.5-flashは制限も軽く利用しやすいです。ただし無料プランは学習される可能性があるため、パスワードなどが紛れ込まないように注意してください。

VSCodeのインストール方法

VSCodeとは

VSCodeはMicrosoftが提供する無料のコードエディタで、多くのプログラミング言語に対応しており、拡張機能も世界中で開発されています。
様々なサービスがVSCodeに対応しているため、今のソフトウェア開発では必須と呼べるエディタになっています。

インストール

  1. Visual Studio Codeの 公式サイト にアクセスします。
  2. Downloadページへ遷移して、自分の環境に適したインストーラーをダウンロードします。
    頻繁にアップデートがあるため、ZIP版よりも自動更新されるインストーラー版を使ったほうがよいでしょう。

日本語化

まずは日本語化の拡張機能を入れましょう。VSCodeを起動します。
サイドバーにある拡張機能のアイコンから、マーケットプレイスを開き、機能を検索してインストール出来ます。
ここでは「Japanese Language Pack」を入力し、検索結果を選択、インストールを行います。
インストール後、再起動すると日本語化されます。

日本語化

CodeWhiskerのインストール

同様にマーケットプレイスから、「CodeWhisker」を検索しインストールします。 CodeWhisker

APIキーの発行とチャージ

Ollama以外のAPIの利用には料金がかかります。
事前にアカウントを作成し、APIキーの取得とAPIの使用料をチャージしておく必要があります。
そこから使用した分だけ消費される従量制になっています。

OpenAIの場合

アカウントの作成

  1. OpenAIのAPIのページから、Product > API Loginのページへ遷移します。
    サインアップを選び手順を進めてアカウントを作成してください。

  2. ChatGPTかAPIか選択する画面が出た場合は、APIを選びます。

支払いの設定

  1. アカウントを作成すると、$5分のクレジットがもらえるらしいので、まずはそれを利用しましょう。

  2. クレジットがない場合は、支払いの設定をしてしまいましょう。サイドバーのSettings(歯車アイコン) > Billing画面へ遷移します。

  3. "Payment methods" からクレジットカードの登録を行います。

  4. "Add to credit balance"で、クレジットをチャージします。ドルでの支払いになるので注意してください。
    1000円のつもりで1000と入力しないように!

APIキーの発行

  1. APIキーの発行は、サイドバーのAPI Keys(錠前アイコン) から行います。

  2. "+ Create new secret key" を選択して、API KEYを発行します。
    名前は管理上の名前なので好きに入力してください。
    ここで発行されたキーは2度と確認することができないので大切に保存してください。

anthropic(Claude3)の場合

アカウントの作成

  1. anthropicのAPIのページから、Get started now > ログインページへ遷移します。
    emailを入力し、手順をすすめてアカウントを作成してください。

支払いの設定

  1. アカウントを作成すると、評価ユーザーとして$5分のクレジットがもらえるので、まずはそれを利用しましょう。
  2. 有料ユーザーになるには、右上のユーザーアイコンから開けるメニューの"Plans & Billing"からプランをビルドプラン以上にアップグレードする必要があります。

APIキーの発行

  1. メニューの"API Keys"から、"Create Key"で発行します。 発行したキーは2度と確認することができないので大切に保存してください。

Google(Gemini)の場合

アカウントの作成

  1. Googleのアカウントを使います。アカウントが未作成の場合は、ログイン > アカウントの作成を行います。

APIキーの発行

  1. Google AI Studioへアクセスし、Get API Keyを選択します。
  2. APIキーを作成 > 新しいプロジェクトでAPIキーを作成 を選択することで、APIキーが発行されます。

支払いの設定

  1. Settings > Plan Information から作成したプロジェクトのプランを有料に変更することができます。
  2. 支払いはリンク先からGoogleアカウントを選択し、アカウントに紐づけられた支払い設定が利用できます。

CodeWhiskerの使い方

CodeWhiskerの起動

VSCodeのサイドバーをCodeWhiskerに切り替えます。 codewhisker

CodeWhiskerの設定

APIキーの登録(OpenAI / Claude / Gemini)

CodeWhiskerのメニューから、取得したAPIキーに対応する〇〇API Keyを選択します。
入力ボックスが表示されますので、APIキーを登録してください。

APIキーの登録

言語モデルの選択

CodeWhiskerのメニューから設定を選択し、VSCodeの設定画面を表示します。
ここで登録したAPIキーに合わせて、利用する言語モデルを指定します。
モデルの選択

AIとチャットしてみる

CodeWhiskerの下部にあるテキストボックスからAIと会話ができます。まずは挨拶してみましょう。
挨拶

各種評価機能

エディタの右クリックメニューから、様々な機能が呼び出せます。
ファイル全体、もしくは選択範囲が対象になります。

  • レビュー: コードのレビューをAIに依頼できます。
  • バグ探索: 潜在的なバグをAIが探し出します。
  • 説明: コードの内容や、エラーメッセージについての説明を受けられます。
  • 最適化: コードの最適化提案を受けられます。
  • 議論: コードについてAIと議論できます。例えば修正依頼をしたり、メソッドの実装をお願いしたり、 更には言語のコンバージョンなども依頼できたりします。
  • テストコード生成: テストコードの作成をAIに依頼できます。
  • 関数コメント生成: 選択したテキスト範囲に対する関数コメントをAIが考えます。
  • 翻訳: 選択したテキストをAIに翻訳してもらえます。
  • ファイルの添付: 参照させたいファイルが他にある場合(クラス定義など)、追加の情報として与えると生成の精度が上がります。

コンテキストメニュー また、自分がよく使う指示をカスタム命令として登録しておき、メニューから呼び出すことができます。

クイックフィックス機能

問題パネルの右クリックメニューから、解決方法を調べてもらうことができます。
問題パネルにエラーを出力するには、VSCodeの各言語に対応した拡張機能を入れる必要があります。

クイックフィックス

利用料(2024/8時点) 100万トークンあたり

トークンとは、AIへの指示や、応答のテキストのことです。
日本語であればほぼ1文字、英語なら数文字という単位になります。

OpenAI(GPT)

Model 入力 出力 おすすめ
gpt-4o $5.00 $15.00
gpt-4o-2024-08-06 $2.50 $10.00
gpt-4o-mini $0.15 $0.6
gpt-4-turbo-2024-04-09 $10.00 $30.00
gpt-4-0125-preview $10.00 $30.00
gpt-4-1106-preview $10.00 $30.00
gpt-4 $30.00 $60.00
gpt-4-32k $30.00 $120.00
gpt-3.5-turbo-0125 $0.50 $1.50

Anthropic(Claude)

Model 入力 出力 おすすめ
Claude 3.5 Sonnet $3.00 $15.00
Claude 3 Opus $15.00 $75.00
Claude 3 Sonnet $3.00 $15.00
Claude 3 Haiku $0.25 $1.25

Google(Gemini)

Model 入力 出力 おすすめ
gemini-1.5-pro $3.50 $7.00
gemini-1.5-pro-exp-0801 $3.50 $7.00
gemini-1.5-pro-exp-0827 $3.50 $7.00
gemini-1.5-flash $0.35 $0.70
gemini-1.5-flash-exp-0827 $0.35 $0.70

ローカルLLM実行環境Ollamaの環境構築方法

自分のパソコンにAIモデルをインストールし、それを利用することも可能です。
CodeWhislerは様々なLLMをローカルで実行できるOllamaというアプリケーションのAPIに対応しています。

ただし、CPUとメモリを大量に消費するため、十分な速度のCPUと、16GBメモリ以上搭載のパソコンが必要になってくると思われます。

また、GPUにも対応していますので、興味があればセットアップにチャレンジしてみてください。

Ollamaのインストール

Ollamaのサイトへ行き、Downloadから自分の環境にあったものをダウンロードしてインストールしてください。

Dockerの場合

Dockerも対応しています。

# 起動
$ docker run -d -v ollama:/root/.ollama -p 11434:11434 --name ollama ollama/ollama

# AIモデルのダウンロード、モデル名はphi3 / llamma2 / llama3 / gemma2:2b
$ docker exec -it ollama /bin/bash -c "ollama pull [モデル名]"

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •