日本語
ドキュメント
はじめに

はじめに

OpenCodeを始めましょう。

OpenCodeは、オープンソースのAIコーディングエージェントです。ターミナルベースのインターフェース、デスクトップアプリ、またはIDE拡張機能として利用できます。

OpenCode TUI with the opencode theme

さっそく始めましょう。


前提条件

ターミナルでOpenCodeを使用するには、以下が必要です:


インストール

OpenCodeをインストールする最も簡単な方法は、インストールスクリプトを使用することです。

curl -fsSL https://opencode.ai/install | bash

以下のコマンドでもインストールできます:

  • Node.jsを使用する場合
npm install -g opencode-ai
  • macOSおよびLinuxでHomebrewを使用する場合
brew install anomalyco/tap/opencode

最新のリリースを入手するには、OpenCodeタップの使用をお勧めします。公式のbrew install opencodeフォーミュラはHomebrewチームによってメンテナンスされており、更新頻度が低くなっています。

  • Arch LinuxでParuを使用する場合
paru -S opencode-bin

Windows

推奨:WSLを使用

Windowsで最高の体験を得るには、Windows Subsystem for Linux (WSL)の使用をお勧めします。より良いパフォーマンスとOpenCodeの機能との完全な互換性を提供します。

  • Chocolateyを使用する場合
choco install opencode
  • Scoopを使用する場合
scoop install opencode
  • NPMを使用する場合
npm install -g opencode-ai
  • Miseを使用する場合
mise use -g github:anomalyco/opencode
  • Dockerを使用する場合
docker run -it --rm ghcr.io/anomalyco/opencode

WindowsでBunを使用したOpenCodeのインストールは現在開発中です。

Releases (opens in a new tab)からバイナリを直接ダウンロードすることもできます。


設定

OpenCodeでは、APIキーを設定することで任意のLLMプロバイダーを使用できます。

LLMプロバイダーを初めて使用する場合は、OpenCode Zenの使用をお勧めします。OpenCodeチームによってテストおよび検証されたモデルの厳選リストです。

  1. TUIで/connectコマンドを実行し、opencodeを選択して、opencode.ai/auth (opens in a new tab)にアクセスします。
/connect
  1. サインインし、請求情報を追加して、APIキーをコピーします。

  2. APIキーを貼り付けます。

┌ API key


└ enter

または、他のプロバイダーを選択することもできます。詳細はこちら


初期化

プロバイダーを設定したら、作業したいプロジェクトに移動します。

cd /path/to/project

そしてOpenCodeを実行します。

opencode

次に、以下のコマンドを実行してプロジェクトのOpenCodeを初期化します。

/init

これにより、OpenCodeがプロジェクトを分析し、プロジェクトルートにAGENTS.mdファイルを作成します。

ヒント

プロジェクトのAGENTS.mdファイルはGitにコミットすることをお勧めします。

これにより、OpenCodeがプロジェクト構造と使用されているコーディングパターンを理解できるようになります。


使い方

これでOpenCodeを使用してプロジェクトに取り組む準備ができました。何でも自由に質問してください!

AIコーディングエージェントを初めて使用する場合は、以下の例が参考になるかもしれません。


質問する

OpenCodeにコードベースについて説明してもらうことができます。

ヒント

@キーを使用してプロジェクト内のファイルをファジー検索できます。

How is authentication handled in @packages/functions/src/api/index.ts

これは、自分が作業していないコードベースの部分がある場合に役立ちます。


機能を追加する

OpenCodeにプロジェクトに新しい機能を追加してもらうことができます。ただし、まずプランを作成してもらうことをお勧めします。

  1. プランを作成する

    OpenCodeにはプランモードがあり、変更を加える機能を無効にして、代わりに機能の実装方法を提案します。

    Tabキーを使用して切り替えます。右下隅にインジケーターが表示されます。

    <TAB>

    では、何をしてほしいか説明しましょう。

    When a user deletes a note, we'd like to flag it as deleted in the database.
    Then create a screen that shows all the recently deleted notes.
    From this screen, the user can undelete a note or permanently delete it.

    OpenCodeが理解できるように十分な詳細を提供する必要があります。チームのジュニア開発者に話しかけるように話すと効果的です。

    ヒント

    OpenCodeが理解しやすいように、十分なコンテキストと例を提供してください。

  2. プランを改善する

    プランが提示されたら、フィードバックを与えたり、詳細を追加したりできます。

    We'd like to design this new screen using a design I've used before.
    [Image #1] Take a look at this image and use it as a reference.

    ヒント

    画像をターミナルにドラッグ&ドロップしてプロンプトに追加できます。

    OpenCodeは提供された画像をスキャンしてプロンプトに追加できます。ターミナルに画像をドラッグ&ドロップすることで行えます。

  3. 機能をビルドする

    プランに満足したら、Tabキーを再度押してビルドモードに戻ります。

    <TAB>

    そして変更を加えるよう依頼します。

    Sounds good! Go ahead and make the changes.

変更を加える

より単純な変更の場合は、プランを確認せずにOpenCodeに直接ビルドしてもらうことができます。

We need to add authentication to the /settings route. Take a look at how this is
handled in the /notes route in @packages/functions/src/notes.ts and implement
the same logic in @packages/functions/src/settings.ts

OpenCodeが正しい変更を行えるように、十分な詳細を提供するようにしてください。


変更を元に戻す

OpenCodeに変更を加えてもらったとします。

Can you refactor the function in @packages/functions/src/api/index.ts?

しかし、それが望んでいたものではないことに気づきました。/undoコマンドを使用して変更を元に戻すことができます。

/undo

OpenCodeは変更を元に戻し、元のメッセージを再度表示します。

Can you refactor the function in @packages/functions/src/api/index.ts?

ここからプロンプトを調整して、OpenCodeに再試行してもらうことができます。

ヒント

/undoを複数回実行して、複数の変更を元に戻すことができます。

または、/redoコマンドを使用して変更をやり直すこともできます。

/redo

共有

OpenCodeとの会話はチームと共有できます。

/share

これにより、現在の会話へのリンクが作成され、クリップボードにコピーされます。

⚠️

注意

会話はデフォルトでは共有されません。

こちらはOpenCodeとの会話の例 (opens in a new tab)です。


カスタマイズ

以上です!これでOpenCodeのプロになりました。

自分好みにするために、テーマの選択キーバインドのカスタマイズコードフォーマッターの設定カスタムコマンドの作成、またはOpenCode設定を試してみることをお勧めします。