get-api-docs

chub で API ドキュメントを取得する

ライブラリや API のドキュメントが必要なときは、トレーニングデータから推測するのではなく、chub CLI で取得してください。これにより、最新かつ正確な API を確認できます。

Step 1 - chub が存在することを確認し、使用方法に関する最新の手順を取得する

次を実行します。

chub --help

chub が存在しないことを示すエラーが表示された場合は、まずインストールしてから、もう一度実行してください。環境に node、npm、ネットワークアクセス、パッケージマネージャーの使用権限がある場合は、次のようにインストールします。

npm install -g @aisuite/chub

Step 2 — 適切なドキュメントを探す

競合がある場合は、最新のガイダンスが記載されている chub --help の出力に従ってください。ただし、適切なドキュメントを検索するための主要なコマンドは chub search です。

chub search "<keywords>" --json

検索結果から最もよく一致する id（例：openai/chat、anthropic/sdk、stripe/api）を選びます。一致するものがない場合は、より広い用語で検索してみてください。

Step 3 — ドキュメントを取得する

ここでも、競合がある場合はこの説明ではなく、chub --help の最新の手順に従ってください。ただし、関連するドキュメントを取得するための主要なコマンドは次のとおりです。

chub get <id> --lang py    # or --lang js, --lang ts

--lang パラメーターを必ず含めてください。

Step 4 — ドキュメントを活用し、フィードバックを残す

取得した内容を読み、正確なコードを書くか、質問に回答するために活用してください。 記憶している API の形状に頼らず、ドキュメントの内容を使ってください。

最後に、タスクを完了した後、ドキュメントに記載されていない注意点、回避策、バージョン固有の挙動、プロジェクト固有の詳細を見つけた場合は、今後のセッションに役立つよう保存してください。

chub annotate <id> "Webhook verification requires raw body — do not parse before verifying"

注釈はローカルに保存され、セッションをまたいで保持され、今後の chub get 呼び出し時に自動的に表示されます。簡潔で実用的な内容にしてください。ドキュメントにすでに記載されていることは繰り返さないでください。

さらに、すべての開発者に役立ててもらうため、chub --help の手順に従って chub feedback でドキュメントにフィードバックを送ってください。フィードバックのコメントには、シークレット、ソースコード、非公開のアーキテクチャの詳細、その他の機密情報を含めないでください。