jotbot
v0.1.5
JotBot 、GOおよびTypeScriptプロジェクトのコードドキュメントをシームレスに自動生成し、包括的なコードと洞察力に富んだドキュメントのギャップを埋めます。
このリポジトリのドキュメントは、 gpt-4を使用してJotbotによって完全に生成されましたが、現在（2023/07/18） gpt-3.5-turboを使用して最良の結果を得ます。
Openaiのgpt-3.5およびgpt-4モデルは、時間の経過とともに品質の変動を示しています。任意のインスタンスでどのモデルが優れているかを決定することは困難ですが、 gpt-4しばしばより一貫した結果をもたらします。
一般的なアプリケーションの場合、 gpt-3.5-turbo-16kデフォルトとして使用することをお勧めします。GPT gpt-3.5が不足するシナリオでは、 gpt-4に時間を切り替えることをお勧めします。
gpt-4-1106-previewこれまでのところドキュメントを生成するのに最適なモデルです。 Jotbotのデフォルトモデルはgpt-3.5-turboで、お金に最適な価値を与えます。
Packages/Jotbotで生成されたタイプスクリプトドキュメントを見つけることができます。
go install github.com/modernice/jotbot/cmd/jotbot@latest
npm i -g jotbot-ts@latest
pnpm i -g jotbot-ts@latest
あなたのgoおよび/またはtypescriptコードベースの中で、実行してください：
jotbot generate --key OPENAI_API_KEY
Jotbotは、OpenAIのGPTモデルを使用してドキュメントを生成します。デフォルトでは、Jotbotはgpt-3.5-turboモデルを使用して、費用対効果の高いレートで良い結果を提供します。ただし、最良の結果はgpt-4とtext-davinci-003によって生成されます。Text-Davinci-003は、 gpt-3.5-turboよりも10〜30倍高価です。
Openaiドキュメントからモデルを選択し、 --model|-mフラグを介して渡すことができます。
jotbot generate -m text-davinci-003
go install経由インストールを行った場合は、 go installを使用してJotBotをインストールするだけです。
go install github.com/modernice/jotbot/cmd/jotbot@latest
リリースページから最新のバイナリをダウンロードできます。
TypeScript（およびJavaScript）サポートを有効にするには、 jotbot-ts NPMパッケージもインストールする必要があります。
npm install -g jotbot-ts
pnpm install -g jotbot-ts
コードベースの不足しているドキュメントを生成するには、次のコマンドを実行します。
jotbot generate [options]
デフォルトでは、このコマンドは、現在およびネストされたディレクトリにすべてのGOおよびTypeScript（およびJavaScript）ファイルを見つけ、それらのドキュメントを生成します。検索から除外されているのはデフォルトです。
**/.*/****/dist/****/node_modules/****/vendor/****/testdata/****/test/****/tests/****/*.pb.go jotbot --help
| オプション | 説明 | デフォルト |
|---|---|---|
--root | リポジトリのルートディレクトリ | "." |
--include, -i | ファイルを含めるためのグローブパターン | |
--include-tests, -T | testxxx（）関数を含める（go固有） | |
--exclude, -e | ファイルを除外するグローブパターン | |
--exclude-internal, -E | 「内部」ディレクトリを除外する（GO固有） | true |
--match | 識別子に一致する正規表現 | |
--symbol, -s | コードで検索するシンボル（TS/JS固有） | |
--clear, -c | ジェネレーションプロンプトのフォースクリアコメント（GO固有） | |
--branch | 変更するためのブランチ名（コミットしないために空のままにしてください） | |
--limit | ドキュメントを生成するファイルの数を制限します | 0 |
--dry | それらを適用せずに変更を印刷します | false |
--model, -m | ドキュメントを生成するために使用されるOpenAIモデル | "gpt-3.5-turbo" |
--maxTokens | 単一のドキュメント用に生成するトークンの最大数 | 512 |
--parallel, -p | 同時に処理するファイルの数 | 4 |
--workers | ファイルごとに使用する労働者の数 | 2 |
--override, -o | 既存のドキュメントをオーバーライドする（GO固有） | |
--key | Openai APIキー | |
--verbose, -v | 冗長ロギングを有効にします | false |
mit
