会話型Q&Aエージェントの構成システム、自ホスト型デプロイメントソリューション、および便利なオールインワンアプリケーションSDKを提供し、GitHubリポジトリのためのインテリジェントQ&Aボットをワンクリックで作成し、さまざまな公式ウェブサイトやプロジェクトに迅速に統合し、コミュニティのためのより効率的な技術サポートエコシステムを提供します。
リポジトリのアドレスまたは名前を提供するだけで、Peter Catがボットの作成プロセス全体を自動的に完了します。
ボットが作成されると、関連するすべてのGitHubドキュメントと問題が自動的にナレッジベースに追加され、ボットの知識源となります。
公式ウェブサイトへのSDK統合やGitHubリポジトリへのワンクリックインストールなど、さまざまな統合オプションを提供します。
 |
 |
|---|
デプロイメントソリューション: AWS + Supabase
完全なガイドはこちらで見つけることができます:
プロジェクトには環境変数の設定が必要です:
.env.local
| 環境変数 | タイプ | 説明 | 例 |
|---|---|---|---|
NEXT_PUBLIC_API_DOMAIN |
必須 | バックエンドサービスのAPIドメイン | https://api.petercat.ai |
.env
| 環境変数 | タイプ | 説明 | 例 |
|---|---|---|---|
| 基本アプリケーション環境変数 | |||
API_URL |
必須 | バックエンドサービスのAPIドメイン | https://api.petercat.ai |
WEB_URL |
必須 | フロントエンドウェブサービスのドメイン | https://petercat.ai |
STATIC_URL |
必須 | 静的リソースドメイン | https://static.petercat.ai |
| AWS関連環境変数 | |||
X_GITHUB_SECRET_NAME |
必須 | AWSシークレットファイル名 | prod/githubapp/petercat/pem |
STATIC_SECRET_NAME |
オプション | AWSが管理するCloudFrontのプライベートキーの名前。設定されている場合、CloudFrontの署名付きURLが使用され、リソースが保護されます。詳細については、AWSドキュメントを参照してください。 | prod/petercat/static |
LLM_TOKEN_SECRET_NAME |
オプション | AWSが管理するLLM署名プライベートキーの名前。設定されている場合、PetercatはRSAアルゴリズムを使用してユーザーのLLMトークンを管理します。 | prod/petercat/llm |
LLM_TOKEN_PUBLIC_NAME |
オプション | AWSが管理するLLM署名公開キーの名前。設定されている場合、PetercatはRSAアルゴリズムを使用してユーザーのLLMトークンを管理します。 | prod/petercat/llm/pub |
STATIC_KEYPAIR_ID |
オプション | AWS CloudFrontのキーID。設定されている場合、CloudFrontの署名付きURLが使用され、リソースが保護されます。詳細については、AWSドキュメントを参照してください。 | APKxxxxxxxx |
S3_TEMP_BUCKET_NAME |
必須 | 一時的な画像ファイル用のAWS S3バケット | xxx-temp |
SQS_QUEUE_URL |
必須 | AWS SQSキューURL | https://sqs.ap-northeast-1.amazonaws.com/xxx/petercat-task-queue |
| Supabase関連環境変数 | |||
SUPABASE_URL |
必須 | SupabaseサービスURL、こちらで見つけることができます | https://***.supabase.co |
SUPABASE_SERVICE_KEY |
必須 | Supabaseサービスキー、こちらで見つけることができます | {{SUPABASE_SERVICE_KEY}} |
| Auth0関連環境変数 | |||
AUTH0_DOMAIN |
必須 | Auth0ドメイン、Auth0 / Application / Basic Informationから取得 | petercat.us.auth0.com |
AUTH0_CLIENT_ID |
必須 | Auth0クライアントID、Auth0 / Application / Basic Informationから取得 | artfiUxxxx |
AUTH0_CLIENT_SECRET |
必須 | Auth0クライアントシークレット、Auth0 / Application / Basic Informationから取得 | xxxx-xxxx-xxx |
API_IDENTIFIER |
必須 | Auth0 API識別子 | https://petercat.us.auth0.com/api/v2/ |
| LLM関連環境変数 | |||
OPENAI_API_KEY |
必須 | OpenAI APIキー | sk-xxxx |
OPENAI_BASE_URL |
オプション | APIリクエストのためのベースURL。プロキシやサービスエミュレーターを使用する場合のみ指定します。 | https://api.openai.com/v1 |
GEMINI_API_KEY |
オプション | Gemini APIキー | xxxx |
TAVILY_API_KEY |
オプション | Tavily APIキー | tvly-xxxxx |
| GitHub App登録環境変数 | |||
X_GITHUB_APP_ID |
オプション | GitHub App ID | 123456 |
X_GITHUB_APPS_CLIENT_ID |
オプション | GitHub AppクライアントID | Iv1.xxxxxxx |
X_GITHUB_APPS_CLIENT_SECRET |
オプション | GitHub Appクライアントシークレット | xxxxxxxx |
| レート制限構成 | |||
RATE_LIMIT_ENABLED |
オプション | レート制限が有効かどうか | True |
RATE_LIMIT_REQUESTS |
オプション | レート制限のリクエスト数 | 100 |
RATE_LIMIT_DURATION |
オプション | レート制限の期間（分単位） | 1 |
Peter Catはyarnをパッケージマネージャーとして使用しています。
git clone https://github.com/petercat-ai/petercat.git
# 依存関係をインストール
yarn run bootstrap
# クライアントをデバッグ
yarn run client
# アシスタントをデバッグ
yarn run assistant
# サーバーをデバッグ
yarn run server
# ローカルでウェブサイトを開始
yarn run client:server
# ローカルでアシスタントコンポーネントを開始
yarn run assistant:server
# アシスタントをビルド
cd assistant
yarn run build
npm publish
# Dockerビルド
yarn run build:docker
# PyPIビルド
yarn run build:pypi
yarn run publish:pypiプロジェクトのアドレス、使用シナリオ、使用頻度などの情報を[email protected] に送信してください。
Peter Catはまだ成長段階にあり、時折「癇癪」を起こすことがあります。以下のチャンネルを通じて問題を報告してください：
- [Submit an Issue(https://github.com/petercat-ai/petercat/issues/new/choose)
- Discussions
👬 貢献者
MIT@PeterCat